ARAnchor

Inherits: RefCounted < Object

A positioned anchor in AR space.

Description

Base wrapper for ARKit anchors. Use it for generic anchor inspection or create anchors to place custom content in the session with ARSession.add_anchor(). More specific anchor types such as ARPlaneAnchor, ARImageAnchor, and ARMeshAnchor expose additional data.

Properties

String

identifier

"E3D0EC7D-9791-4D31-9EC4-121EF17FE2DB"

String

name

""

String

session_identifier

""

Transform3D

transform

Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

Methods

ARAnchor

copy_anchor()

ARAnchor

create(transform: Transform3D) static

ARAnchor

create_named(name: String, transform: Transform3D) static

Property Descriptions

String identifier = "E3D0EC7D-9791-4D31-9EC4-121EF17FE2DB" 🔗

  • String get_identifier()

A unique identifier for this anchor instance.

String name = "" 🔗

  • String get_name()

The optional name assigned to this anchor.

String session_identifier = "" 🔗

  • String get_session_identifier()

The identifier of the AR session that produced this anchor, when available.

Transform3D transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0) 🔗

  • Transform3D get_transform()

The anchor transform in world space.

Method Descriptions

ARAnchor copy_anchor() 🔗

Returns a copy of this anchor when the underlying platform supports cloning. Returns null if the anchor cannot be copied.

ARAnchor create(transform: Transform3D) static 🔗

Creates a new unnamed anchor at transform. Use the result with ARSession.add_anchor().

ARAnchor create_named(name: String, transform: Transform3D) static 🔗

Creates a new anchor with name at transform. The name is useful for identifying custom anchors when they are reported back through session signals.