Session

fun create(activity: Activity, runtime: JxrPlatformAdapter? = null): Session

Creates a session and pairs it with an Activity and its lifecycle. If a session is already paired with an Activity, return that Session instead of creating a new one.

For our Alpha release, we just directly instantiate the Android XR PlatformAdapter.

fun addSpatialCapabilitiesChangedListener(
    listener: Consumer<SpatialCapabilities>
): Unit

Adds the given Consumer as a listener to be invoked when this Session's current SpatialCapabilities change. Consumer#accept(SpatialCapabilities) will be invoked on the main thread.

fun addSpatialCapabilitiesChangedListener(
    callbackExecutor: Executor,
    listener: Consumer<SpatialCapabilities>
): Unit

Adds the given Consumer as a listener to be invoked when this Session's current SpatialCapabilities change. Consumer#accept(SpatialCapabilities) will be invoked on the given callbackExecutor, or the main thread if the callbackExecutor is null (default).

fun canEmbedActivityPanel(activity: Activity): Boolean

Helper function to query if given activity can be a host to ActivityPanel.

fun createActivityPanelEntity(
    windowBoundsPx: Rect,
    name: String,
    pose: Pose = Pose.Identity
): ActivityPanelEntity

Public factory function for a spatial ActivityPanelEntity.

fun createAnchorEntity(anchor: Anchor): AnchorEntity

Public factory function for an AnchorEntity which uses an Anchor from ARCore for XR.

fun createAnchorEntity(
    bounds: Dimensions,
    planeType: Int,
    planeSemantic: Int,
    timeout: Duration = Duration.ZERO
): AnchorEntity

Public factory function for an AnchorEntity which searches for a location to create an Anchor among the tracked planes available to the perception system.

Note that this function will fail if the application has not been granted the "android.permission.SCENE_UNDERSTANDING" permission. Consider using PermissionHelper to help request permission from the User.

fun createEntity(name: String, pose: Pose = Pose.Identity): Entity

Public factory function for creating a content-less entity. This entity is used as a connection point for attaching children entities and managing them (i.e. setPose()) as a group.

fun createExrImageResource(name: String): ExrImage

Public factory function for an EXRImage, where the EXR is loaded from a local file.

@MainThread
fun createGltfEntity(model: GltfModel, pose: Pose = Pose.Identity): GltfModelEntity

Public factory function for a GltfModelEntity.

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

@MainThread
fun createGltfResourceAsync(name: String): ListenableFuture<GltfModel>

Public factory function for a GltfModel, where the glTF is asynchronously loaded.

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

Currently, only URLs and relative paths from the android_assets/ directory are supported. Currently, only binary glTF (.glb) files are supported.

fun createInteractableComponent(
    executor: Executor,
    inputEventListener: InputEventListener
): InteractableComponent

Public factory for creating an InteractableComponent. It enables access to raw input events.

fun createMovableComponent(
    systemMovable: Boolean = true,
    scaleInZ: Boolean = true,
    anchorPlacement: Set<AnchorPlacement> = emptySet(),
    shouldDisposeParentAnchor: Boolean = true
): MovableComponent

Public factory function for creating a MovableComponent. This component can be attached to a single instance of any non-Anchor Entity.

When attached, this Component will enable the user to translate the Entity by pointing and dragging on it.

fun createPanelEntity(
    view: View,
    surfaceDimensionsPx: Dimensions,
    dimensions: Dimensions,
    name: String,
    pose: Pose = Pose.Identity
): PanelEntity

Public factory function for a spatialized PanelEntity.

fun createPersistedAnchorEntity(uuid: UUID): AnchorEntity

Public factory function for a persisted AnchorEntity using UUID. Note that the system keeps a limited number of scenes and anchors. If the anchor is pruned due to the system limitation, the creation will fail. It will return null if there is a failure.

fun createResizableComponent(
    minimumSize: Dimensions = ResizableComponent.kMinimumSize,
    maximumSize: Dimensions = ResizableComponent.kMaximumSize
): ResizableComponent

Public factory function for creating a ResizableComponent. This component can be attached to a single instance of any non-Anchor Entity.

When attached, this Component will enable the user to resize the Entity by dragging along the boundaries of the interaction highlight.

@MainThread
fun createStereoSurfaceEntity(
    stereoMode: Int = StereoSurfaceEntity.StereoMode.SIDE_BY_SIDE,
    dimensions: Dimensions = Dimensions(1.0f, 1.0f, 1.0f),
    pose: Pose = Pose.Identity
): StereoSurfaceEntity

Public factory function for a StereoSurfaceEntity.

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

fun <T : Entity> getEntitiesOfType(type: Class<T>): List<T>

Returns all Entitys of the given type or its subtypes.

fun getSpatialCapabilities(): SpatialCapabilities

Returns the current SpatialCapabilities of the Session. The set of capabilities can change within a session. The returned object will not update if the capabilities change; this method should be called again to get the latest set of capabilities.

fun hasSpatialCapability(capability: Int): Boolean

Returns true if the Session is currently capable of the given SpatialCapability, false otherwise. The available set of capabilities can change within a session.

fun removeSpatialCapabilitiesChangedListener(
    listener: Consumer<SpatialCapabilities>
): Unit

Releases the given Consumer from receiving updates when the Session's SpatialCapabilities change.

fun requestFullSpaceMode(): Unit

If the primary Activity for this Session has focus, causes it to be placed in FullSpace Mode. Otherwise, this call does nothing.

fun requestHomeSpaceMode(): Unit

If the primary Activity for this Session has focus, causes it to be placed in HomeSpace Mode. Otherwise, this call does nothing.

fun setFullSpaceMode(bundle: Bundle): Bundle

Sets the full space mode flag to the given android.os.Bundle.

The android.os.Bundle then could be used to launch an android.app.Activity with requesting to enter full space mode through android.app.Activity.startActivity. If there's a bundle used for customizing how the android.app.Activity should be started by android.app.ActivityOptions.toBundle or androidx.core.app.ActivityOptionsCompat.toBundle, it's suggested to use the bundle to call this method.

The flag will be ignored when no android.content.Intent.FLAG_ACTIVITY_NEW_TASK is set in the bundle, or it is not started from a focused Activity context.

This flag is also ignored when the android.window.PROPERTY_XR_ACTIVITY_START_MODE property is set to a value other than XR_ACTIVITY_START_MODE_UNDEFINED in the AndroidManifest.xml file for the activity being launched.

fun setFullSpaceModeWithEnvironmentInherited(bundle: Bundle): Bundle

Sets the inherit full space mode environvment flag to the given android.os.Bundle.

The android.os.Bundle then could be used to launch an android.app.Activity with requesting to enter full space mode while inherit the existing environment through android.app.Activity.startActivity. If there's a bundle used for customizing how the android.app.Activity should be started by android.app.ActivityOptions.toBundle or androidx.core.app.ActivityOptionsCompat.toBundle, it's suggested to use the bundle to call this method.

When launched, the activity will be in full space mode and also inherits the environment from the launching activity. If the inherited environment needs to be animated, the launching activity has to continue updating the environment even after the activity is put into the stopped state.

The flag will be ignored when no android.content.Intent.FLAG_ACTIVITY_NEW_TASK is set in the intent, or it is not started from a focused Activity context.

The flag will also be ignored when there is no environment to inherit or the activity has its own environment set already.

This flag is ignored too when the android.window.PROPERTY_XR_ACTIVITY_START_MODE property is set to a value other than XR_ACTIVITY_START_MODE_UNDEFINED in the AndroidManifest.xml file for the activity being launched.

For security reasons, Z testing for the new activity is disabled, and the activity is always drawn on top of the inherited environment. Because Z testing is disabled, the activity should not spatialize itself, and should not curve its panel too much either.

fun setPreferredAspectRatio(activity: Activity, preferredRatio: Float): Unit

Sets a preferred main panel aspect ratio for home space mode.

The ratio is only applied to the activity. If the activity launches another activity in the same task, the ratio is not applied to the new activity. Also, while the activity is in full space mode, the preference is temporarily removed.

fun unpersistAnchor(uuid: UUID): Boolean

Unpersists an anchor. It will clean up the data in the storage that is required to retrieve the anchor.

val activitySpace: ActivitySpace

The ActivitySpace is a special entity that represents the space in which the application is launched. It is the default parent of all entities in the scene.

The ActivitySpace is created automatically when the Session is created.

val mainPanelEntity: PanelEntity

A spatialized PanelEntity associated with the "main window" for the Activity. When in HomeSpace mode, this is the application's "main window".

If called multiple times, this will return the same PanelEntity.

val perceptionSpace: PerceptionSpace

The PerceptionSpace represents the origin of the space in which the ARCore for XR API provides tracking info. The transformations provided by the PerceptionSpace are only valid for the call frame, as the transformation can be changed by the system at any time.

val spatialUser: SpatialUser

The SpatialUser contains information about the user.