Instance Method

initWithName:transform:extent:

Creates a new anchor object with a descriptive name.

Declaration

- (instancetype)initWithName:(NSString *)name transform:(simd_float4x4)transform extent:(simd_float3)extent;

Parameters

name

A descriptive name for the anchor. ARKit does not display the name to users, but your app can use it to identify anchors for debugging.

transform

A matrix encoding the position, orientation, and scale of the anchor relative to the world coordinate space of the AR session the anchor is placed in.

World coordinate space in ARKit always follows a right-handed convention, but is oriented based on the session configuration. For details, see Understanding World Tracking.

extent

The area around the anchor's position to use when projecting its texture for parallax correction.

An environment probe anchor may have an infinite extent, indicating that its texture is to be used as a global lighting environment, or a finite extent, indicating that the texture represents the local lightiing conditions in a specific area of the scene.

Discussion

Use the addAnchor: method to begin tracking your custom anchor in an AR session. After you add an environment probe anchor to the scene, ARKit begins generating environment textures for it. To be notified when the anchor has a new environmentTexture, implement the session:didUpdateAnchors:, renderer:didUpdateNode:forAnchor:, or view:didUpdateNode:forAnchor: delegate method.

See Also

Creating Probe Anchors

- initWithTransform:extent:

Creates a new environment probe anchor.