FakeJxrPlatformAdapter

public void addSpatialCapabilitiesChangedListener(
    @NonNull Executor callbackExecutor,
    @NonNull Consumer<@NonNull SpatialCapabilities> listener
)

Adds the given {@link Consumer} as a listener to be invoked when this Session's current SpatialCapabilities change. {@link Consumer#accept(SpatialCapabilities)} will be invoked on the given Executor.

public TextureResource borrowReflectionTexture()

Borrows the reflection texture from the currently set environment IBL.

public void clearSpatialVisibilityChangedListener()

Releases the listener previously added by setSpatialVisibilityChangedListener.

public @NonNull ActivityPanelEntity createActivityPanelEntity(
    @NonNull Pose pose,
    @NonNull PixelDimensions windowBoundsPx,
    @NonNull String name,
    @NonNull Activity hostActivity,
    @NonNull Entity parent
)

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

public @NonNull AnchorEntity createAnchorEntity(@NonNull Anchor anchor)

A factory function to create an Anchor entity from a {@link androidx.xr.runtime.internal.Anchor}.

public @NonNull AnchorEntity createAnchorEntity(
    @NonNull Dimensions bounds,
    @NonNull PlaneType planeType,
    @NonNull PlaneSemantic planeSemantic,
    @NonNull Duration searchTimeout
)

A factory function to create an Anchor entity.

public @NonNull AnchorPlacement createAnchorPlacementForPlanes(
    @NonNull Set<@NonNull PlaneType> planeTypeFilter,
    @NonNull Set<@NonNull PlaneSemantic> planeSemanticFilter
)

Creates an instance of an AnchorPlacement object.

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

public @NonNull Entity createEntity(@NonNull Pose pose, @NonNull String name, @NonNull Entity parent)

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.

public @NonNull GltfEntity createGltfEntity(
    @NonNull Pose pose,
    @NonNull GltfModelResource loadedGltf,
    @NonNull Entity parentEntity
)

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

public @NonNull InteractableComponent createInteractableComponent(
    @NonNull Executor executor,
    @NonNull InputEventListener listener
)

Create an Interactable component.

public @NonNull LoggingEntity createLoggingEntity(@NonNull Pose pose)

A function to create a XR Runtime Entity.

public @NonNull MovableComponent createMovableComponent(
    boolean systemMovable,
    boolean scaleInZ,
    @NonNull Set<@NonNull AnchorPlacement> anchorPlacement,
    boolean shouldDisposeParentAnchor
)

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

public @NonNull PanelEntity createPanelEntity(
    @NonNull Context context,
    @NonNull Pose pose,
    @NonNull View view,
    @NonNull Dimensions dimensions,
    @NonNull String name,
    @NonNull Entity parent
)

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

public @NonNull PanelEntity createPanelEntity(
    @NonNull Context context,
    @NonNull Pose pose,
    @NonNull View view,
    @NonNull PixelDimensions pixelDimensions,
    @NonNull String name,
    @NonNull Entity parent
)

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

public @NonNull AnchorEntity createPersistedAnchorEntity(
    @NonNull UUID uuid,
    @NonNull Duration searchTimeout
)

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

public @NonNull PointerCaptureComponent createPointerCaptureComponent(
    @NonNull Executor executor,
    @NonNull PointerCaptureComponent.StateListener stateListener,
    @NonNull InputEventListener inputListener
)

Create an instance of {@link 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.

public @NonNull ResizableComponent createResizableComponent(
    @NonNull Dimensions minimumSize,
    @NonNull Dimensions maximumSize
)

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

public @NonNull SubspaceNodeEntity createSubspaceNodeEntity(
    @NonNull SubspaceNode subspaceNode,
    @NonNull Dimensions size
)

A factory function to create a SubspaceNodeEntity.

public @NonNull SurfaceEntity createSurfaceEntity(
    int stereoMode,
    @NonNull SurfaceEntity.CanvasShape canvasShape,
    @NonNull Pose pose,
    @NonNull Entity parentEntity
)

A factory function for an Entity which displays drawable surfaces.

public ListenableFuture<@NonNull MaterialResource> createWaterMaterial(boolean isAlphaMapVersion)

Creates a water material by querying it from the system's built-in materials. The future returned by this method will fire listeners on the UI thread if Runnable::run is supplied.

public void destroyTexture(@NonNull TextureResource texture)

Destroys the given texture resource.

public void destroyWaterMaterial(@NonNull MaterialResource material)

Destroys the given water material resource.

public void dispose()

Disposes of the resources used by the platform adapter.

public @NonNull ActivitySpace getActivitySpace()

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

public @NonNull Entity getActivitySpaceRootImpl()

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.

public @NonNull AudioTrackExtensionsWrapper getAudioTrackExtensionsWrapper()

Returns a AudioTrackExtensionsWrapper instance.

public CameraViewActivityPose getCameraViewActivityPose(int cameraType)

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

public HeadActivityPose getHeadActivityPose()

Returns the HeadActivityPose for the session or null if it not ready.

public @NonNull PanelEntity getMainPanelEntity()

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

public @NonNull MediaPlayerExtensionsWrapper getMediaPlayerExtensionsWrapper()

Returns a MediaPlayerExtensionsWrapper instance.

public @NonNull PerceptionSpaceActivityPose getPerceptionSpaceActivityPose()

Returns the PerceptionSpaceActivityPose for the Session.

public TextureResource getReflectionTextureFromIbl(@NonNull ExrImageResource iblToken)

Returns the reflection texture from the given IBL.

public @NonNull SoundPoolExtensionsWrapper getSoundPoolExtensionsWrapper()

Returns a SoundPoolExtensionsWrapper instance.

public @NonNull SpatialCapabilities getSpatialCapabilities()

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

public @NonNull SpatialEnvironment getSpatialEnvironment()

Returns the Environment for the Session.

public @NonNull ListenableFuture<@NonNull ExrImageResource> loadExrImageByAssetName(@NonNull String assetName)

Loads an ExrImage for the given asset name from the assets folder using the Split Engine route.

public @NonNull ListenableFuture<@NonNull ExrImageResource> loadExrImageByByteArray(
    @NonNull byte[] assetData,
    @NonNull String assetKey
)

Loads an ExrImage from a provided byte array using the Split Engine route.

public @NonNull ListenableFuture<@NonNull GltfModelResource> loadGltfByAssetName(@NonNull String assetName)

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.

public @NonNull ListenableFuture<@NonNull GltfModelResource> loadGltfByByteArray(@NonNull byte[] assetData, @NonNull String assetKey)

Loads glTF Asset from a provided byte array. The future returned by this method will fire listeners on the UI thread if Runnable::run is supplied.

public ListenableFuture<@NonNull TextureResource> loadTexture(@NonNull String assetName, @NonNull TextureSampler sampler)

Loads a texture resource for the given asset name or URL. The future returned by this method will fire listeners on the UI thread if Runnable::run is supplied.

public void removeSpatialCapabilitiesChangedListener(
    @NonNull Consumer<@NonNull SpatialCapabilities> listener
)

Releases the given {@link Consumer} from receiving updates when the Session's {@link SpatialCapabilities} change.

public void requestFullSpaceMode()

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

public void requestHomeSpaceMode()

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

public void setAlphaMap(
    @NonNull MaterialResource material,
    @NonNull TextureResource alphaMap
)

Sets the alpha map for the water material.

public void setAlphaStepMultiplier(
    @NonNull MaterialResource material,
    float alphaStepMultiplier
)

Sets the alpha step multiplier for the water material.

public @NonNull Bundle setFullSpaceMode(@NonNull Bundle bundle)

Sets the full space mode flag to the given {@link Bundle}.

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

The flag will be ignored when no {@link 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 {@link 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.

public @NonNull Bundle setFullSpaceModeWithEnvironmentInherited(@NonNull Bundle bundle)

Sets the inherit full space mode environment flag to the given {@link Bundle}.

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

public void setNormalBoundary(
    @NonNull MaterialResource material,
    float normalBoundary
)

Sets the normal boundary for the water material.

public void setNormalMap(
    @NonNull MaterialResource material,
    @NonNull TextureResource normalMap
)

Sets the normal map texture for the water material.

public void setNormalSpeed(@NonNull MaterialResource material, float normalSpeed)

Sets the normal speed for the water material.

public void setNormalTiling(@NonNull MaterialResource material, float normalTiling)

Sets the normal tiling for the water material.

public void setNormalZ(@NonNull MaterialResource material, float normalZ)

Sets the normal z for the water material.

public void setPreferredAspectRatio(@NonNull Activity activity, float preferredRatio)

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.

If the activity's current aspect ratio differs from the {@code preferredRatio}, the panel is automatically resized. This resizing preserves the panel's area. To avoid runtime resizing, consider specifying the desired aspect ratio in your {@code AndroidManifest.xml}. This ensures your activity launches with the preferred aspect ratio from the start.

public void setReflectionCube(
    @NonNull MaterialResource material,
    @NonNull TextureResource reflectionCube
)

Sets the reflection cube texture for the water material.

public void setSpatialVisibilityChangedListener(
    @NonNull Executor callbackExecutor,
    @NonNull Consumer<@NonNull SpatialVisibility> listener
)

Sets the listener to be invoked when the spatial visibility of the rendered content of the entire scene (all entities, including children of anchors and activitySpace) changes within the user's field of view.

This API only checks if the bounds of the renderable content are within the user's field of view. It does not check if the rendered content is visible to the user. For example, if the user is looking straight ahead, and there's only a single invisible child entity (alpha = 0) in front of the user, this API will return SpatialVisibility.WITHIN_FOV even though the user cannot see anything.

The listener is invoked on the provided executor. If the app intends to modify the UI elements/views during the callback, the app should provide the thread executor that is appropriate for the UI operations. For example, if the app is using the main thread to render the UI, the app should provide the main thread (Looper.getMainLooper()) executor. If the app is using a separate thread to render the UI, the app should provide the executor for that thread.

There can only be one listener set at a time. If a new listener is set, the previous listener will be released.

public void startRenderer()

Starts the renderer.

public void stopRenderer()

Stops the renderer.