# Entity

Artifact: [androidx.xr.scenecore:scenecore](https://developer.android.com/jetpack/androidx/releases/xr-scenecore) [View Source](https://cs.android.com/search?q=file:androidx/xr/scenecore/Entity.kt+class:androidx.xr.scenecore.Entity) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

*** ** * ** ***


```
open class Entity : BaseScenePose<androidx.xr.scenecore.runtime.ScenePose>
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.xr.scenecore.BaseScenePose](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose)\<androidx.xr.scenecore.runtime.ScenePose\> ||
|   | ↳ | [androidx.xr.scenecore.Entity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity) |

Known direct subclasses [GltfModelEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/GltfModelEntity), [MeshEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/MeshEntity), [PanelEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelEntity), [SpaceEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceEntity), [SurfaceEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/GltfModelEntity` | GltfModelEntity is a concrete implementation of Entity that hosts a glTF model. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/MeshEntity` | A renderable entity in the scene graph that renders a `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/CustomMesh`. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelEntity` | PanelEntity contains an arbitrary 2D Android `https://developer.android.com/reference/android/view/View.html`, within a spatialized XR scene. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceEntity` | A SpaceEntity is a special Entity subtype whose position is independent of other SpaceEntity. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity` | SurfaceEntity is an `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` that hosts a `https://developer.android.com/reference/android/view/Surface.html`, which will be texture mapped onto the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SurfaceEntity.Shape`. |

Known indirect subclasses [ActivityPanelEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivityPanelEntity), [ActivitySpace](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace), [AnchorSpace](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace), [MainPanelEntity](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/MainPanelEntity)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivityPanelEntity` | ActivityPanelEntity creates a spatial panel for embedding an `https://developer.android.com/reference/android/app/Activity.html` in Android XR. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace` | ActivitySpace is a `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceEntity` used to track the system-managed pose and boundary of the volume associated with a spatialized Activity. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace` | An AnchorSpace is a `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceEntity` tracks a `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` relative to some position or surface in the "Real World." Children of this `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SpaceEntity` will remain positioned relative to that location in the real world. |
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/MainPanelEntity` | Represents the main spatialized panel in a `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Scene`. |

*** ** * ** ***

An Entity is the fundamental building block of a SceneCore `https://developer.android.com/reference/kotlin/androidx/xr/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 `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/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. `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace` and `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/AnchorSpace`) as well as those which are used to render different types of content (e.g. `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PanelEntity` and `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/GltfModelEntity`).

## Summary

| ### Public companion functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#create(androidx.xr.runtime.Session,kotlin.String,androidx.xr.runtime.math.Pose,androidx.xr.scenecore.Entity)(session: https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session, name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?, pose: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose, parent: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity?)` Public factory method for creating an `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity`. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#addChild(androidx.xr.scenecore.Entity)(child: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity)` Sets an Entity to be a child of this Entity in the scene graph. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#addComponent(androidx.xr.scenecore.Component)(component: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Component)` Adds a Component to this Entity. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 1.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getAlpha(androidx.xr.scenecore.Space)(relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space)` Returns the alpha transparency set for this Entity, relative to given Space. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Component>` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getComponents()()` Retrieves all components attached to this Entity. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T>` | `<T : https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Component> https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getComponentsOfType(java.lang.Class)(type: https://developer.android.com/reference/java/lang/Class.html<T>)` Retrieves all Components of the given type `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getComponentsOfType(java.lang.Class)` and its subtypes attached to this Entity. |
| `open https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getPose(androidx.xr.scenecore.Space)(relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space)` Returns the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` for this Entity, relative to the provided `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space`. |
| `open @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getScale(androidx.xr.scenecore.Space)(relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space)` Returns the scale of this entity, relative to given space. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#isEnabled(kotlin.Boolean)(includeParents: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Returns the enabled status of this Entity. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#removeAllComponents()()` Remove all components from this Entity. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#removeComponent(androidx.xr.scenecore.Component)(component: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Component)` Removes the given Component from this Entity. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setAlpha(kotlin.Float)(alpha: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 1.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)` Sets the alpha transparency of the Entity relative to the parent Space. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setEnabled(kotlin.Boolean)(enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Sets the local enabled state of this Entity. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setPose(androidx.xr.runtime.math.Pose,androidx.xr.scenecore.Space)(pose: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose, relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space)` Sets the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` for this Entity. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#setScale(kotlin.Float,androidx.xr.scenecore.Space)(scale: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space)` Sets the scale of this Entity relative to the given Space. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity>` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#children()` Provides the list of all children of this entity. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#contentDescription()` Alternate text for this Entity to be consumed by Accessibility systems. |
| `open https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity?` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#parent()` The parent of this Entity, from which this Entity will inherit most of its properties. |

### Inherited functions

From [androidx.xr.scenecore.BaseScenePose](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose) `open suspend https://developer.android.com/reference/kotlin/androidx/xr/scenecore/HitTestResult?` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#hitTest(androidx.xr.runtime.math.Vector3,androidx.xr.runtime.math.Vector3)(origin: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3, direction: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3)`

Perform a hit test from the specified origin in the specified direction into the Scene.
`open suspend https://developer.android.com/reference/kotlin/androidx/xr/scenecore/HitTestResult?` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#hitTest(androidx.xr.runtime.math.Vector3,androidx.xr.runtime.math.Vector3,kotlin.Int)(origin: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3, direction: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3, hitTestFilter: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Creates a hit test from the specified origin in the specified direction into the scene.
`open https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#transformDirectionTo(androidx.xr.runtime.math.Vector3,androidx.xr.scenecore.ScenePose)(direction: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3, destination: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ScenePose)`

Transforms a direction from this ScenePose's local space to the destination ScenePose's local space.
`open https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#transformPoseTo(androidx.xr.runtime.math.Pose,androidx.xr.scenecore.ScenePose)(pose: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose, destination: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ScenePose)`

Returns a `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` relative to this ScenePose, transformed into a Pose relative to the destination.
`open https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#transformPositionTo(androidx.xr.runtime.math.Vector3,androidx.xr.scenecore.ScenePose)(position: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3, destination: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ScenePose)`

Transforms a position from this ScenePose's local space to the destination ScenePose's local space.
`open https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#transformVectorTo(androidx.xr.runtime.math.Vector3,androidx.xr.scenecore.ScenePose)(vector: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Vector3, destination: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ScenePose)`

Transforms a vector from this ScenePose's local space to the destination ScenePose's local space.

### Inherited properties

From [androidx.xr.scenecore.BaseScenePose](https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose) `open https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/BaseScenePose#poseInActivitySpace()`

The current `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` relative to the activity space root.

## Public companion functions

### create

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun create(
    session: Session,
    name: String? = null,
    pose: Pose = Pose.Identity,
    parent: Entity? = null
): Entity
```

Public factory method for creating an `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity`.

| Parameters |
|---|---|
| `session: https://developer.android.com/reference/kotlin/androidx/xr/runtime/Session` | Session to create the Entity in. |
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | Name of the entity. This is unset by default. |
| `pose: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose = Pose.Identity` | Initial pose of the entity. The default value is `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose#Identity()`. |
| `parent: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity? = null` | 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., `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/ActivitySpace` or any other `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` already present in the scene) is assigned later, the entity will become visible (provided it is enabled). This allows for `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` pre-configuration before making it visible. |

## Public functions

### addChild

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
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: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` | The `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity` to be attached. |

### addComponent

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun addComponent(component: Component): Boolean
```

Adds a Component to this Entity.

| Parameters |
|---|---|
| `component: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Component` | the Component to be added to the Entity. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if given Component was successfully added to the Entity. This can be false for certain components if an Entity already has a component of that type or does not support the component type. |

### getAlpha

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
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: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space = Space.PARENT` | Gets alpha relative to given Space. Default value is the parent space. |

### getComponents

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun getComponents(): List<Component>
```

Retrieves all components attached to this Entity.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Component>` | List attached to this Entity. |

### getComponentsOfType

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

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

Retrieves all Components of the given type `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#getComponentsOfType(java.lang.Class)` and its subtypes attached to this Entity.

| Parameters |
|---|---|
| `type: https://developer.android.com/reference/java/lang/Class.html<T>` | The type of Component to retrieve. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<T>` | List of the given type attached to this Entity. This list will be empty if no components of the given type are attached to this Entity. |

### getPose

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

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

Returns the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` for this Entity, relative to the provided `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space`.

| Parameters |
|---|---|
| `relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space = Space.PARENT` | Get the Pose relative to given Space. Default value is the parent space. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` | Current `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` of the Entity relative to the given space. |

### getScale

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

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

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

| Parameters |
|---|---|
| `relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space = Space.PARENT` | Get the scale relative to given Space. Default value is the parent space. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | Current uniform scale applied to self and children. |

### isEnabled

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun isEnabled(includeParents: Boolean = true): Boolean
```

Returns the enabled status of this Entity.

If `includeParents` is `true`, the returned value will be `false` if this Entity or any of its ancestors is disabled. 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.

| Parameters |
|---|---|
| `includeParents: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether to include the enabled status of parents in the returned value. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if this Entity is enabled, possibly including the enabled status of its parents. |

### removeAllComponents

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun removeAllComponents(): Unit
```

Remove all components from this Entity.

### removeComponent

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun removeComponent(component: Component): Unit
```

Removes the given Component from this Entity.

### setAlpha

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
fun setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float): Unit
```

Sets the alpha transparency of the Entity relative to the parent 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. As a result, the effective alpha of a child cannot exceed the effective alpha of its parent.

| Parameters |
|---|---|
| `alpha: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 1.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | Alpha transparency level for the Entity. |

### setEnabled

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
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: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | The new local enabled state of this Entity. |

### setPose

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

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

Sets the `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` for this Entity. The Pose given is set relative to the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space` provided.

| Parameters |
|---|---|
| `pose: https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` | The `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/Pose` offset from the parent. |
| `relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space = Space.PARENT` | Set the pose relative to given Space. Default value is the parent space. |

### setScale

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
open 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: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The uniform scale factor. |
| `relativeTo: https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Space = Space.PARENT` | Set the scale relative to given Space. Default value is the parent Space. |

## Public properties

### children

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
val children: List<Entity>
```

Provides the list of all children of this entity. Adding children can be done using `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#addChild(androidx.xr.scenecore.Entity)` or by setting the `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#parent()` property of the child Entity. To remove a child, set the child's `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity#parent()` property to another Entity or `null`.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/xr/scenecore/Entity>` | List of all children of this entity. |

### contentDescription

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
var contentDescription: CharSequence
```

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

### parent

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-scenecore#1.0.0)

```
open var parent: Entity?
```

The parent of this Entity, from which this Entity will inherit most of its properties. For example, this Entity's `https://developer.android.com/reference/kotlin/androidx/xr/runtime/math/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.