JxrPlatformAdapter
public interface JxrPlatformAdapter
Interface for SceneCore Platform operations. This is not intended to be used by Applications.
Summary
Nested types |
|---|
public interface JxrPlatformAdapter.ActivityPanelEntity extends JxrPlatformAdapter.PanelEntityInterface for a SceneCore ActivityPanel entity. |
public interface JxrPlatformAdapter.ActivityPoseInterface for a SceneCore ActivityPose |
public interface JxrPlatformAdapter.ActivitySpace extends JxrPlatformAdapter.SystemSpaceEntityInterface for a SceneCore activity space. |
public interface JxrPlatformAdapter.ActivitySpace.OnBoundsChangedListenerInterface for a listener which receives changes to the bounds of the primary Activity. |
public interface JxrPlatformAdapter.AnchorEntity extends JxrPlatformAdapter.SystemSpaceEntityInterface for Anchor entity. |
public interface JxrPlatformAdapter.AnchorEntity.OnStateChangedListenerInterface for listening to Anchor state changes. |
public enum JxrPlatformAdapter.AnchorEntity.PersistStateSpecifies the current persistence state of the Anchor. |
public interface JxrPlatformAdapter.AnchorEntity.PersistStateChangeListenerInterface for listening to Anchor persist state changes. |
public enum JxrPlatformAdapter.AnchorEntity.StateSpecifies the current tracking state of the Anchor. |
public interface JxrPlatformAdapter.AnchorPlacementInterface for an AnchorPlacement. |
public interface JxrPlatformAdapter.AudioTrackExtensionsWrapperInterface for a SceneCore AudioTrackExtensionsWrapper |
public interface JxrPlatformAdapter.CameraViewActivityPose extends JxrPlatformAdapter.ActivityPoseInterface for a SceneCore camera view ActivityPose. |
public class JxrPlatformAdapter.CameraViewActivityPose.FovThe angles (in radians) representing the sides of the view frustum. |
public interface JxrPlatformAdapter.ComponentBase interface for all components. |
public class JxrPlatformAdapter.DimensionsThe dimensions of a UI element in meters. |
public interface JxrPlatformAdapter.Entity extends JxrPlatformAdapter.ActivityPoseInterface for a SceneCore Entity |
public interface JxrPlatformAdapter.ExrImageResource extends JxrPlatformAdapter.ResourceInterface for an EXR resource. |
public interface JxrPlatformAdapter.GltfEntity extends JxrPlatformAdapter.EntityInterface for a SceneCore [GltfEntity]. |
public interface JxrPlatformAdapter.GltfModelResource extends JxrPlatformAdapter.ResourceInterface for a glTF resource. |
public interface JxrPlatformAdapter.HeadActivityPose extends JxrPlatformAdapter.ActivityPoseInterface for a SceneCore head ActivityPose. |
public class JxrPlatformAdapter.InputEventInputEvent for SceneCore Platform. |
public class JxrPlatformAdapter.InputEvent.HitInfoInfo about the hit result of the ray. |
@FunctionalInterfaceInterface for Input listener. |
public interface JxrPlatformAdapter.InteractableComponent extends JxrPlatformAdapter.ComponentComponent to enable input interactions. |
public interface JxrPlatformAdapter.LoggingEntity extends JxrPlatformAdapter.EntityInterface for a SceneCore Entity that only logs the pose. |
public interface JxrPlatformAdapter.MediaPlayerExtensionsWrapperInterface for a SceneCore MediaPlayerExtensionsWrapper |
public interface JxrPlatformAdapter.MovableComponent extends JxrPlatformAdapter.ComponentComponent to enable a high level user movement affordance. |
public class JxrPlatformAdapter.MoveEventMoveEvent for SceneCore Platform. |
@FunctionalInterfaceInterface for MoveEvent listener. |
public interface JxrPlatformAdapter.PanelEntity extends JxrPlatformAdapter.EntityInterface for a SceneCore Panel entity |
public interface JxrPlatformAdapter.PerceptionSpaceActivityPose extends JxrPlatformAdapter.ActivityPoseInterface for the perception space ActivityPose. |
public class JxrPlatformAdapter.PixelDimensionsThe dimensions of a UI element in pixels. |
public enum JxrPlatformAdapter.PlaneSemanticSemantic plane types. |
public enum JxrPlatformAdapter.PlaneTypeType of plane based on orientation i.e. Horizontal or Vertical. |
public class JxrPlatformAdapter.PointSourceAttributesRepresents a SceneCore PointSourceAttributes |
public interface JxrPlatformAdapter.PointerCaptureComponent extends JxrPlatformAdapter.ComponentComponent to enable pointer capture. |
public interface JxrPlatformAdapter.PointerCaptureComponent.StateListenerFunctional interface for receiving updates about the state of pointer capture. |
public class JxrPlatformAdapter.RayRay in 3D Cartesian space. |
public interface JxrPlatformAdapter.ResizableComponent extends JxrPlatformAdapter.ComponentComponent to enable resize semantics. |
public class JxrPlatformAdapter.ResizeEventResizeEvent for SceneCore Platform. |
@FunctionalInterfaceInterface for ResizeEvent listener. |
public interface JxrPlatformAdapter.ResourceInterface for a SceneCore resource. |
public class JxrPlatformAdapter.SoundFieldAttributesRepresents a SceneCore SoundFieldAttributes |
public interface JxrPlatformAdapter.SoundPoolExtensionsWrapperInterface for a SceneCore SoundPoolExtensionsWrapper. |
public class JxrPlatformAdapter.SpatialCapabilitiesSpatial Capabilities for SceneCore Platform. |
public interface JxrPlatformAdapter.SpatialEnvironmentInterface for updating the background image/geometry and passthrough settings. |
|
Result values for calls to SpatialEnvironment.setPassthroughOpacityPreference |
|
Result values for calls to SpatialEnvironment.setSpatialEnvironmentPreference |
|
A class that represents the user's preferred spatial environment. |
public final class JxrPlatformAdapter.SpatializerConstantsContains the constants used to spatialize audio in SceneCore. |
public interface JxrPlatformAdapter.StereoSurfaceEntity extends JxrPlatformAdapter.EntityInterface for a surface which images can be rendered into. |
public interface JxrPlatformAdapter.SystemSpaceEntity extends JxrPlatformAdapter.EntityInterface for a system-controlled SceneCore Entity that defines its own coordinate space. |
|
Interface for a listener which receives changes to the underlying space. |
Public methods |
|
|---|---|
abstract void |
addSpatialCapabilitiesChangedListener(Adds the given |
abstract @NonNull JxrPlatformAdapter.ActivityPanelEntity |
createActivityPanelEntity(Factory function to create ActivityPanel to launch/move activity into. |
abstract @NonNull JxrPlatformAdapter.AnchorEntity |
createAnchorEntity(@NonNull Anchor anchor)A factory function to create an Anchor entity from a |
abstract @NonNull JxrPlatformAdapter.AnchorEntity |
createAnchorEntity(A factory function to create an Anchor entity. |
abstract @NonNull JxrPlatformAdapter.AnchorPlacement |
createAnchorPlacementForPlanes(Creates an instance of an AnchorPlacement object. |
abstract @NonNull JxrPlatformAdapter.Entity |
createEntity(A factory function to create a content-less entity. |
abstract @NonNull JxrPlatformAdapter.GltfEntity |
createGltfEntity(A factory function to create a SceneCore GltfEntity. |
abstract @NonNull JxrPlatformAdapter.InteractableComponent |
createInteractableComponent(Create an Interactable component. |
abstract @NonNull JxrPlatformAdapter.LoggingEntity |
createLoggingEntity(@NonNull Pose pose)A function to create a SceneCore Entity |
abstract @NonNull JxrPlatformAdapter.MovableComponent |
createMovableComponent(Create an instance of [MovableComponent]. |
abstract @NonNull JxrPlatformAdapter.PanelEntity |
createPanelEntity(A factory function to create a platform PanelEntity. |
abstract @NonNull JxrPlatformAdapter.AnchorEntity |
createPersistedAnchorEntity(A factory function to recreate an Anchor entity which was persisted in a previous session. |
abstract @NonNull JxrPlatformAdapter.PointerCaptureComponent |
createPointerCaptureComponent(Create an instance of |
abstract @NonNull JxrPlatformAdapter.ResizableComponent |
createResizableComponent(Create an instance of [ResizableComponent]. |
abstract @NonNull JxrPlatformAdapter.StereoSurfaceEntity |
createStereoSurfaceEntity(A factory function for an Entity which displays drawable surfaces. |
abstract void |
dispose()Disposes of the resources used by the platform adapter. |
abstract @NonNull JxrPlatformAdapter.ActivitySpace |
Returns the Activity Space entity at the root of the scene. |
abstract @NonNull JxrPlatformAdapter.Entity |
Returns the entity that represents the ActivitySpace root. |
abstract @NonNull JxrPlatformAdapter.AudioTrackExtensionsWrapper |
Returns an [AudioTrackExtensionssWrapper] instance. |
abstract @Nullable JxrPlatformAdapter.CameraViewActivityPose |
getCameraViewActivityPose(int cameraType)Returns the CameraViewActivityPose for the specified camera type or null if it is not ready/available. |
abstract @Nullable JxrPlatformAdapter.HeadActivityPose |
Returns the HeadActivityPose for the Session or null if it is not ready |
abstract @NonNull JxrPlatformAdapter.PanelEntity |
Get the PanelEntity associated with the main window for the Activity. |
abstract @NonNull JxrPlatformAdapter.MediaPlayerExtensionsWrapper |
Returns a [MediaPlayerExtensionsWrapper] instance. |
abstract @NonNull JxrPlatformAdapter.PerceptionSpaceActivityPose |
Returns the PerceptionSpaceActivityPose for the Session. |
abstract @NonNull JxrPlatformAdapter.SoundPoolExtensionsWrapper |
Returns a [SoundPoolExtensionsWrapper] instance. |
abstract @NonNull JxrPlatformAdapter.SpatialCapabilities |
Return the Spatial Capabilities set that are currently supported by the platform. |
abstract @NonNull JxrPlatformAdapter.SpatialEnvironment |
Returns the Environment for the Session. |
abstract @Nullable ListenableFuture<JxrPlatformAdapter.ExrImageResource> |
loadExrImageByAssetName(@NonNull String assetName)Loads an ExrImage for the given asset name from the assets folder. |
abstract @Nullable ListenableFuture<JxrPlatformAdapter.GltfModelResource> |
loadGltfByAssetName(@NonNull String assetName)Loads glTF Asset for the given asset name from the assets folder. |
abstract @Nullable ListenableFuture<JxrPlatformAdapter.GltfModelResource> |
loadGltfByAssetNameSplitEngine(@NonNull String assetName)Loads glTF Asset for the given asset name from the assets folder using the Split Engine route. |
abstract void |
removeSpatialCapabilitiesChangedListener(Releases the given |
abstract void |
If the primary Activity for this Session has focus, causes it to be placed in FullSpace Mode. |
abstract void |
If the primary Activity for this Session has focus, causes it to be placed in HomeSpace Mode. |
abstract @NonNull Bundle |
setFullSpaceMode(@NonNull Bundle bundle)Sets the full space mode flag to the given |
abstract @NonNull Bundle |
Sets the inherit full space mode environment flag to the given |
abstract void |
setPreferredAspectRatio(@NonNull Activity activity, float preferredRatio)Sets a preferred main panel aspect ratio for home space mode. |
abstract void |
Starts the SceneCore renderer. |
abstract void |
Stops the SceneCore renderer. |
abstract boolean |
unpersistAnchor(@NonNull UUID uuid)Unpersist an AnchorEntity. |
Public methods
addSpatialCapabilitiesChangedListener
abstract void addSpatialCapabilitiesChangedListener(
@NonNull Executor callbackExecutor,
@NonNull Consumer<JxrPlatformAdapter.SpatialCapabilities> listener
)
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.
createActivityPanelEntity
abstract @NonNull JxrPlatformAdapter.ActivityPanelEntity createActivityPanelEntity(
@NonNull Pose pose,
@NonNull JxrPlatformAdapter.PixelDimensions windowBoundsPx,
@NonNull String name,
@NonNull Activity hostActivity,
@NonNull JxrPlatformAdapter.Entity parent
)
Factory function to create ActivityPanel to launch/move activity into.
| Parameters | |
|---|---|
@NonNull Pose pose |
Initial pose of the panel. |
@NonNull JxrPlatformAdapter.PixelDimensions windowBoundsPx |
Boundary for the window |
@NonNull String name |
Name of the panel. |
@NonNull Activity hostActivity |
Activity to host the panel. |
@NonNull JxrPlatformAdapter.Entity parent |
Parent entity. |
createAnchorEntity
abstract @NonNull JxrPlatformAdapter.AnchorEntity createAnchorEntity(@NonNull Anchor anchor)
A factory function to create an Anchor entity from a androidx.xr.arcore.Anchor.
| Parameters | |
|---|---|
@NonNull Anchor anchor |
The |
createAnchorEntity
abstract @NonNull JxrPlatformAdapter.AnchorEntity createAnchorEntity(
@NonNull JxrPlatformAdapter.Dimensions bounds,
@NonNull JxrPlatformAdapter.PlaneType planeType,
@NonNull JxrPlatformAdapter.PlaneSemantic planeSemantic,
@NonNull Duration searchTimeout
)
A factory function to create an Anchor entity.
| Parameters | |
|---|---|
@NonNull JxrPlatformAdapter.Dimensions bounds |
Bounds for this Anchor. |
@NonNull JxrPlatformAdapter.PlaneType planeType |
Orientation of the plane to which this anchor should attach. |
@NonNull JxrPlatformAdapter.PlaneSemantic planeSemantic |
Semantic type of the plane to which this anchor should attach. |
@NonNull Duration searchTimeout |
How long to search for an anchor. If this is Duration.ZERO, this will search for an anchor indefinitely. |
createAnchorPlacementForPlanes
abstract @NonNull JxrPlatformAdapter.AnchorPlacement createAnchorPlacementForPlanes(
@NonNull Set<JxrPlatformAdapter.PlaneType> planeTypeFilter,
@NonNull Set<JxrPlatformAdapter.PlaneSemantic> planeSemanticFilter
)
Creates an instance of an AnchorPlacement object.
This can be used in movable components to specify the anchor placement for the entity.
| Parameters | |
|---|---|
@NonNull Set<JxrPlatformAdapter.PlaneType> planeTypeFilter |
A set of plane types to filter for. |
@NonNull Set<JxrPlatformAdapter.PlaneSemantic> planeSemanticFilter |
A set of plane semantics to filter for. |
| Returns | |
|---|---|
@NonNull JxrPlatformAdapter.AnchorPlacement |
[AnchorPlacement] instance. |
createEntity
abstract @NonNull JxrPlatformAdapter.Entity createEntity(
@NonNull Pose pose,
@NonNull String name,
@NonNull JxrPlatformAdapter.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.
createGltfEntity
abstract @NonNull JxrPlatformAdapter.GltfEntity createGltfEntity(
@NonNull Pose pose,
@NonNull JxrPlatformAdapter.GltfModelResource loadedGltf,
@Nullable JxrPlatformAdapter.Entity parentEntity
)
A factory function to create a SceneCore GltfEntity. The parent may be the activity space or GltfEntity in the scene.
createInteractableComponent
abstract @NonNull JxrPlatformAdapter.InteractableComponent createInteractableComponent(
@NonNull Executor executor,
@NonNull JxrPlatformAdapter.InputEventListener listener
)
Create an Interactable component.
| Parameters | |
|---|---|
@NonNull Executor executor |
Executor to use for input callbacks. |
@NonNull JxrPlatformAdapter.InputEventListener listener |
[JxrPlatformAdapter.InputEventListener] for this component. |
| Returns | |
|---|---|
@NonNull JxrPlatformAdapter.InteractableComponent |
InteractableComponent instance. |
createLoggingEntity
abstract @NonNull JxrPlatformAdapter.LoggingEntity createLoggingEntity(@NonNull Pose pose)
A function to create a SceneCore Entity
createMovableComponent
abstract @NonNull JxrPlatformAdapter.MovableComponent createMovableComponent(
boolean systemMovable,
boolean scaleInZ,
@NonNull Set<JxrPlatformAdapter.AnchorPlacement> anchorPlacement,
boolean shouldDisposeParentAnchor
)
Create an instance of [MovableComponent]. This component allows the user to move the entity.
| Parameters | |
|---|---|
boolean systemMovable |
A [boolean] which causes the system to automatically apply transform updates to the entity in response to user interaction. |
boolean scaleInZ |
A [boolean] which tells the system to update the scale of the Entity as the user moves it closer and further away. This is mostly useful for Panel auto-rescaling with Distance |
@NonNull Set<JxrPlatformAdapter.AnchorPlacement> anchorPlacement |
AnchorPlacement information for when to anchor the entity. |
boolean shouldDisposeParentAnchor |
A [boolean] which tells the system to dispose of the parent anchor if that entity was created by the moveable component and is moved off of it. |
| Returns | |
|---|---|
@NonNull JxrPlatformAdapter.MovableComponent |
[MovableComponent] instance. |
createPanelEntity
abstract @NonNull JxrPlatformAdapter.PanelEntity createPanelEntity(
@NonNull Pose pose,
@NonNull View view,
@NonNull JxrPlatformAdapter.PixelDimensions surfaceDimensionsPx,
@NonNull JxrPlatformAdapter.Dimensions dimensions,
@NonNull String name,
@NonNull Context context,
@NonNull JxrPlatformAdapter.Entity parent
)
A factory function to create a platform PanelEntity. The parent can be any entity.
| Parameters | |
|---|---|
@NonNull Pose pose |
Initial pose of the panel. |
@NonNull View view |
View inflating this panel. |
@NonNull JxrPlatformAdapter.PixelDimensions surfaceDimensionsPx |
Dimensions for the underlying surface for the given view. |
@NonNull JxrPlatformAdapter.Dimensions dimensions |
Size of the panel in meters. |
@NonNull String name |
Name of the panel. |
@NonNull Context context |
Application Context. |
@NonNull JxrPlatformAdapter.Entity parent |
Parent entity. |
createPersistedAnchorEntity
abstract @NonNull JxrPlatformAdapter.AnchorEntity createPersistedAnchorEntity(
@NonNull UUID uuid,
@NonNull Duration searchTimeout
)
A factory function to recreate an Anchor entity which was persisted in a previous session.
createPointerCaptureComponent
abstract @NonNull JxrPlatformAdapter.PointerCaptureComponent createPointerCaptureComponent(
@NonNull Executor executor,
@NonNull JxrPlatformAdapter.PointerCaptureComponent.StateListener stateListener,
@NonNull JxrPlatformAdapter.InputEventListener inputListener
)
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.
| Parameters | |
|---|---|
@NonNull Executor executor |
Executor used to propagate state and input events. |
@NonNull JxrPlatformAdapter.PointerCaptureComponent.StateListener stateListener |
Callback for updates to the state of pointer capture. Pointer capture may be temporarily lost by the application for a variety of reasons and this callback will notify of when that happens. |
@NonNull JxrPlatformAdapter.InputEventListener inputListener |
Callback that will receive captured [InputEvent]s |
createResizableComponent
abstract @NonNull JxrPlatformAdapter.ResizableComponent createResizableComponent(
@NonNull JxrPlatformAdapter.Dimensions minimumSize,
@NonNull JxrPlatformAdapter.Dimensions maximumSize
)
Create an instance of [ResizableComponent]. This component allows the user to resize the entity.
| Parameters | |
|---|---|
@NonNull JxrPlatformAdapter.Dimensions minimumSize |
Minimum size constraint. |
@NonNull JxrPlatformAdapter.Dimensions maximumSize |
Maximum size constraint. |
| Returns | |
|---|---|
@NonNull JxrPlatformAdapter.ResizableComponent |
[ResizableComponent] instance. |
createStereoSurfaceEntity
abstract @NonNull JxrPlatformAdapter.StereoSurfaceEntity createStereoSurfaceEntity(
int stereoMode,
@NonNull JxrPlatformAdapter.Dimensions dimensions,
@NonNull Pose pose,
@NonNull JxrPlatformAdapter.Entity parentEntity
)
A factory function for an Entity which displays drawable surfaces.
dispose
abstract void dispose()
Disposes of the resources used by the platform adapter.
getActivitySpace
abstract @NonNull JxrPlatformAdapter.ActivitySpace getActivitySpace()
Returns the Activity Space entity at the root of the scene.
getActivitySpaceRootImpl
abstract @NonNull JxrPlatformAdapter.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.
getAudioTrackExtensionsWrapper
abstract @NonNull JxrPlatformAdapter.AudioTrackExtensionsWrapper getAudioTrackExtensionsWrapper()
Returns an [AudioTrackExtensionssWrapper] instance.
getCameraViewActivityPose
abstract @Nullable JxrPlatformAdapter.CameraViewActivityPose getCameraViewActivityPose(int cameraType)
Returns the CameraViewActivityPose for the specified camera type or null if it is not ready/available.
getHeadActivityPose
abstract @Nullable JxrPlatformAdapter.HeadActivityPose getHeadActivityPose()
Returns the HeadActivityPose for the Session or null if it is not ready
getMainPanelEntity
abstract @NonNull JxrPlatformAdapter.PanelEntity getMainPanelEntity()
Get the PanelEntity associated with the main window for the Activity.
getMediaPlayerExtensionsWrapper
abstract @NonNull JxrPlatformAdapter.MediaPlayerExtensionsWrapper getMediaPlayerExtensionsWrapper()
Returns a [MediaPlayerExtensionsWrapper] instance.
getPerceptionSpaceActivityPose
abstract @NonNull JxrPlatformAdapter.PerceptionSpaceActivityPose getPerceptionSpaceActivityPose()
Returns the PerceptionSpaceActivityPose for the Session.
getSoundPoolExtensionsWrapper
abstract @NonNull JxrPlatformAdapter.SoundPoolExtensionsWrapper getSoundPoolExtensionsWrapper()
Returns a [SoundPoolExtensionsWrapper] instance.
getSpatialCapabilities
abstract @NonNull JxrPlatformAdapter.SpatialCapabilities getSpatialCapabilities()
Return the Spatial Capabilities set that are currently supported by the platform.
getSpatialEnvironment
abstract @NonNull JxrPlatformAdapter.SpatialEnvironment getSpatialEnvironment()
Returns the Environment for the Session.
loadExrImageByAssetName
abstract @Nullable ListenableFuture<JxrPlatformAdapter.ExrImageResource> loadExrImageByAssetName(@NonNull String assetName)
Loads an ExrImage for the given asset name from the assets folder.
loadGltfByAssetName
abstract @Nullable ListenableFuture<JxrPlatformAdapter.GltfModelResource> loadGltfByAssetName(@NonNull String assetName)
Loads glTF Asset for the given asset name from the assets folder.
loadGltfByAssetNameSplitEngine
abstract @Nullable ListenableFuture<JxrPlatformAdapter.GltfModelResource> loadGltfByAssetNameSplitEngine(@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.
removeSpatialCapabilitiesChangedListener
abstract void removeSpatialCapabilitiesChangedListener(
@NonNull Consumer<JxrPlatformAdapter.SpatialCapabilities> listener
)
Releases the given Consumer from receiving updates when the Session's change.
requestFullSpaceMode
abstract void requestFullSpaceMode()
If the primary Activity for this Session has focus, causes it to be placed in FullSpace Mode. Otherwise, this call does nothing.
requestHomeSpaceMode
abstract void requestHomeSpaceMode()
If the primary Activity for this Session has focus, causes it to be placed in HomeSpace Mode. Otherwise, this call does nothing.
setFullSpaceMode
abstract @NonNull Bundle setFullSpaceMode(@NonNull 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.
setFullSpaceModeWithEnvironmentInherited
abstract @NonNull Bundle setFullSpaceModeWithEnvironmentInherited(@NonNull 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.
setPreferredAspectRatio
abstract 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.
unpersistAnchor
abstract boolean unpersistAnchor(@NonNull UUID uuid)
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.