ActivitySpace

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

class ActivitySpace : SpaceEntity

kotlin.Any
↳	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 functions
`Unit`	`addBoundsChangedListener(listener: Consumer<FloatSize3d>)` Adds the given `Consumer` as a listener to be invoked when this ActivitySpace's current boundary changes.
`Unit`	`addBoundsChangedListener( callbackExecutor: Executor, listener: Consumer<FloatSize3d> )` Adds the given `Consumer` as a listener to be invoked when this ActivitySpace's current boundary changes.
`Unit`	`addOriginChangedListener(listener: Runnable)` Adds a listener to be called when the ActivitySpace's origin has moved or changed, typically due to an internal system event.
`Unit`	`addOriginChangedListener(executor: Executor, listener: Runnable)` Adds a listener to be called when the ActivitySpace's origin has moved or changed, typically due to an internal system event.
`Unit`	`removeBoundsChangedListener(listener: Consumer<FloatSize3d>)` Releases the given `Consumer` from receiving updates when the ActivitySpace's boundary changes.
`Unit`	`removeOriginChangedListener(listener: Runnable)` Removes the previously-added listener.

Public properties
`FloatSize3d`	`bounds` The current bounds of this ActivitySpace.
`BoundingBox`	`recommendedContentBoxInFullSpace` A recommended box for content to be placed in when in Full Space.

Inherited functions

From androidx.xr.scenecore.BaseScenePose

`open suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3)` Perform a hit test from the specified origin in the specified direction into the Scene.
`open suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3, hitTestFilter: Int)` Creates a hit test from the specified origin in the specified direction into the scene.
`open Vector3`	`transformDirectionTo(direction: Vector3, destination: ScenePose)` Transforms a direction from this ScenePose's local space to the destination ScenePose's local space.
`open Pose`	`transformPoseTo(pose: Pose, destination: ScenePose)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.
`open Vector3`	`transformPositionTo(position: Vector3, destination: ScenePose)` Transforms a position from this ScenePose's local space to the destination ScenePose's local space.
`open Vector3`	`transformVectorTo(vector: Vector3, destination: ScenePose)` Transforms a vector from this ScenePose's local space to the destination ScenePose's local space.

From androidx.xr.scenecore.Entity

`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.
`@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 subtypes attached to this Entity.
`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.
`Unit`	`setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float)` Sets the alpha transparency of the Entity relative to the parent Space.
`Unit`	`setEnabled(enabled: Boolean)` Sets the local enabled state of this Entity.

From androidx.xr.scenecore.SpaceEntity

`open Pose`	`getPose(relativeTo: Space)` Returns the pose of the `SpaceEntity` relative to the specified coordinate space.
`open Float`	`getScale(relativeTo: Space)` Returns the scale of the `SpaceEntity` relative to the specified coordinate space.
`open Unit`	`setPose(pose: Pose, relativeTo: Space)` Throws `UnsupportedOperationException` if called.
`open Unit`	`setScale(scale: Float, relativeTo: Space)` Throws `UnsupportedOperationException` if called.

Inherited properties

From androidx.xr.scenecore.BaseScenePose

open Pose

poseInActivitySpace

The current Pose relative to the activity space root.

From androidx.xr.scenecore.Entity

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

From androidx.xr.scenecore.SpaceEntity

open Entity?

parent

Throws UnsupportedOperationException if called.

Public functions

addBoundsChangedListener

Added in 1.0.0-beta01

fun addBoundsChangedListener(listener: Consumer<FloatSize3d>): Unit

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
`listener: Consumer<FloatSize3d>`	The Consumer to be invoked when this ActivitySpace's current boundary changes.

addBoundsChangedListener

Added in 1.0.0-beta01

fun addBoundsChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<FloatSize3d>
): Unit

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
`callbackExecutor: Executor`	The executor on which to invoke the listener on.
`listener: Consumer<FloatSize3d>`	The Consumer to be invoked when this ActivitySpace's current boundary changes.

addOriginChangedListener

Added in 1.0.0-beta01

fun addOriginChangedListener(listener: Runnable): Unit

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
`listener: Runnable`	The listener to register.

addOriginChangedListener

Added in 1.0.0-beta01

fun addOriginChangedListener(executor: Executor, listener: Runnable): Unit

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

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

removeBoundsChangedListener

Added in 1.0.0-beta01

fun removeBoundsChangedListener(listener: Consumer<FloatSize3d>): Unit

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
`listener: Consumer<FloatSize3d>`	The Consumer to be removed from receiving updates.

removeOriginChangedListener

Added in 1.0.0-beta01

fun removeOriginChangedListener(listener: Runnable): Unit

Removes the previously-added listener.

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

Public properties

bounds

Added in 1.0.0-beta01

val bounds: FloatSize3d

The current bounds of this ActivitySpace.

recommendedContentBoxInFullSpace

Added in 1.0.0-beta01

val recommendedContentBoxInFullSpace: BoundingBox

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.