Develop
Develop
Select your platform

Spatial Anchors Unreal Blueprints Reference

Updated: Sep 4, 2024

OculusXR Async Create Spatial Anchor

Creates a Spatial Anchor at a specific actor’s transform in Unreal world space. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Target is Oculus Spatial Anchor Manager.
Create spatial anchor blueprint reference image
InputDescription
Target Actor
The Unreal actor to which the spatial anchor component is attached. If the target actor you specify does not already have a Spatial Anchor component, a component is created for the target anchor automatically.
Anchor Transform
The Unreal world space transform of the anchor being created.
OutputDescription
Anchor
The created or found anchor component attached to the Target Actor.
Result
Result code of the call after completion.

OculusXR Async Save Anchors

Saves the spatial anchors associated with the specified Actors.
Save anchor blueprint reference image
InputDescription
Target Actors
The Unreal actors with spatial anchor components attached that will be saved.
OutputDescription
Anchors
The list of anchor components that were saved during this request.
Result
Result code of the call after completion.

OculusXR Async Discover Anchors

Searches for anchors filtered by the specified filters. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Known issue: The result code for Discover Anchors isn’t visible in the blueprint and thus you cannot respond to errors from within your Blueprint Graph.
Discover anchors blueprint reference image
InputDescription
Discovery Info
A structure that contains an array of discovery filters.
OutputDescription
Discovery Result
Array of Discovery Result structures. Each element contains an Anchor Handle and the associated UUID.

Oculus Async Erase Anchors

Erases the specified anchors. You do not have to supply an entry for each input pin, you can mix and match any association of actors, handles, or UUIDs. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Erase anchors blueprint reference image
InputDescription
Target Actors
An array of actors which must have attached anchor components which will be erased.
Anchor Handles
An array of anchor handles associated with anchors that will be erased.
Anchor UUIDs
An array of anchor UUIDs associated with anchor data that will be erased. These anchors do not have to be loaded into the current scene.
OutputDescription
Anchors
An array of anchor components which represent the anchors that were erased, if provided.
Anchor Handles
An array of anchor handles associated with anchors that were erased, if provided.
Anchor UUIDs
An array of anchor UUIDs associated with anchor data that was erased, if provided.
Result
Result code of the call.

Oculus Async Share Anchors

Shares one or more anchors with the specified users. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Share anchors blueprint reference image
InputDescription
Target Actors
An array of actors that must have attached anchor components, the anchor data associated with the component will be shared to the specified users.
To Share With Ids
An array of strings which represent the User IDs of the share targets.
OutputDescription
Shared Anchors
An array of anchor components which represent the anchors that were shared from the provided list of actors.
User Ids
An array of strings which represent the User IDs of the share targets.
Result
Result code of the call after completion.

OculusXR Share Anchors With Group Async

Shares one or more anchors with the specified groups. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Share anchors with group blueprint reference image
InputDescription
Group UUIDs
An array of UUIDs, each representing the groups you want to share with.
Anchor Handles
An array of int64’s where each element represents an anchor handle.
OutputDescription
Success
True or false depending on whether the function call succeeded or not.
Groups
The groups that were shared with.
Anchor Handles
The anchors that were shared.
Result
Result code of the call after completion.

Oculus Async Get Shared Anchors

Retrieves anchors that have been shared with the user given a set of UUIDs. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Share anchors blueprint reference image
InputDescription
AnchorUUIDs
The list of anchor UUIDs that are associated with shared anchors available in the cloud or on your device.
OutputDescription
Shared Anchors
An array of Discovery Results which represent the anchors that were found given the provided list of Anchor UUIDs.
Result
Result code of the call after completion.

OculusXR Get Shared Anchors From Group Async

Shares one or more anchors with the specified groups. This function is asynchronous and the results of the function are available via the success and failure execution pins.
Share anchors with group blueprint reference image
InputDescription
Group UUID
The single group to retrieve anchors from.
OutputDescription
Success
True or false depending on whether the function call succeeded or not.
Anchors
The UUIDs of the anchors that were loaded.
Result
Result code of the call after completion.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon