JxrPlatformAdapter

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

Adds the given Consumer as a listener to be invoked when this Session's current SpatialCapabilities change. accept will be invoked on the given Executor.

fun createActivityPanelEntity(
    pose: Pose,
    windowBoundsPx: JxrPlatformAdapter.PixelDimensions,
    name: String,
    hostActivity: Activity,
    parent: JxrPlatformAdapter.Entity
): JxrPlatformAdapter.ActivityPanelEntity

Factory function to create ActivityPanel to launch/move activity into.

fun createAnchorEntity(anchor: Anchor): JxrPlatformAdapter.AnchorEntity

A factory function to create an Anchor entity from a androidx.xr.arcore.Anchor.

fun createAnchorEntity(
    bounds: JxrPlatformAdapter.Dimensions,
    planeType: JxrPlatformAdapter.PlaneType,
    planeSemantic: JxrPlatformAdapter.PlaneSemantic,
    searchTimeout: Duration
): JxrPlatformAdapter.AnchorEntity

A factory function to create an Anchor entity.

fun createAnchorPlacementForPlanes(
    planeTypeFilter: (Mutable)Set<JxrPlatformAdapter.PlaneType!>,
    planeSemanticFilter: (Mutable)Set<JxrPlatformAdapter.PlaneSemantic!>
): JxrPlatformAdapter.AnchorPlacement

Creates an instance of an AnchorPlacement object.

This can be used in movable components to specify the anchor placement for the entity.

fun createEntity(pose: Pose, name: String, parent: JxrPlatformAdapter.Entity): JxrPlatformAdapter.Entity

A factory function to create 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 createGltfEntity(
    pose: Pose,
    loadedGltf: JxrPlatformAdapter.GltfModelResource,
    parentEntity: JxrPlatformAdapter.Entity?
): JxrPlatformAdapter.GltfEntity

A factory function to create a SceneCore GltfEntity. The parent may be the activity space or GltfEntity in the scene.

fun createInteractableComponent(
    executor: Executor,
    listener: JxrPlatformAdapter.InputEventListener
): JxrPlatformAdapter.InteractableComponent

Create an Interactable component.

fun createLoggingEntity(pose: Pose): JxrPlatformAdapter.LoggingEntity

A function to create a SceneCore Entity

fun createMovableComponent(
    systemMovable: Boolean,
    scaleInZ: Boolean,
    anchorPlacement: (Mutable)Set<JxrPlatformAdapter.AnchorPlacement!>,
    shouldDisposeParentAnchor: Boolean
): JxrPlatformAdapter.MovableComponent

Create an instance of [MovableComponent]. This component allows the user to move the entity.

fun createPanelEntity(
    pose: Pose,
    view: View,
    surfaceDimensionsPx: JxrPlatformAdapter.PixelDimensions,
    dimensions: JxrPlatformAdapter.Dimensions,
    name: String,
    context: Context,
    parent: JxrPlatformAdapter.Entity
): JxrPlatformAdapter.PanelEntity

A factory function to create a platform PanelEntity. The parent can be any entity.

fun createPersistedAnchorEntity(uuid: UUID, searchTimeout: Duration): JxrPlatformAdapter.AnchorEntity

A factory function to recreate an Anchor entity which was persisted in a previous session.

fun createPointerCaptureComponent(
    executor: Executor,
    stateListener: JxrPlatformAdapter.PointerCaptureComponent.StateListener,
    inputListener: JxrPlatformAdapter.InputEventListener
): JxrPlatformAdapter.PointerCaptureComponent

Create an instance of PointerCaptureComponent. This component allows the user to capture and redirect to itself all input that would be received by entities other than the Entity it is attached to and that entity's children.

In order to enable pointer capture, an application must be in full space and the entity it is attached to must be visible.

Attach this component to the entity to enable pointer capture, detach the component to restore normal input flow.

fun createResizableComponent(
    minimumSize: JxrPlatformAdapter.Dimensions,
    maximumSize: JxrPlatformAdapter.Dimensions
): JxrPlatformAdapter.ResizableComponent

Create an instance of [ResizableComponent]. This component allows the user to resize the entity.

fun createStereoSurfaceEntity(
    stereoMode: Int,
    dimensions: JxrPlatformAdapter.Dimensions,
    pose: Pose,
    parentEntity: JxrPlatformAdapter.Entity
): JxrPlatformAdapter.StereoSurfaceEntity

A factory function for an Entity which displays drawable surfaces.

fun dispose(): Unit

Disposes of the resources used by the platform adapter.

fun getActivitySpace(): JxrPlatformAdapter.ActivitySpace

Returns the Activity Space entity at the root of the scene.

fun getActivitySpaceRootImpl(): JxrPlatformAdapter.Entity

Returns the entity that represents the ActivitySpace root.

SDK's factory methods are expected to use this entity as the default parent for all content entities when no parent is specified.

fun getAudioTrackExtensionsWrapper(): JxrPlatformAdapter.AudioTrackExtensionsWrapper

Returns an [AudioTrackExtensionssWrapper] instance.

fun getCameraViewActivityPose(cameraType: Int): JxrPlatformAdapter.CameraViewActivityPose?

Returns the CameraViewActivityPose for the specified camera type or null if it is not ready/available.

fun getHeadActivityPose(): JxrPlatformAdapter.HeadActivityPose?

Returns the HeadActivityPose for the Session or null if it is not ready

fun getMainPanelEntity(): JxrPlatformAdapter.PanelEntity

Get the PanelEntity associated with the main window for the Activity.

fun getMediaPlayerExtensionsWrapper(): JxrPlatformAdapter.MediaPlayerExtensionsWrapper

Returns a [MediaPlayerExtensionsWrapper] instance.

fun getPerceptionSpaceActivityPose(): JxrPlatformAdapter.PerceptionSpaceActivityPose

Returns the PerceptionSpaceActivityPose for the Session.

fun getSoundPoolExtensionsWrapper(): JxrPlatformAdapter.SoundPoolExtensionsWrapper

Returns a [SoundPoolExtensionsWrapper] instance.

fun getSpatialCapabilities(): JxrPlatformAdapter.SpatialCapabilities

Return the Spatial Capabilities set that are currently supported by the platform.

fun getSpatialEnvironment(): JxrPlatformAdapter.SpatialEnvironment

Returns the Environment for the Session.

fun loadExrImageByAssetName(assetName: String): ListenableFuture<JxrPlatformAdapter.ExrImageResource!>?

Loads an ExrImage for the given asset name from the assets folder.

fun loadGltfByAssetName(assetName: String): ListenableFuture<JxrPlatformAdapter.GltfModelResource!>?

Loads glTF Asset for the given asset name from the assets folder.

fun loadGltfByAssetNameSplitEngine(assetName: String): ListenableFuture<JxrPlatformAdapter.GltfModelResource!>?

Loads glTF Asset for the given asset name from the assets folder using the Split Engine route. The future returned by this method will fire listeners on the UI thread if Runnable::run is supplied.

fun removeSpatialCapabilitiesChangedListener(
    listener: Consumer<JxrPlatformAdapter.SpatialCapabilities!>
): Unit

Releases the given Consumer from receiving updates when the Session's 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 Bundle.

The Bundle then could be used to launch an Activity with requesting to enter full space mode through startActivity. If there's a bundle used for customizing how the Activity should be started by 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 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 environment flag to the given Bundle.

The Bundle then could be used to launch an Activity with requesting to enter full space mode while inherit the existing environment through startActivity. If there's a bundle used for customizing how the Activity should be started by ActivityOptions.toBundle or , 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 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 startRenderer(): Unit

Starts the SceneCore renderer.

fun stopRenderer(): Unit

Stops the SceneCore renderer.

fun unpersistAnchor(uuid: UUID): Boolean

Unpersist an AnchorEntity. It will clean up the data in the storage that is required to retrieve the anchor. Returns whether the anchor was successfully unpersisted.