<!--
{
  "documentType" : "article",
  "framework" : "USD",
  "identifier" : "/documentation/USD/preliminary-anchoringapi",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Preliminary_AnchoringAPI"
}
-->

# Preliminary_AnchoringAPI

A schema that defines the placement of a prim and its children at a real-world location.

## Discussion

Use this schema to attach prims to real-world areas in an AR experience, such as surfaces, images, or faces. In non-AR viewers like studio mode in AR Quick Look, the runtime displays a prim by applying its *transform* –– that is, its position, rotation, and scale –– relative to the center of the view.

> Note:
> Although ARKit features the ability to recognize predefined real-world objects (see <doc://com.apple.documentation/documentation/ARKit/ARReferenceObject>), and location anchors (see <doc://com.apple.documentation/documentation/ARKit/ARGeoAnchor>), the <doc://com.apple.usd/documentation/USD/preliminary-anchoringapi> schema doesn’t support object or location anchors.

### Declaration

```other
class "Preliminary_AnchoringAPI"
(
    inherits = </APISchemaBase>
)
```

### Nest and layer anchorable prims

When you assign this schema to a nested prim, the runtime positions the nested prim independently by not basing the child’s transform relative to its parent. As a result, the anchorable child is effectively out of the parent’s hierarchy. Similarly, if an asset defines one or more anchorable prims layered beneath another anchorable prim, the runtime positions each prim independently. However, any unanchorable children of an anchorable prim remain positioned relative to their parent.

Since the runtime doesn’t observe anchorable prim hierarchies, you need to define all anchorable prims at the root of the document, thus, without a parent.

## Topics

### Properties

[preliminary:anchoring:type](/documentation/USD/preliminary-anchoring-type)

A option that specifies the type of anchor.

[preliminary:planeAnchoring:alignment](/documentation/USD/preliminary-planeanchoring-alignment)

An option that specifies the orientation of a plane.

[preliminary:imageAnchoring:referenceImage](/documentation/USD/preliminary-imageanchoring-referenceimage)

The characteristics of an image the runtime should scan for in order to attach a prim.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)