ActivitySpace

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

class ActivitySpace : BaseEntity

kotlin.Any
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.BaseEntity
		↳	androidx.xr.scenecore.ActivitySpace

ActivitySpace is an Entity 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`	`addOnBoundsChangedListener(listener: Consumer<FloatSize3d>)` Adds the given `Consumer` as a listener to be invoked when this ActivitySpace's current boundary changes.
`Unit`	`addOnBoundsChangedListener( callbackExecutor: Executor, listener: Consumer<FloatSize3d> )` Adds the given `Consumer` as a listener to be invoked when this ActivitySpace's current boundary changes.
`Unit`	`addOnSpaceUpdatedListener(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`	`addOnSpaceUpdatedListener(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.
`open Unit`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`open Pose`	`getPose(relativeTo: Space)` Returns the pose of the `ActivitySpace` relative to the specified coordinate space.
`open Float`	`getScale(relativeTo: Space)` Returns the scale of the `ActivitySpace` relative to the specified coordinate space.
`Unit`	`removeOnBoundsChangedListener(listener: Consumer<FloatSize3d>)` Releases the given `Consumer` from receiving updates when the ActivitySpace's boundary changes.
`Unit`	`removeOnSpaceUpdatedListener(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 Mode.

Inherited functions

From androidx.xr.scenecore.BaseEntity

`open Unit`	`addChild(child: Entity)` Sets an Entity to be a child of this Entity in the scene graph.
`open Boolean`	`addComponent(component: Component)` Adds a Component to this Entity.
`open Float`	`getAlpha(relativeTo: Space)` Returns the alpha transparency set for this Entity, relative to given Space.
`open List<Component>`	`getComponents()` Retrieves all components attached to this Entity.
`open List<T>`	`<T : Component> getComponentsOfType(type: Class<T>)` Retrieves all Components of the given type `T` and its sub-types attached to this Entity.
`open Boolean`	`isEnabled(includeParents: Boolean)` Returns the enabled status of this Entity.
`open Unit`	`removeAllComponents()` Remove all components from this Entity.
`open Unit`	`removeComponent(component: Component)` Removes the given Component from this Entity.
`open Unit`	`setAlpha(alpha: Float, relativeTo: Space)` Sets the alpha transparency of the Entity relative to given Space.
`open Unit`	`setEnabled(enabled: Boolean)` Sets the local enabled state of this Entity.

From androidx.xr.scenecore.Entity

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

From androidx.xr.scenecore.ScenePose

`abstract suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3)` Perform a hit test from the specified origin in the specified direction into the Scene.
`abstract suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3, hitTestFilter: Int)` Creates a hit test from the specified origin in the specified direction into the scene.
`abstract Pose`	`transformPoseTo(pose: Pose, destination: ScenePose)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.

Inherited properties

From androidx.xr.scenecore.BaseEntity

`open List<Entity>`	`children` Provides the list of all children of this entity.
`open CharSequence`	`contentDescription` Alternate text for this Entity to be consumed by Accessibility systems.
`open Entity?`	`parent` The parent of this Entity, from which this Entity will inherit most of its properties.

From androidx.xr.scenecore.ScenePose

abstract Pose

activitySpacePose

The current Pose relative to the activity space root.

Public functions

addOnBoundsChangedListener

Added in 1.0.0-alpha09

fun addOnBoundsChangedListener(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.

addOnBoundsChangedListener

Added in 1.0.0-alpha09

fun addOnBoundsChangedListener(
    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.

addOnSpaceUpdatedListener

Added in 1.0.0-alpha09

fun addOnSpaceUpdatedListener(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 AnchorEntity and CameraView, 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.

addOnSpaceUpdatedListener

Added in 1.0.0-alpha09

fun addOnSpaceUpdatedListener(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.

dispose

open fun dispose(): Unit

Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children. Once disposed, this Entity is invalid and cannot be used again.

getPose

open fun getPose(relativeTo: Space): Pose

Returns the pose of the ActivitySpace relative to the specified coordinate space.

Parameters
`relativeTo: Space`	The coordinate space to get the pose relative to. Defaults to `Space.PARENT`.

Returns
`Pose`	The current pose of the `ActivitySpace`.

Throws
`kotlin.IllegalArgumentException`	if called with Space.PARENT since ActivitySpace has no parents.

getScale

open fun getScale(relativeTo: Space): Float

Returns the scale of the ActivitySpace relative to the specified coordinate space.

Parameters
`relativeTo: Space`	The coordinate space to get the scale relative to. Defaults to `Space.PARENT`.

Returns
`Float`	The current scale of the `ActivitySpace`.

Throws
`kotlin.IllegalArgumentException`	if called with Space.PARENT since ActivitySpace has no parents.

removeOnBoundsChangedListener

Added in 1.0.0-alpha09

fun removeOnBoundsChangedListener(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.

removeOnSpaceUpdatedListener

Added in 1.0.0-alpha09

fun removeOnSpaceUpdatedListener(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-alpha09

val bounds: FloatSize3d

The current bounds of this ActivitySpace.

recommendedContentBoxInFullSpace

Added in 1.0.0-alpha09

val recommendedContentBoxInFullSpace: BoundingBox

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

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.