程序包 ohos.agp.render.render3d

接口 Entity

public interface Entity

Represents a general object in a scene.

An entity can consist of multiple components that define the behaviors and characteristics of the entity. In the entity hierarchy, an entity can have multiple child entities.

从以下版本开始:

3

字段概要

字段

限定符和类型	字段	说明
static int	INVALID_ENTITY	Indicates the ID of an invalid entity.

方法概要

限定符和类型	方法	说明
<ComponentType extends Component> ComponentType	addComponent(Class<ComponentType> componentType)	Adds a component of a specified type to an entity.
<ComponentType extends Component> Optional<ComponentType>	getComponent(Class<ComponentType> componentType)	Obtains the component of a specified type from the entity.
int	getId()	Obtains the unique ID of an entity in a scene.
boolean	isValid()	Checks whether an entity is valid.
<ComponentType extends Component> void	setComponent(ComponentType component)	Sets the component data of an entity to the input component data.

字段详细资料

INVALID_ENTITY

static final int INVALID_ENTITY

Indicates the ID of an invalid entity.

另请参阅:

常量字段值

方法详细资料

getId

int getId()

Obtains the unique ID of an entity in a scene.

返回:

Returns the ID of the entity.

isValid

boolean isValid()

Checks whether an entity is valid.

返回:

Returns true if the entity is valid; returns false otherwise.

addComponent

<ComponentType extends Component> ComponentType addComponent(Class<ComponentType> componentType)

Adds a component of a specified type to an entity.

The new component is initialized with the default value.

类型参数:

ComponentType - Indicates the type of the component to add to the entity.

参数:

componentType - Indicates the type of the component to add as a class object.

返回:

Returns the new component added to the entity.

抛出:

IllegalArgumentException - Throws this exception if the component type is not found.

getComponent

<ComponentType extends Component> Optional<ComponentType> getComponent(Class<ComponentType> componentType)

Obtains the component of a specified type from the entity.

类型参数:

ComponentType - Indicates the type of the component to obtain from the entity.

参数:

componentType - Indicates the type of the component to obtain as a class object.

返回:

Returns the component of the specified type. Returns null if the entity does not have the component of the specified type.

抛出:

IllegalArgumentException - Throws this exception if the component type is not found.

setComponent

<ComponentType extends Component> void setComponent(ComponentType component)

Sets the component data of an entity to the input component data.

类型参数:

ComponentType - Indicates the component type.

参数:

component - Indicates the component data to set.

抛出:

IllegalArgumentException - Throws this exception if the component of the specified type is not found.