AnchorEntity

Artifact: androidx.xr.scenecore:scenecore

View Source

Added in 1.0.0-alpha05

---

Kotlin |Java

class AnchorEntity : ScenePose, Entity

---

An AnchorEntity tracks a androidx.xr.runtime.math.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.

Note that Anchors are only relative to the "real world", and not virtual environments. Also, setting the Entity.parent property on an AnchorEntity has no effect, as the parenting of an Anchor is controlled by the system.

Summary

Nested types
object AnchorEntity.State

Public companion functions
AnchorEntity	create(session: Session, anchor: Anchor) Public factory for an AnchorEntity which uses an Anchor from ARCore for Jetpack XR.
AnchorEntity	create(     session: Session,     minimumPlaneExtents: FloatSize2d,     planeOrientation: Int,     planeSemanticType: Int,     timeout: Duration ) Factory for an AnchorEntity which searches for a real-world surface on which to anchor, from the set of tracked planes available to the perception system.

Public functions
Anchor	getAnchor(session: Session) Loads the ARCore for Jetpack XR Anchor using a Jetpack XR Runtime session.
Unit	setOnSpaceUpdatedListener(listener: Runnable?) Registers a listener to be called when the Anchor moves relative to its underlying space.
Unit	setOnSpaceUpdatedListener(executor: Executor, listener: Runnable?) Registers a listener to be called when the Anchor moves relative to its underlying space.
Unit	setOnStateChangedListener(listener: Consumer<Int>?) Registers a listener to be invoked on the main thread when the AnchorEntity's state changes, or unregisters the current listener if set to null.
Unit	setOnStateChangedListener(executor: Executor, listener: Consumer<Int>?) Registers a listener to be invoked on the given Executor when the AnchorEntity's state changes, or unregisters the current listener if set to null.

Public properties
Int	state The current tracking state for this AnchorEntity.

Inherited functions
From androidx.xr.scenecore.Entity open @FloatRange(from = 0.0, to = 1.0) Float getAlpha() Returns the alpha transparency set for this Entity. open Pose getPose() Returns the Pose for this Entity, relative to its parent. open @FloatRange(from = 0.0) Float getScale() Returns the local scale of this Entity, not inclusive of the parent's scale. open Unit setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float) Sets the alpha transparency of the Entity and its children. open Unit setPose(pose: Pose) Sets the Pose for this Entity, relative to its parent. open Unit setScale(scale: @FloatRange(from = 0.0) Float) Sets the scale of this Entity relative to its parent.
From androidx.xr.scenecore.ScenePose abstract suspend HitTestResult hitTest(origin: Vector3, direction: Vector3) Creates a hit test from the specified origin in the specified direction into the Scene. abstract suspend HitTestResult hitTest(origin: Vector3, direction: Vector3, hitTestFilter: Int) Creates a hit test from the specified origin in the specified direction into the scene. abstract Pose transformPoseTo(pose: Pose, destination: ScenePose) Returns a Pose relative to this ScenePose, transformed into a Pose relative to the destination.

Inherited properties
From androidx.xr.scenecore.ScenePose abstract Pose activitySpacePose The current Pose relative to the activity space root.

Public companion functions

create

Added in 1.0.0-alpha05

fun create(session: Session, anchor: Anchor): AnchorEntity

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

Parameters
session: Session	Session in which to create the AnchorEntity.
anchor: Anchor	The Anchor to use for this AnchorEntity.

create

Added in 1.0.0-alpha05

fun create(
    session: Session,
    minimumPlaneExtents: FloatSize2d,
    planeOrientation: Int,
    planeSemanticType: Int,
    timeout: Duration = Duration.ZERO
): AnchorEntity

Factory for an AnchorEntity which searches for a real-world surface on which to anchor, from the set of tracked planes available to the perception system.

Parameters
session: Session	Session in which to create the AnchorEntity.
minimumPlaneExtents: FloatSize2d	The minimum extents (in meters) of the plane to which this AnchorEntity should attach.
planeOrientation: Int	PlaneOrientation of the plane to which this AnchorEntity should attach.
planeSemanticType: Int	PlaneSemanticType of the plane to which this AnchorEntity should attach.
timeout: Duration = Duration.ZERO	The amount of time as a Duration to search for the a suitable plane to attach to. If a plane is not found within the timeout, the returned AnchorEntity state will be set to AnchorEntity.State.TIMEDOUT. It may take longer than the timeout period before the anchor state is updated. If the timeout duration is zero it will search for the anchor indefinitely.

Throws
kotlin.IllegalStateException	if session.config.planeTracking is set to PlaneTrackingMode.DISABLED.

Public functions

getAnchor

Added in 1.0.0-alpha05

fun getAnchor(session: Session): Anchor

Loads the ARCore for Jetpack XR Anchor using a Jetpack XR Runtime session.

Parameters
session: Session	the Jetpack XR Runtime session from which to load the Anchor.

Returns
Anchor	the ARCore for Jetpack XR Anchor corresponding to the native pointer.

setOnSpaceUpdatedListener

Added in 1.0.0-alpha05

fun setOnSpaceUpdatedListener(listener: Runnable?): Unit

Registers a listener to be called when the Anchor moves relative to its underlying space.

The callback is triggered on the default SceneCore Executor by any anchor movements such as those made by the underlying perception stack to maintain the anchor's position relative to the real world. Any cached data relative to the activity space or any other "space" should be updated when this callback is triggered.

Parameters
listener: Runnable?	The listener to register if non-null, else stops listening if null.

setOnSpaceUpdatedListener

Added in 1.0.0-alpha05

fun setOnSpaceUpdatedListener(executor: Executor, listener: Runnable?): Unit

Registers a listener to be called when the Anchor moves relative to its underlying space.

The callback is triggered on the supplied Executor by any anchor movements such as those made by the underlying perception stack to maintain the anchor's position relative to the real world. Any cached data relative to the activity space or any other "space" should be updated when this callback is triggered.

Parameters
executor: Executor	The executor to run the listener on.
listener: Runnable?	The listener to register if non-null, else stops listening if null.

setOnStateChangedListener

Added in 1.0.0-alpha05

fun setOnStateChangedListener(listener: Consumer<Int>?): Unit

Registers a listener to be invoked on the main thread when the AnchorEntity's state changes, or unregisters the current listener if set to null.

The listener will fire with the current AnchorEntity.State value immediately upon registration.

setOnStateChangedListener

Added in 1.0.0-alpha05

fun setOnStateChangedListener(executor: Executor, listener: Consumer<Int>?): Unit

Registers a listener to be invoked on the given Executor when the AnchorEntity's state changes, or unregisters the current listener if set to null.

The listener will fire with the current State value immediately upon registration.

Parameters
executor: Executor	: The executor on which the specified listener will fire.
listener: Consumer<Int>?	: The listener to fire upon invoking this method, and all subsequent state changes.

Public properties

state

Added in 1.0.0-alpha05

val state: Int

The current tracking state for this AnchorEntity.