JxrPlatformAdapter.AnchorEntity

Artifact: androidx.xr.scenecore:scenecore

View Source

Added in 1.0.0-alpha01

---

Kotlin |Java

public interface JxrPlatformAdapter.AnchorEntity extends JxrPlatformAdapter.SystemSpaceEntity

---

Interface for Anchor entity.

Summary

Nested types
public interface JxrPlatformAdapter.AnchorEntity.OnStateChangedListener Interface for listening to Anchor state changes.
public enum JxrPlatformAdapter.AnchorEntity.PersistState Specifies the current persistence state of the Anchor.
public interface JxrPlatformAdapter.AnchorEntity.PersistStateChangeListener Interface for listening to Anchor persist state changes.
public enum JxrPlatformAdapter.AnchorEntity.State Specifies the current tracking state of the Anchor.

Public methods
abstract @NonNull JxrPlatformAdapter.AnchorEntity.PersistState	getPersistState() Returns the current persist state of the anchor synchronously.
abstract @NonNull JxrPlatformAdapter.AnchorEntity.State	getState()
abstract long	nativePointer() Returns the native pointer of the anchor.
abstract @Nullable UUID	persist() Persists the anchor.
abstract void	registerPersistStateChangeListener(     @NonNull JxrPlatformAdapter.AnchorEntity.PersistStateChangeListener persistStateChangeListener ) Registers a listener to be called when the persist state of the anchor changes.
abstract void	setOnStateChangedListener(     @Nullable JxrPlatformAdapter.AnchorEntity.OnStateChangedListener onStateChangedListener ) Registers a listener to be called when the state of the anchor changes.

Inherited methods
From androidx.xr.scenecore.JxrPlatformAdapter.ActivityPose abstract @NonNull Pose getActivitySpacePose() Returns the pose for this entity, relative to the activity space root. abstract @NonNull Vector3 getActivitySpaceScale() Returns the scale of this WorldPose relative to the activity space. abstract @NonNull Vector3 getWorldSpaceScale() Returns the scale of this ActivityPose. abstract @NonNull Pose transformPoseTo(     @NonNull Pose pose,     @NonNull JxrPlatformAdapter.ActivityPose destination ) Returns a pose relative to this entity transformed into a pose relative to the destination.
From androidx.xr.scenecore.JxrPlatformAdapter.Entity abstract void addChild(@NonNull JxrPlatformAdapter.Entity child) Add given Entity as child. abstract void addChildren(@NonNull List<JxrPlatformAdapter.Entity> children) abstract boolean addComponent(@NonNull JxrPlatformAdapter.Component component) Add these components to entity. abstract void addInputEventListener(     @NonNull Executor executor,     @NonNull JxrPlatformAdapter.InputEventListener listener ) Adds the listener to the set of active input listeners, for input events targeted to this entity or its child entities. abstract void dispose() Dispose any system resources held by this entity, and transitively calls dispose() on all the children. abstract float getActivitySpaceAlpha() Returns the total alpha transparency level for this Entity. abstract float getAlpha() Returns the set alpha transparency level for this Entity. abstract @NonNull List<JxrPlatformAdapter.Entity> getChildren() abstract @Nullable JxrPlatformAdapter.Entity getParent() abstract @NonNull Pose getPose() Returns the pose for this entity, relative to its parent. abstract @NonNull Vector3 getScale() Returns the scale of this entity, relative to its parent. abstract boolean isHidden(boolean includeParents) Returns the hidden status of this Entity. abstract void removeAllComponents() Remove all components from this entity. abstract void removeComponent(@NonNull JxrPlatformAdapter.Component component) Remove the given component from the entity. abstract void removeInputEventListener(     @NonNull JxrPlatformAdapter.InputEventListener listener ) Removes the given listener from the set of active input listeners. abstract void setAlpha(float alpha) Sets the alpha transparency for the given Entity. abstract void setContentDescription(@NonNull String text) abstract void setHidden(boolean hidden) Sets the local hidden state of this Entity. abstract void setParent(@Nullable JxrPlatformAdapter.Entity parent) abstract void setPose(@NonNull Pose pose) Updates the pose (position and rotation) of the Entity relative to its parent. abstract void setScale(@NonNull Vector3 scale) Sets the scale of this entity relative to its parent. abstract void setSize(@NonNull JxrPlatformAdapter.Dimensions dimensions) Sets the size for the given Entity.
From androidx.xr.scenecore.JxrPlatformAdapter.SystemSpaceEntity abstract void setOnSpaceUpdatedListener(     @Nullable JxrPlatformAdapter.SystemSpaceEntity.OnSpaceUpdatedListener listener,     @Nullable Executor executor ) Registers a listener to be called when the underlying space has moved or changed.

Public methods

getPersistState

Added in 1.0.0-alpha01

abstract @NonNull JxrPlatformAdapter.AnchorEntity.PersistState getPersistState()

Returns the current persist state of the anchor synchronously.

getState

Added in 1.0.0-alpha01

abstract @NonNull JxrPlatformAdapter.AnchorEntity.State getState()

nativePointer

Added in 1.0.0-alpha01

abstract long nativePointer()

Returns the native pointer of the anchor.

persist

Added in 1.0.0-alpha01

abstract @Nullable UUID persist()

Persists the anchor. If the query is sent to perception service successful returns an UUID, which could be used retrieve the anchor. Otherwise, return null.

registerPersistStateChangeListener

Added in 1.0.0-alpha01

abstract void registerPersistStateChangeListener(
    @NonNull JxrPlatformAdapter.AnchorEntity.PersistStateChangeListener persistStateChangeListener
)

Registers a listener to be called when the persist state of the anchor changes.

setOnStateChangedListener

Added in 1.0.0-alpha01

abstract void setOnStateChangedListener(
    @Nullable JxrPlatformAdapter.AnchorEntity.OnStateChangedListener onStateChangedListener
)

Registers a listener to be called when the state of the anchor changes.