Entity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public class Entity extends BaseScenePose

java.lang.Object
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.Entity

Known direct subclasses

ActivitySpace, AnchorEntity, GltfModelEntity, MeshEntity, PanelEntity, SurfaceEntity

`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 `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.
`MeshEntity`	A renderable entity in the scene graph that renders a `CustomMesh`.
`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`.

Known indirect subclasses

ActivityPanelEntity, MainPanelEntity

`ActivityPanelEntity`	ActivityPanelEntity creates a spatial panel for embedding an `Activity` in Android XR.
`MainPanelEntity`	Represents the main spatialized panel in a `Scene`.

An Entity is the fundamental building block of a SceneCore Scene. Entities have a parent-child relationship with each other and are used to build a spatial scene graph.

There are several different Entity types with Entity being the base class. The position of most Entity types can be updated within the scene graph by updating their Pose. Additionally, the Entity's scale, and alpha can be updated. Components can be attached to Entities to enable additional behaviors.

There are several subtypes of Entities. These include Entities with special positions, (e.g. ActivitySpace and AnchorEntity) as well as those which are used to render different types of content (e.g. PanelEntity and GltfModelEntity).

Summary

Public methods
`final void`	`addChild(@NonNull Entity child)` Sets an Entity to be a child of this Entity in the scene graph.
`final boolean`	`addComponent(@NonNull Component component)` Adds a Component to this Entity.
`static final @NonNull Entity`	`create( @NonNull Session session, String name, @NonNull Pose pose, Entity parent )` Public factory method for creating an `Entity`.
`final @FloatRange(from = 0.0, to = 1.0) float`	`getAlpha(@NonNull Space relativeTo)` Returns the alpha transparency set for this Entity, relative to given Space.
`final @NonNull List<@NonNull Entity>`	`getChildren()` Provides the list of all children of this entity.
`final @NonNull List<@NonNull Component>`	`getComponents()` Retrieves all components attached to this Entity.
`final @NonNull List<@NonNull T>`	`<T extends Component> getComponentsOfType(@NonNull Class<@NonNull T> type)` Retrieves all Components of the given type `T` and its subtypes attached to this Entity.
`final @NonNull CharSequence`	`getContentDescription()` Alternate text for this Entity to be consumed by Accessibility systems.
`final Entity`	`getParent()` The parent of this Entity, from which this Entity will inherit most of its properties.
`@NonNull Pose`	`getPose(@NonNull Space relativeTo)` Returns the `Pose` for this Entity, relative to the provided `Space`.
`@FloatRange(from = 0.0) float`	`getScale(@NonNull Space relativeTo)` Returns the scale of this entity, relative to given space.
`final boolean`	`isEnabled(boolean includeParents)` Returns the enabled status of this Entity.
`final void`	`removeAllComponents()` Remove all components from this Entity.
`final void`	`removeComponent(@NonNull Component component)` Removes the given Component from this Entity.
`final void`	`setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)` Sets the alpha transparency of the Entity relative to the parent Space.
`final void`	`setContentDescription(@NonNull CharSequence value)` Alternate text for this Entity to be consumed by Accessibility systems.
`final void`	`setEnabled(boolean enabled)` Sets the local enabled state of this Entity.
`final void`	`setParent(Entity value)` The parent of this Entity, from which this Entity will inherit most of its properties.
`void`	`setPose(@NonNull Pose pose, @NonNull Space relativeTo)` Sets the `Pose` for this Entity.
`void`	`setScale(@FloatRange(from = 0.0) float scale, @NonNull Space relativeTo)` Sets the scale of this Entity relative to the given Space.

Inherited methods

From androidx.xr.scenecore.BaseScenePose

`@NonNull Pose`	`getPoseInActivitySpace()` The current `Pose` relative to the activity space root.
`HitTestResult`	`hitTest(@NonNull Vector3 origin, @NonNull Vector3 direction)` Perform a hit test from the specified origin in the specified direction into the Scene.
`HitTestResult`	`hitTest( @NonNull Vector3 origin, @NonNull Vector3 direction, int hitTestFilter )` Creates a hit test from the specified origin in the specified direction into the scene.
`@NonNull Vector3`	`transformDirectionTo( @NonNull Vector3 direction, @NonNull ScenePose destination )` Transforms a direction from this ScenePose's local space to the destination ScenePose's local space.
`@NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ScenePose destination)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.
`@NonNull Vector3`	`transformPositionTo( @NonNull Vector3 position, @NonNull ScenePose destination )` Transforms a position from this ScenePose's local space to the destination ScenePose's local space.
`@NonNull Vector3`	`transformVectorTo(@NonNull Vector3 vector, @NonNull ScenePose destination)` Transforms a vector from this ScenePose's local space to the destination ScenePose's local space.

Parameters
`@NonNull Session session`	Session to create the Entity in.
`String name`	Name of the entity. This is unset by default.
`@NonNull Pose pose`	Initial pose of the entity. The default value is `Pose.Identity`.
`Entity parent`	Parent entity. Defaults to `null`. If `null`, the entity is created but not attached to the scene graph, meaning it will be invisible. If a parent entity (e.g., `ActivitySpace` or any other `Entity` already present in the scene) is assigned later, the entity will become visible (provided it is enabled). This allows for `Entity` pre-configuration before making it visible.

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

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

Entity

Summary

Public methods

Inherited methods

Public methods

addChild

addComponent

create

getAlpha

getChildren

getComponents

getComponentsOfType

getContentDescription

getParent

getPose

getScale

isEnabled

removeAllComponents

removeComponent

setAlpha

setContentDescription

setEnabled

setParent

setPose

setScale