androidx.xr.scenecore


Interfaces

ActivityPose

Interface for a ActivityPose.

Component

Base interface for all components.

Entity

Interface for a spatial Entity.

Image

Interface for image formats in SceneCore.

InputEventListener

Listener for InputEvents.

JxrPlatformAdapter

Interface for SceneCore Platform operations.

JxrPlatformAdapter.ActivityPanelEntity

Interface for a SceneCore ActivityPanel entity.

JxrPlatformAdapter.ActivityPose

Interface for a SceneCore ActivityPose

JxrPlatformAdapter.ActivitySpace

Interface for a SceneCore activity space.

JxrPlatformAdapter.ActivitySpace.OnBoundsChangedListener

Interface for a listener which receives changes to the bounds of the primary Activity.

JxrPlatformAdapter.AnchorEntity

Interface for Anchor entity.

JxrPlatformAdapter.AnchorEntity.OnStateChangedListener

Interface for listening to Anchor state changes.

JxrPlatformAdapter.AnchorEntity.PersistStateChangeListener

Interface for listening to Anchor persist state changes.

JxrPlatformAdapter.AnchorPlacement

Interface for an AnchorPlacement.

JxrPlatformAdapter.AudioTrackExtensionsWrapper

Interface for a SceneCore AudioTrackExtensionsWrapper

JxrPlatformAdapter.CameraViewActivityPose

Interface for a SceneCore camera view ActivityPose.

JxrPlatformAdapter.Component

Base interface for all components.

JxrPlatformAdapter.Entity

Interface for a SceneCore Entity

JxrPlatformAdapter.ExrImageResource

Interface for an EXR resource.

JxrPlatformAdapter.GltfEntity

Interface for a SceneCore [GltfEntity].

JxrPlatformAdapter.GltfModelResource

Interface for a glTF resource.

JxrPlatformAdapter.HeadActivityPose

Interface for a SceneCore head ActivityPose.

JxrPlatformAdapter.InputEventListener

Interface for Input listener.

JxrPlatformAdapter.InteractableComponent

Component to enable input interactions.

JxrPlatformAdapter.LoggingEntity

Interface for a SceneCore Entity that only logs the pose.

JxrPlatformAdapter.MediaPlayerExtensionsWrapper

Interface for a SceneCore MediaPlayerExtensionsWrapper

JxrPlatformAdapter.MovableComponent

Component to enable a high level user movement affordance.

JxrPlatformAdapter.MoveEventListener

Interface for MoveEvent listener.

JxrPlatformAdapter.PanelEntity

Interface for a SceneCore Panel entity

JxrPlatformAdapter.PerceptionSpaceActivityPose

Interface for the perception space ActivityPose.

JxrPlatformAdapter.PointerCaptureComponent

Component to enable pointer capture.

JxrPlatformAdapter.PointerCaptureComponent.StateListener

Functional interface for receiving updates about the state of pointer capture.

JxrPlatformAdapter.ResizableComponent

Component to enable resize semantics.

JxrPlatformAdapter.ResizeEventListener

Interface for ResizeEvent listener.

JxrPlatformAdapter.Resource

Interface for a SceneCore resource.

JxrPlatformAdapter.SoundPoolExtensionsWrapper

Interface for a SceneCore SoundPoolExtensionsWrapper.

JxrPlatformAdapter.SpatialEnvironment

Interface for updating the background image/geometry and passthrough settings.

JxrPlatformAdapter.StereoSurfaceEntity

Interface for a surface which images can be rendered into.

JxrPlatformAdapter.SystemSpaceEntity

Interface for a system-controlled SceneCore Entity that defines its own coordinate space.

JxrPlatformAdapter.SystemSpaceEntity.OnSpaceUpdatedListener

Interface for a listener which receives changes to the underlying space.

Model

Represents a 3D model in SceneCore.

MoveListener

Listener for move actions.

OnBoundsChangeListener

This interface is deprecated. Use addBoundsChangedListener(Consumer<Dimensions>)

OnSpaceUpdatedListener
OnStateChangedListener
PointerCaptureComponent.StateListener

Listener for pointer capture state changes.

ResizeListener

Listener for resize actions.

SpatializerConstants

Constants for spatialized audio.

Classes

ActivityPanelEntity

ActivityPanelEntity creates a spatial panel for embedding an Activity in Android XR.

ActivitySpace

ActivitySpace is an Entity used to track the system-managed pose and boundary of the volume associated with this Spatialized Activity.

AnchorEntity

An AnchorEntity is created to track a Pose relative to some position or surface in the "Real World." Children of this Entity will remain positioned relative to that location in the real world, for the purposes of creating Augmented Reality experiences.

AnchorPlacement

Creates an AnchorPlacement for a MovableComponent.

BaseActivityPose

The BaseActivityPose is an implementation of ActivityPose interface that wraps a platformAdapter ActivityPose.

BaseEntity

The BaseEntity is an implementation of Entity interface that wraps a platform entity.

BasePanelEntity

Provides implementations for common Panel functionality.

CameraView

A ActivityPose which tracks a camera's position and view into physical space.

ContentlessEntity

An Entity that itself has no content.

Dimensions

Dimensions of a 3D object.

ExrImage

ExrImage represents an EXR Image resource in SceneCore.

Fov

The angles (in radians) representing the sides of the view frustum.

GltfModel

GltfModel represents a glTF resource in SceneCore.

GltfModelEntity

GltfModelEntity is a concrete implementation of Entity that hosts a glTF model.

Head

Head is a ActivityPose used to track the position of the user's head.

InputEvent

Defines input events for XRCore.

InputEvent.HitInfo

Information about the hit result of the ray.

InteractableComponent

Provides access to raw input events for given Entity, so a client can implement their own interaction logic.

JxrPlatformAdapter.CameraViewActivityPose.Fov

The angles (in radians) representing the sides of the view frustum.

JxrPlatformAdapter.Dimensions

The dimensions of a UI element in meters.

JxrPlatformAdapter.InputEvent

InputEvent for SceneCore Platform.

JxrPlatformAdapter.InputEvent.HitInfo

Info about the hit result of the ray.

JxrPlatformAdapter.MoveEvent

MoveEvent for SceneCore Platform.

JxrPlatformAdapter.PixelDimensions

The dimensions of a UI element in pixels.

JxrPlatformAdapter.PointSourceAttributes

Represents a SceneCore PointSourceAttributes

JxrPlatformAdapter.Ray

Ray in 3D Cartesian space.

JxrPlatformAdapter.ResizeEvent

ResizeEvent for SceneCore Platform.

JxrPlatformAdapter.SoundFieldAttributes

Represents a SceneCore SoundFieldAttributes

JxrPlatformAdapter.SpatialCapabilities

Spatial Capabilities for SceneCore Platform.

JxrPlatformAdapter.SpatialEnvironment.SpatialEnvironmentPreference

A class that represents the user's preferred spatial environment.

JxrPlatformAdapter.SpatializerConstants

Contains the constants used to spatialize audio in SceneCore.

MovableComponent

Allows users to interactively move the Entity.

PanelEntity

PanelEntity creates a spatial panel in Android XR.

PerceptionSpace

PerceptionSpace is ActivityPose used to track the origin of the space used by ARCore for XR APIs.

PixelDimensions

Dimensions of a 2D surface in Pixels.

PointSourceAttributes

PointSourceAttributes is used to configure a sound be spatialized as a 3D point.

PointerCaptureComponent

Provides pointer capture capabilities for a given entity.

ResizableComponent

A Component which when attached to a PanelEntity provides a user-resize affordance.

Session

The Session provides the primary interface to SceneCore functionality for the application.

SoundFieldAttributes

Configures ambisonics sound sources.

SpatialAudioTrack
SpatialAudioTrackBuilder

Provides spatial audio extensions on the platform AudioTrack.Builder class.

SpatialCapabilities

Representation of the spatial capabilities of the current session.

SpatialEnvironment

The SpatialEnvironment is used to manage the XR background and passthrough.

SpatialEnvironment.PassthroughMode

This class is deprecated. Use isSpatialEnvironmentPreferenceActive() instead.

SpatialEnvironment.SetPassthroughOpacityPreferenceChangeApplied

The call to setPassthroughOpacityPreference succeeded and should now be visible.

SpatialEnvironment.SetPassthroughOpacityPreferenceChangePending

The call to setPassthroughOpacityPreference successfully applied the preference, but it is not immediately visible due to requesting a state change while the activity does not have the SpatialCapabilities.SPATIAL_CAPABILITY_PASSTHROUGH_CONTROL capability to control the app passthrough state.

SpatialEnvironment.SetPassthroughOpacityPreferenceResult

Result values for calls to setPassthroughOpacityPreference

SpatialEnvironment.SetSpatialEnvironmentPreferenceChangeApplied

The call to setSpatialEnvironmentPreference succeeded and should now be visible.

SpatialEnvironment.SetSpatialEnvironmentPreferenceChangePending

The call to setSpatialEnvironmentPreference successfully applied the preference, but it is not immediately visible due to requesting a state change while the activity does not have the SpatialCapabilities.SPATIAL_CAPABILITY_APP_ENVIRONMENTS capability to control the app environment state.

SpatialEnvironment.SetSpatialEnvironmentPreferenceResult

Result values for calls to SpatialEnvironment.setSpatialEnvironmentPreference

SpatialEnvironment.SpatialEnvironmentPreference

Represents the preferred spatial environment for the application.

SpatialMediaPlayer
SpatialSoundPool

Provides spatial audio extensions on the framework SoundPool class.

SpatialUser

The User object is used to retrieve information about the user.

StereoSurfaceEntity

StereoSurfaceEntity is a concrete implementation of Entity that hosts a StereoSurface Panel.

Objects

AnchorEntity.State
GltfModelEntity.AnimationState
PermissionHelper

Utility class for handling Android permissions.

PlaneSemantic

Semantic plane types.

PlaneType

Type of plane based on orientation i.e. Horizontal or Vertical.

StereoSurfaceEntity.StereoMode

Enums

AnchorEntity.PersistState

Specifies the current persist state of the Anchor.

CameraView.CameraType

Describes the type of camera that this CameraView represents.

JxrPlatformAdapter.AnchorEntity.PersistState

Specifies the current persistence state of the Anchor.

JxrPlatformAdapter.AnchorEntity.State

Specifies the current tracking state of the Anchor.

JxrPlatformAdapter.PlaneSemantic

Semantic plane types.

JxrPlatformAdapter.PlaneType

Type of plane based on orientation i.e. Horizontal or Vertical.

JxrPlatformAdapter.SpatialEnvironment.SetPassthroughOpacityPreferenceResult

Result values for calls to SpatialEnvironment.setPassthroughOpacityPreference

JxrPlatformAdapter.SpatialEnvironment.SetSpatialEnvironmentPreferenceResult

Result values for calls to SpatialEnvironment.setSpatialEnvironmentPreference