ARImageAnchor¶

An anchor created when a reference image is detected in the scene.

Description¶

Represents a detected reference image in the real world. Image anchors are produced when the session is configured with a reference image group. The anchor exposes the image name, physical size, tracking state, and estimated scale factor.

Properties¶

float	estimated_scale_factor	`1.0`
String	identifier	`""`
bool	is_tracked	`false`
String	reference_image_name	`""`
Vector2	reference_image_physical_size	`Vector2(0, 0)`
Transform3D	transform	`Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`

Property Descriptions¶

float estimated_scale_factor = 1.0 🔗

void set_estimated_scale_factor(value: float)
float get_estimated_scale_factor()

ARKit’s current estimate of the detected image’s scale relative to its reference size.

String identifier = "" 🔗

void set_identifier(value: String)
String get_identifier()

A unique identifier for this image anchor.

bool is_tracked = false 🔗

void set_is_tracked(value: bool)
bool get_is_tracked()

Whether the image is currently tracked with reliable pose updates.

String reference_image_name = "" 🔗

void set_reference_image_name(value: String)
String get_reference_image_name()

The name of the detected reference image from the asset catalog.

Vector2 reference_image_physical_size = Vector2(0, 0) 🔗

void set_reference_image_physical_size(value: Vector2)
Vector2 get_reference_image_physical_size()

The physical size of the reference image in meters.

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

void set_transform(value: Transform3D)
Transform3D get_transform()

The image anchor transform in world space.