Entity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

interface Entity : ActivityPose

Known direct subclasses

BaseEntity

BaseEntity

The BaseEntity is an implementation of Entity interface that wraps a platform entity.

Known indirect subclasses

ActivityPanelEntity, ActivitySpace, AnchorEntity, BasePanelEntity, ContentlessEntity, GltfModelEntity, PanelEntity, StereoSurfaceEntity

`ActivityPanelEntity`	ActivityPanelEntity creates a spatial panel for embedding an Activity in Android XR.
`ActivitySpace`	ActivitySpace is an Entity used to track the system-managed pose and boundary of the volume associated with this Spatialized Activity.
`AnchorEntity`	An AnchorEntity is created to track a Pose relative to some position or surface in the "Real World." Children of this Entity will remain positioned relative to that location in the real world, for the purposes of creating Augmented Reality experiences.
`BasePanelEntity`	Provides implementations for common Panel functionality.
`ContentlessEntity`	An Entity that itself has no content.
`GltfModelEntity`	GltfModelEntity is a concrete implementation of Entity that hosts a glTF model.
`PanelEntity`	PanelEntity creates a spatial panel in Android XR.
`StereoSurfaceEntity`	StereoSurfaceEntity is a concrete implementation of Entity that hosts a StereoSurface Panel.

Interface for a spatial Entity. An Entity's Poses are represented as being relative to their parent. Applications create and manage Entity instances to construct spatial scenes.

Summary

Public functions
`Unit`	`addChild(child: Entity)` Sets an Entity to be represented in this coordinate space.
`Boolean`	`addComponent(component: Component)` Adds a Component to this Entity.
`Unit`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`Float`	`getActivitySpaceAlpha()` Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha.
`Float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`List<Component>`	`getComponents()` Retrieves all components attached to this Entity.
`List<T>`	`<T : Component> getComponentsOfType(type: Class<T>)` Retrieves all Components of the given type `T` and its sub-types attached to this Entity.
`Entity?`	`getParent()` Returns the parent of this Entity.
`Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`Float`	`getScale()` Returns the local scale of this entity, not inclusive of the parent's scale.
`Dimensions`	`getSize()` Returns the dimensions (in meters) for this Entity.
`Float`	`getWorldSpaceScale()` Returns the accumulated scale of this Entity.
`Boolean`	`isHidden(includeParents: Boolean)` Returns the hidden status of this Entity.
`Unit`	`removeAllComponents()` Remove all components from this Entity.
`Unit`	`removeComponent(component: Component)` Removes the given Component from this Entity.
`Unit`	`setAlpha(alpha: Float)` Sets the alpha transparency of the Entity and its children.
`Unit`	`setContentDescription(text: String)` Sets alternate text for this entity to be consumed by Accessibility systems.
`Unit`	`setHidden(hidden: Boolean)` Sets the local hidden state of this Entity.
`Unit`	`setParent(parent: Entity?)` Sets this Entity to be represented in the parent's coordinate space.
`Unit`	`setPose(pose: Pose)` Sets the pose for this Entity, relative to its parent.
`Unit`	`setScale(scale: Float)` Sets the scale of this entity relative to its parent.
`Unit`	`setSize(dimensions: Dimensions)` Sets the dimensions in pixels for the Entity.

Inherited functions

From androidx.xr.scenecore.ActivityPose

`Pose`	`getActivitySpacePose()` Returns the activity space pose for this ActivityPose.
`Pose`	`transformPoseTo(pose: Pose, destination: ActivityPose)` Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.

Public functions

addChild

Added in 1.0.0-alpha01

fun addChild(child: Entity): Unit

Sets an Entity to be represented in this coordinate space. From a User's perspective, as this Entity moves, the child Entity will move with it.

Parameters
`child: Entity`	The `Entity` to be attached.

addComponent

Added in 1.0.0-alpha01

fun addComponent(component: Component): Boolean

Adds a Component to this Entity.

Parameters
`component: Component`	the Component to be added to the Entity.

Returns
`Boolean`	True if given Component is added to the Entity.

dispose

Added in 1.0.0-alpha01

fun dispose(): Unit

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.

getActivitySpaceAlpha

Added in 1.0.0-alpha01

fun getActivitySpaceAlpha(): Float

Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha.

This does not necessarily equal the perceived alpha of the entity as the entity may have some alpha difference applied from the system.

Returns
`Float`	Total `Float` alpha applied to this entity.

getAlpha

Added in 1.0.0-alpha01

fun getAlpha(): Float

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.

getComponents

Added in 1.0.0-alpha01

fun getComponents(): List<Component>

Retrieves all components attached to this Entity.

Returns
`List<Component>`	List attached to this Entity.

getComponentsOfType

Added in 1.0.0-alpha01

fun <T : Component> getComponentsOfType(type: Class<T>): List<T>

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

Parameters
`type: Class<T>`	The type of Component to retrieve.

Returns
`List<T>`	List of the given type attached to this Entity.

getParent

Added in 1.0.0-alpha01

fun getParent(): Entity?

Returns the parent of this Entity.

Returns
`Entity?`	The `Entity` that this Entity is attached to. Returns null if this Entity has no parent and is the root of its hierarchy.

getPose

Added in 1.0.0-alpha01

fun getPose(): Pose

Returns the pose for this entity, relative to its parent.

Returns
`Pose`	Current `Pose` offset from the parent.

getScale

Added in 1.0.0-alpha01

fun getScale(): Float

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

Returns
`Float`	Current uniform scale applied to self and children.

getSize

Added in 1.0.0-alpha01

fun getSize(): Dimensions

Returns the dimensions (in meters) for this Entity.

getWorldSpaceScale

Added in 1.0.0-alpha01

fun getWorldSpaceScale(): Float

Returns the accumulated scale of this Entity. This value includes the parent's world space scale.

Returns
`Float`	Total uniform scale applied to self and children.

isHidden

Added in 1.0.0-alpha01

fun isHidden(includeParents: Boolean = true): Boolean

Returns the hidden status of this Entity.

Parameters
`includeParents: Boolean = true`	Whether to include the hidden status of parents in the returned value.

Returns
`Boolean`	If includeParents is true, the returned value will be true if this Entity or any of its ancestors is hidden. If includeParents is false, the local hidden state is returned. Regardless of the local hidden state, an entity will not be rendered if any of its ancestors are hidden.

removeAllComponents

Added in 1.0.0-alpha01

fun removeAllComponents(): Unit

Remove all components from this Entity.

removeComponent

Added in 1.0.0-alpha01

fun removeComponent(component: Component): Unit

Removes the given Component from this Entity.

Parameters
`component: Component`	Component to be removed from this entity.

setAlpha

Added in 1.0.0-alpha01

fun setAlpha(alpha: Float): Unit

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.

setContentDescription

Added in 1.0.0-alpha01

fun setContentDescription(text: String): Unit

Sets alternate text for this entity to be consumed by Accessibility systems.

Parameters
`text: String`	A11y content.

setHidden

Added in 1.0.0-alpha01

fun setHidden(hidden: Boolean): Unit

Sets the local hidden state of this Entity. When true, this Entity and all descendants will not be rendered in the scene. When the hidden state is false, an entity will be rendered if its ancestors are not hidden.

Parameters
`hidden: Boolean`	The new local hidden state of this Entity.

setParent

Added in 1.0.0-alpha01

fun setParent(parent: Entity?): Unit

Sets this Entity to be represented in the parent's coordinate space. From a User's perspective, as the parent moves, this Entity will move with it. Setting the parent to null will cause the Entity to not be rendered.

Parameters
`parent: Entity?`	The `Entity` to attach to.

setPose

Added in 1.0.0-alpha01

fun setPose(pose: Pose): Unit

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

Parameters
`pose: Pose`	The `Pose` offset from the parent.

setScale

Added in 1.0.0-alpha01

fun setScale(scale: Float): Unit

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.

Parameters
`scale: Float`	The uniform scale factor from the parent.

setSize

Added in 1.0.0-alpha01

fun setSize(dimensions: Dimensions): Unit

Sets the dimensions in pixels for the Entity.

("This method is deprecated. Use BasePanelEntity<*>.setPixelDimensions() instead.")

Parameters
`dimensions: Dimensions`	Dimensions in pixels. (Z will be ignored)