GroupEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class GroupEntity extends BaseEntity

java.lang.Object
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.BaseEntity
		↳	androidx.xr.scenecore.GroupEntity

An Entity that contains no content, but can have an arbitrary number of children. GroupEntity is useful for organizing the placement and movement of a group of child SceneCore Entities.

Summary

Public methods
`static final @NonNull Entity`	`create(@NonNull Session session, @NonNull String name, @NonNull Pose pose)` Public factory method for creating a `GroupEntity`.

Inherited methods

From androidx.xr.scenecore.BaseEntity

`void`	`addChild(@NonNull Entity child)` Sets an Entity to be a child of this Entity in the scene graph.
`boolean`	`addComponent(@NonNull Component component)` Adds a Component to this Entity.
`void`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`float`	`getAlpha(int relativeTo)` Returns the alpha transparency set for this Entity, relative to given Space.
`@NonNull List<@NonNull Component>`	`getComponents()` Retrieves all components attached to this Entity.
`@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.
`@NonNull CharSequence`	`getContentDescription()` Alternate text for this Entity to be consumed by Accessibility systems.
`Entity`	`getParent()` The parent of this Entity, from which this Entity will inherit most of its properties.
`@NonNull Pose`	`getPose(int relativeTo)` Returns the `Pose` for this Entity, relative to the provided `Space`.
`float`	`getScale(int relativeTo)` Returns the scale of this entity, relative to given space.
`boolean`	`isEnabled(boolean includeParents)` Returns the enabled status of this Entity.
`void`	`removeAllComponents()` Remove all components from this Entity.
`void`	`removeComponent(@NonNull Component component)` Removes the given Component from this Entity.
`void`	`setAlpha(float alpha, int relativeTo)` Sets the alpha transparency of the Entity relative to given Space.
`void`	`setContentDescription(@NonNull CharSequence contentDescription)` Alternate text for this Entity to be consumed by Accessibility systems.
`void`	`setEnabled(boolean enabled)` Sets the local enabled state of this Entity.
`void`	`setParent(Entity parent)` The parent of this Entity, from which this Entity will inherit most of its properties.
`void`	`setPose(@NonNull Pose pose, int relativeTo)` Sets the `Pose` for this Entity.
`void`	`setScale(float scale, int relativeTo)` Sets the scale of this Entity relative to given Space.

From androidx.xr.scenecore.Entity

`@FloatRange(from = 0.0, to = 1.0) float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`@NonNull Pose`	`getPose()` Returns the `Pose` for this Entity, relative to its parent.
`@FloatRange(from = 0.0) float`	`getScale()` Returns the local scale of this Entity, not inclusive of the parent's scale.
`void`	`setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)` Sets the alpha transparency of the Entity and its children.
`void`	`setPose(@NonNull Pose pose)` Sets the `Pose` for this Entity, relative to its parent.
`void`	`setScale(@FloatRange(from = 0.0) float scale)` Sets the scale of this Entity relative to its parent.

From androidx.xr.scenecore.ScenePose

`abstract @NonNull Pose`	`getActivitySpacePose()` The current `Pose` relative to the activity space root.
`abstract @NonNull HitTestResult`	`hitTest(@NonNull Vector3 origin, @NonNull Vector3 direction)` Creates a hit test from the specified origin in the specified direction into the Scene.
`abstract @NonNull 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.
`abstract @NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ScenePose destination)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.

Public methods

create

Added in 1.0.0-alpha06

public static final @NonNull Entity create(@NonNull Session session, @NonNull String name, @NonNull Pose pose)

Public factory method for creating a GroupEntity.

Parameters
`@NonNull Session session`	Session to create the GroupEntity in.
`@NonNull String name`	Name of the entity.
`@NonNull Pose pose`	Initial pose of the entity.