Entity

abstract void addChild(@NonNull Entity child)

Sets an Entity to be a child of this Entity in the scene graph. The child Entity will inherit properties from the parent, and will be represented in the parent's coordinate space. From a User's perspective, as this Entity moves, the child Entity will move with it.

abstract boolean addComponent(@NonNull Component component)

Adds a Component to this Entity.

abstract void dispose()

Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children. Once disposed, this Entity is invalid and cannot be used again.

default @FloatRange(from = 0.0, to = 1.0) float getAlpha()

Returns the alpha transparency set for this Entity.

This does not necessarily equal the perceived alpha of the Entity, as the Entity may have some alpha difference applied from its parent or the system.

abstract @FloatRange(from = 0.0, to = 1.0) float getAlpha(@NonNull Space relativeTo)

Returns the alpha transparency set for this Entity, relative to given Space.

abstract @NonNull List<@NonNull Entity> getChildren()

Provides the list of all children of this entity.

abstract @NonNull List<@NonNull Component> getComponents()

Retrieves all components attached to this Entity.

abstract @NonNull List<@NonNull T> <T extends Component> getComponentsOfType(@NonNull Class<@NonNull T> type)

Retrieves all Components of the given type T and its sub-types attached to this Entity.

abstract @NonNull CharSequence getContentDescription()

Alternate text for this Entity to be consumed by Accessibility systems.

abstract Entity getParent()

The parent of this Entity, from which this Entity will inherit most of its properties. For example, this Entity's Pose is defined in relation to the parent Entity's coordinate space, so as the parent moves, this Entity will move with it. Setting the parent to null will remove the Entity from the scene graph.

default @NonNull Pose getPose()

Returns the Pose for this Entity, relative to its parent.

abstract @NonNull Pose getPose(@NonNull Space relativeTo)

Returns the Pose for this Entity, relative to the provided Space.

default @FloatRange(from = 0.0) float getScale()

Returns the local scale of this Entity, not inclusive of the parent's scale.

abstract @FloatRange(from = 0.0) float getScale(@NonNull Space relativeTo)

Returns the scale of this entity, relative to given space.

abstract boolean isEnabled(boolean includeParents)

Returns the enabled status of this Entity.

abstract void removeAllComponents()

Remove all components from this Entity.

abstract void removeComponent(@NonNull Component component)

Removes the given Component from this Entity.

default void setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)

Sets the alpha transparency of the Entity and its children. Values are in the range 0, 1 with 0 being fully transparent and 1 being fully opaque.

This value will affect the rendering of this Entity's children. Children of this node will have their alpha levels multiplied by this value and any alpha of this Entity's ancestors.

abstract void setAlpha(
    @FloatRange(from = 0.0, to = 1.0) float alpha,
    @NonNull Space relativeTo
)

Sets the alpha transparency of the Entity relative to given Space. Values are in the range 0, 1 with 0 being fully transparent and 1 being fully opaque.

This value will affect the rendering of this Entity's children. Children of this node will have their alpha levels multiplied by this value and any alpha of this entity's ancestors.

Usage restrictions:

• If the provided alpha is outside the 0, 1 range, it will be clamped automatically to 0, 1.

abstract void setContentDescription(@NonNull CharSequence contentDescription)

Alternate text for this Entity to be consumed by Accessibility systems.

abstract void setEnabled(boolean enabled)

Sets the local enabled state of this Entity.

When false, this Entity and all descendants will not be rendered in the scene, and the Entity will not respond to input events. If an Entity's local enabled state is true, the Entity will still be considered not enabled if at least one of its ancestors is not enabled.

abstract void setParent(Entity parent)

The parent of this Entity, from which this Entity will inherit most of its properties. For example, this Entity's Pose is defined in relation to the parent Entity's coordinate space, so as the parent moves, this Entity will move with it. Setting the parent to null will remove the Entity from the scene graph.

default void setPose(@NonNull Pose pose)

Sets the Pose for this Entity, relative to its parent.

abstract void setPose(@NonNull Pose pose, @NonNull Space relativeTo)

Sets the Pose for this Entity. The Pose given is set relative to the Space provided.

default void setScale(@FloatRange(from = 0.0) float scale)

Sets the scale of this Entity relative to its parent. This value will affect the rendering of this Entity's children. As the scale increases, this will uniformly stretch the content of the Entity.

abstract void setScale(@FloatRange(from = 0.0) float scale, @NonNull Space relativeTo)

Sets the scale of this Entity relative to the given Space. This value will affect the rendering of this Entity's children. As the scale increases, this will uniformly stretch the content of the Entity.