ActivitySpace

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class ActivitySpace extends SpaceEntity

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

ActivitySpace is a SpaceEntity used to track the system-managed pose and boundary of the volume associated with a spatialized Activity. The Application cannot directly control this volume, but the system might update it in response to the User moving it or entering or exiting Full Space Mode.

Summary

Public methods
`final void`	`addBoundsChangedListener(@NonNull Consumer<@NonNull FloatSize3d> listener)` Adds the given `Consumer` as a listener to be invoked when this ActivitySpace's current boundary changes.
`final void`	`addBoundsChangedListener( @NonNull Executor callbackExecutor, @NonNull Consumer<@NonNull FloatSize3d> listener )` Adds the given `Consumer` as a listener to be invoked when this ActivitySpace's current boundary changes.
`final void`	`addOriginChangedListener(@NonNull Runnable listener)` Adds a listener to be called when the ActivitySpace's origin has moved or changed, typically due to an internal system event.
`final void`	`addOriginChangedListener( @NonNull Executor executor, @NonNull Runnable listener )` Adds a listener to be called when the ActivitySpace's origin has moved or changed, typically due to an internal system event.
`final @NonNull FloatSize3d`	`getBounds()` The current bounds of this ActivitySpace.
`final @NonNull BoundingBox`	`getRecommendedContentBoxInFullSpace()` A recommended box for content to be placed in when in Full Space.
`final void`	`removeBoundsChangedListener( @NonNull Consumer<@NonNull FloatSize3d> listener )` Releases the given `Consumer` from receiving updates when the ActivitySpace's boundary changes.
`final void`	`removeOriginChangedListener(@NonNull Runnable listener)` Removes the previously-added listener.

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.

From androidx.xr.scenecore.Entity

`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.
`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 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.

From androidx.xr.scenecore.SpaceEntity

`Entity`	`getParent()` Throws `UnsupportedOperationException` if called.
`@NonNull Pose`	`getPose(@NonNull Space relativeTo)` Returns the pose of the `SpaceEntity` relative to the specified coordinate space.
`float`	`getScale(@NonNull Space relativeTo)` Returns the scale of the `SpaceEntity` relative to the specified coordinate space.
`void`	`setParent(Entity <unused var>)` Throws `UnsupportedOperationException` if called.
`void`	`setPose(@NonNull Pose pose, @NonNull Space relativeTo)` Throws `UnsupportedOperationException` if called.
`void`	`setScale(float scale, @NonNull Space relativeTo)` Throws `UnsupportedOperationException` if called.

Public methods

addBoundsChangedListener

Added in 1.0.0-beta01

public final void addBoundsChangedListener(@NonNull Consumer<@NonNull FloatSize3d> listener)

Adds the given Consumer as a listener to be invoked when this ActivitySpace's current boundary changes.

Consumer.accept will be invoked on the main thread.

Parameters
`@NonNull Consumer<@NonNull FloatSize3d> listener`	The Consumer to be invoked when this ActivitySpace's current boundary changes.

addBoundsChangedListener

Added in 1.0.0-beta01

public final void addBoundsChangedListener(
    @NonNull Executor callbackExecutor,
    @NonNull Consumer<@NonNull FloatSize3d> listener
)

Adds the given Consumer as a listener to be invoked when this ActivitySpace's current boundary changes.

Consumer.accept will be invoked on the given executor.

Parameters
`@NonNull Executor callbackExecutor`	The executor on which to invoke the listener on.
`@NonNull Consumer<@NonNull FloatSize3d> listener`	The Consumer to be invoked when this ActivitySpace's current boundary changes.

addOriginChangedListener

Added in 1.0.0-beta01

public final void addOriginChangedListener(@NonNull Runnable listener)

Adds a listener to be called when the ActivitySpace's origin has moved or changed, typically due to an internal system event.

When this event occurs, any ScenePose that is not a child of ActivitySpace, such as AnchorSpace, will have a different position relative to the ActivitySpace. Therefore, this listener can be used to indicate when to invalidate any cached information about the relative difference in Pose between ActivitySpace's children and children of non-ActivitySpace ScenePoses.

The callback will be made on the SceneCore executor.

Parameters
`@NonNull Runnable listener`	The listener to register.

addOriginChangedListener

Added in 1.0.0-beta01

public final void addOriginChangedListener(
    @NonNull Executor executor,
    @NonNull Runnable listener
)

Adds a listener to be called when the ActivitySpace's origin has moved or changed, typically due to an internal system event.

Parameters
`@NonNull Executor executor`	The `Executor` on which to run the listener.
`@NonNull Runnable listener`	The listener to register.

getBounds

Added in 1.0.0-beta01

public final @NonNull FloatSize3d getBounds()

The current bounds of this ActivitySpace.

getRecommendedContentBoxInFullSpace

Added in 1.0.0-beta01

public final @NonNull BoundingBox getRecommendedContentBoxInFullSpace()

A recommended box for content to be placed in when in Full Space.

The recommended content box is a static 3D volume that uses the device's field of view (FOV) angles, the system's default launch distance from the user, and the default scale of the system to calculate a box size that is sized to encompass the user's primary field of view.

This size does not change throughout the lifecycle of the application. Furthermore, the recommended content box does not have an independent concept of pose; its position is defined by the origin of this ActivitySpace.

The box is relative to the ActivitySpace's coordinate system. It is not scaled by the ActivitySpace's transform. The dimensions are always in meters. This provides a device-specific default volume that developers can use to size their content appropriately.

removeBoundsChangedListener

Added in 1.0.0-beta01

public final void removeBoundsChangedListener(
    @NonNull Consumer<@NonNull FloatSize3d> listener
)

Releases the given Consumer from receiving updates when the ActivitySpace's boundary changes.

All listeners are automatically removed when the ActivitySpace is disposed even if this method is not explicitly called.

Parameters
`@NonNull Consumer<@NonNull FloatSize3d> listener`	The Consumer to be removed from receiving updates.

removeOriginChangedListener

Added in 1.0.0-beta01

public final void removeOriginChangedListener(@NonNull Runnable listener)

Removes the previously-added listener.

All listeners are automatically removed when the ActivitySpace is disposed even if this method is not explicitly called.