core/com.pico.spatial.core.ecs/AnchorComponent

AnchorComponent

@MainThread

The Component that defines a spatial anchoring relationship between entities and real-world objects.

When this component is attached to an entity, the entity gains the ability to anchor itself to a specific point or marker in the physical world, enabling spatial alignment and persistence.

This component is currently effective only when used in full space.

Constructors

AnchorComponent

constructor(anchorTarget: AnchorTarget = AnchorTarget.createCameraTarget(), trackingMode: AnchorComponent.TrackingMode = TrackingMode.CONTINUOUS)

Creates an AnchorComponent with the specified AnchorTarget and tracking mode.

Types

TrackingMode

class TrackingMode

Controls how an entity follows its target in the scene.

Properties

anchorTarget

var anchorTarget: AnchorTarget

The AnchorTarget.

positionOffset

var positionOffset: Vector3

Position offset of the actual object relative to its AnchorTarget.

rotationOffset

var rotationOffset: Quat

The rotation offset of the actual object relative to its AnchorTarget.

trackingMode

var trackingMode: AnchorComponent.TrackingMode

Controls how the entity follows its AnchorTarget.

Functions

clone

open override fun clone(): Component

Creates and returns a copy of this Component instance.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String