Entity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

interface Entity : ScenePose

Known direct subclasses

BaseEntity

BaseEntity

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

Known indirect subclasses

ActivityPanelEntity, ActivitySpace, AnchorEntity, GltfModelEntity, GroupEntity, MainPanelEntity, PanelEntity, SurfaceEntity

`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 a spatialized Activity.
`AnchorEntity`	An AnchorEntity tracks a `androidx.xr.runtime.math.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.
`GltfModelEntity`	GltfModelEntity is a concrete implementation of Entity that hosts a glTF model.
`GroupEntity`	An `Entity` that contains no content, but can have an arbitrary number of children.
`MainPanelEntity`	Represents the main spatialized panel in a `Scene`.
`PanelEntity`	PanelEntity contains an arbitrary 2D Android `View`, within a spatialized XR scene.
`SurfaceEntity`	SurfaceEntity is an `Entity` that hosts a `Surface`, which will be texture mapped onto the `Shape`.

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 a child of this Entity in the scene graph.
`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.
`open @FloatRange(from = 0.0, to = 1.0) Float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`@FloatRange(from = 0.0, to = 1.0) Float`	`getAlpha(relativeTo: Space)` Returns the alpha transparency set for this Entity, relative to given Space.
`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.
`open Pose`	`getPose()` Returns the `Pose` for this Entity, relative to its parent.
`Pose`	`getPose(relativeTo: Space)` Returns the `Pose` for this Entity, relative to the provided `Space`.
`open @FloatRange(from = 0.0) Float`	`getScale()` Returns the local scale of this Entity, not inclusive of the parent's scale.
`@FloatRange(from = 0.0) Float`	`getScale(relativeTo: Space)` Returns the scale of this entity, relative to given space.
`Boolean`	`isEnabled(includeParents: Boolean)` Returns the enabled status of this Entity.
`Unit`	`removeAllComponents()` Remove all components from this Entity.
`Unit`	`removeComponent(component: Component)` Removes the given Component from this Entity.
`open Unit`	`setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float)` Sets the alpha transparency of the Entity and its children.
`Unit`	`setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float, relativeTo: Space)` Sets the alpha transparency of the Entity relative to given Space.
`Unit`	`setEnabled(enabled: Boolean)` Sets the local enabled state of this Entity.
`open Unit`	`setPose(pose: Pose)` Sets the `Pose` for this Entity, relative to its parent.
`Unit`	`setPose(pose: Pose, relativeTo: Space)` Sets the `Pose` for this Entity.
`open Unit`	`setScale(scale: @FloatRange(from = 0.0) Float)` Sets the scale of this Entity relative to its parent.
`Unit`	`setScale(scale: @FloatRange(from = 0.0) Float, relativeTo: Space)` Sets the scale of this Entity relative to the given Space.

Public properties
`List<Entity>`	`children` Provides the list of all children of this entity.
`CharSequence`	`contentDescription` Alternate text for this Entity to be consumed by Accessibility systems.
`Entity?`	`parent` The parent of this Entity, from which this Entity will inherit most of its properties.

Inherited functions

From androidx.xr.scenecore.ScenePose

`suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3)` Perform a hit test from the specified origin in the specified direction into the Scene.
`suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3, hitTestFilter: Int)` Creates a hit test from the specified origin in the specified direction into the scene.
`Pose`	`transformPoseTo(pose: Pose, destination: ScenePose)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.

Inherited properties

From androidx.xr.scenecore.ScenePose

Pose

activitySpacePose

The current Pose relative to the activity space root.

Public functions

addChild

Added in 1.0.0-alpha09

fun addChild(child: Entity): Unit

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.

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

addComponent

Added in 1.0.0-alpha09

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 was successfully added to the Entity.

dispose

Added in 1.0.0-alpha09

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.

getAlpha

Added in 1.0.0-alpha09

open fun getAlpha(): @FloatRange(from = 0.0, to = 1.0) 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.

getAlpha

Added in 1.0.0-alpha09

fun getAlpha(relativeTo: Space = Space.PARENT): @FloatRange(from = 0.0, to = 1.0) Float

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

Parameters
`relativeTo: Space = Space.PARENT`	Gets alpha relative to given Space. Default value is the parent space.

getComponents

Added in 1.0.0-alpha09

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-alpha09

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.

getPose

Added in 1.0.0-alpha09

open fun getPose(): Pose

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

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

getPose

Added in 1.0.0-alpha09

fun getPose(relativeTo: Space = Space.PARENT): Pose

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

Parameters
`relativeTo: Space = Space.PARENT`	Get the Pose relative to given Space. Default value is the parent space.

Returns
`Pose`	Current `Pose` of the Entity relative to the given space.

getScale

Added in 1.0.0-alpha09

open fun getScale(): @FloatRange(from = 0.0) Float

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

Returns
`@FloatRange(from = 0.0) Float`	Current uniform scale applied to self and children.

getScale

Added in 1.0.0-alpha09

fun getScale(relativeTo: Space = Space.PARENT): @FloatRange(from = 0.0) Float

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

Parameters
`relativeTo: Space = Space.PARENT`	Get the scale relative to given Space. Default value is the parent space.

Returns
`@FloatRange(from = 0.0) Float`	Current uniform scale applied to self and children.

isEnabled

Added in 1.0.0-alpha09

fun isEnabled(includeParents: Boolean = true): Boolean

Returns the enabled status of this Entity.

Parameters
`includeParents: Boolean = true`	Whether to include the enabled 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 enabled. If includeParents is `false`, the local enabled state is returned. Regardless of the local enabled state, an Entity will be considered disabled if any of its ancestors are disabled.

removeAllComponents

Added in 1.0.0-alpha09

fun removeAllComponents(): Unit

Remove all components from this Entity.

removeComponent

Added in 1.0.0-alpha09

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-alpha09

open fun setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) 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.

setAlpha

Added in 1.0.0-alpha09

fun setAlpha(
    alpha: @FloatRange(from = 0.0, to = 1.0) Float,
    relativeTo: Space = Space.PARENT
): Unit

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.

Parameters
`alpha: @FloatRange(from = 0.0, to = 1.0) Float`	Alpha transparency level for the Entity.
`relativeTo: Space = Space.PARENT`	Sets alpha relative to given Space. Default value is the parent Space.

setEnabled

Added in 1.0.0-alpha09

fun setEnabled(enabled: Boolean): Unit

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.

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

setPose

Added in 1.0.0-alpha09

open fun setPose(pose: Pose): Unit

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

setPose

Added in 1.0.0-alpha09

fun setPose(pose: Pose, relativeTo: Space = Space.PARENT): Unit

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

Parameters
`pose: Pose`	The `Pose` offset from the parent.
`relativeTo: Space = Space.PARENT`	Set the pose relative to given Space. Default value is the parent space.

setScale

Added in 1.0.0-alpha09

open fun setScale(scale: @FloatRange(from = 0.0) 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: @FloatRange(from = 0.0) Float`	The uniform scale factor from the parent.

setScale

Added in 1.0.0-alpha09

fun setScale(scale: @FloatRange(from = 0.0) Float, relativeTo: Space = Space.PARENT): Unit

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.

Parameters
`scale: @FloatRange(from = 0.0) Float`	The uniform scale factor.
`relativeTo: Space = Space.PARENT`	Set the scale relative to given Space. Default value is the parent Space.

Public properties

children

Added in 1.0.0-alpha09

val children: List<Entity>

Provides the list of all children of this entity.

contentDescription

Added in 1.0.0-alpha09

var contentDescription: CharSequence

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

parent

Added in 1.0.0-alpha09

var parent: Entity?

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.