Skip to content

AnchorData ​

Properties ​

alignment ​

  • Type: string
  • Plane alignment: "horizontal" or "vertical" (plane anchors only)

altitude ​

  • Type: number
  • Altitude in meters (geo anchors only, iOS)

blendShapes ​

  • Type: Array<any>
  • Blend shape coefficients for facial expressions

Example:

javascript
var faces = scene.getAnchors("face");
if (faces.length > 0) {
    var face = faces[0];
    var smile = (face.blendShapes.mouthSmileLeft + face.blendShapes.mouthSmileRight) / 2;
    var blink = face.blendShapes.eyeBlinkLeft;
    console.log("Smile:", smile, "Blink:", blink);
}

chirality ​

  • Type: string
  • Hand chirality: "left" or "right" (hand anchors only, visionOS)

classification ​

  • Type: string
  • Plane classification: "floor", "ceiling", "wall", "table", "seat", "window", "door" (plane anchors only)

estimatedScaleFactor ​

  • Type: number
  • Estimated scale factor of detected image (image anchors only)

height ​

  • Type: number
  • Plane height in meters (plane anchors only)

id ​

  • Type: string
  • Unique identifier for this anchor

isTracked ​

  • Type: boolean
  • Whether this anchor is currently being tracked (image, face, hand anchors)

joints ​

  • Type: Array<any>
  • Hand joint transforms by name

Example:

javascript
var hand = scene.getAnchors("hand")[0];
if (hand.chirality === "left") {
    var indexTip = hand.joints.indexFingerTip.worldTransform;
    console.log("Index finger at:", indexTip.position);
}

kind ​

  • Type: string
  • Anchor type: "plane", "hand", "face", "image", "world", "geo", "mesh"

latitude ​

  • Type: number
  • Geographic latitude in degrees (geo anchors only, iOS)

leftEyeTransform ​

  • Type: Transform
  • Left eye transform in face coordinate space (face anchors only)

longitude ​

  • Type: number
  • Geographic longitude in degrees (geo anchors only, iOS)

lookAtPoint ​

  • Type: Vector3
  • Estimated gaze direction point in face coordinate space (face anchors only)

Example:

javascript
var face = scene.getAnchors("face")[0];
var lookAt = face.lookAtPoint;
// Position object where user is looking
object.position = Vector3(
    face.worldTransform.position.x + lookAt.x,
    face.worldTransform.position.y + lookAt.y,
    face.worldTransform.position.z - 0.5
);

name ​

  • Type: string
  • Optional name for this anchor

orderedJointTransforms ​

  • Type: Array<any>
  • Ordered joint transforms for skeletal animation (hand anchors only)

Example:

javascript
var model = rep.findChild("locator1");
var hand = scene.getAnchors("hand")[0];

var transforms = model.jointTransforms;
hand.orderedJointTransforms.forEach(function(t, index) {
    transforms[index].rotation = t.rotation;
});
model.jointTransforms = transforms;

referenceImageName ​

  • Type: string
  • Reference image name from ARReferenceImage (image anchors only)

rightEyeTransform ​

  • Type: Transform
  • Right eye transform in face coordinate space (face anchors only)

width ​

  • Type: number
  • Plane width in meters (plane anchors only)

worldTransform ​

  • Type: Transform
  • World-space transform matrix for anchor position and orientation