1. Epic GamesDeveloper
  3. IAzureSpatialAnchors

IAzureSpatialAnchors

IAzureSpatialAnchors.h provides the C++ interface for using [AzureSpatialAnchors](API\Plugins\AzureSpatialAnchors\AzureSpatialAnchors) (ASA) in Unreal.

Unreal Engine C++ API Reference > Plugins > AzureSpatialAnchors

Inheritance Hierarchy

References

   
Module AzureSpatialAnchors
Header /Engine/Plugins/Runtime/AR/AzureSpatialAnchors/Source/AzureSpatialAnchors/Public/IAzureSpatialAnchors.h
Include #include "IAzureSpatialAnchors.h"

Syntax

class IAzureSpatialAnchors : public IModularFeature

Remarks

IAzureSpatialAnchors.h provides the C++ interface for using AzureSpatialAnchors (ASA) in Unreal.

Most of its functions are simple wrappers for ASA api's from Microsoft. A few relate to UAzureCloudSpatialAnchor objects. A few communicate with the platform specific local anchor api's, where that is necessary.

It is extended by AzureSpatialAnchorsBase, which owns the UAzureCloudSpatialAnchor objects which are UE's representation of the ASA CloudAnchor object. That is then extended by AzureSpatialAnchorsFor classes in their own plugins (so one can choose to enable the feature per platform). The ForPlatform classes implement the api wrapper functions and do whatever type conversions and async translation is required. AzureSpatialAnchorsForARKit is an example. Other implementations may be somewhat simpler without this additional layer.

AzureSpatialAnchorsFunctionLibrary provides the blueprint api for AzureSpatialAnchors. It is also an example of how to use the C++ api.

UAzureSpatialAnchorsLibrary::StartSession() is a super simple case.  It just calls through to one of the non-async ForPlatform api functions.

UAzureSpatialAnchorsLibrary::DeleteCloudAnchor is a latent blueprint function wrapping a simple async api function.  Most of the logic is actually in FAzureSpatialAnchorsDeleteCloudAnchorAction.

UAzureSpatialAnchorsLibrary::LoadCloudAnchor / FAzureSpatialAnchorsLoadCloudAnchorAction is the most complicated.  It creates a watcher then registers for the delegates so it can handle AnchorLocated and AnchorLocateCompleted events.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function EAzureSpatialAnchorsResult

ConstructAnchor ( UARPin* InARPin,
CloudAnchorID& OutCloudAnchorID
)

  
Public function bool

ConstructCloudAnchor ( UARPin*& InARPin,
UAzureCloudSpatialAnchor*& OutCloudAnchor
)

  
Public function void

CreateAnchorAsync ( CloudAnchorID InCloudAnchorID,
Callback_Result Callback
)

  
Public function bool

CreateARPinAroundAzureCloudSpatialAnchor ( const FString& PinId,
UAzureCloudSpatialAnchor* InAzureCloudSpatialAnchor,
UARPin*& OutARPin
)

  
Public function void  
Public function void

CreateNamedARPinAroundAnchor ( const FString& LocalAnchorId,
UARPin*& OutARPin
)

 Functions that must be implemented per-platform.
Public function bool These functions alias the AzureSpatialAnchors API. They must be implemented for each platform.
Public function EAzureSpatialAnchorsResult

CreateWatcher ( const FAzureSpatialAnchorsLocateCriteria& InLocateCriteria,
float InWorldToMetersScale,
WatcherID& OutWatcherID,
FString& OutErrorString
)

  
Public function void

DeleteAnchorAsync ( CloudAnchorID InCloudAnchorID,
Callback_Result Callback
)

  
Public function void  
Public function void  
Public function Static IAzureSpatialAnchors *

Get ()

  
Public function void  
Public function void  
Public function EAzureSpatialAnchorsResult

GetActiveWatchers ( TArray< WatcherID >& OutWatcherIDs
)

  
Public function void

GetAnchorPropertiesAsync ( const FString& InCloudAnchorIdentifier,
Callback_Result_CloudAnchorID Callback
)

  
Public function bool

GetCloudAnchor ( UARPin*& InARPin,
UAzureCloudSpatialAnchor*& OutCloudAnchor
)

  
Public function EAzureSpatialAnchorsResult

GetCloudAnchorAppProperties ( CloudAnchorID InCloudAnchorID,
TMap< FString, FString >& OutAppProperties
)

  
Public function EAzureSpatialAnchorsResult

GetCloudAnchorExpiration ( CloudAnchorID InCloudAnchorID,
float& OutLifetimeInSeconds
)

  
Public function void

GetCloudAnchors ( TArray< class UAzureCloudSpatialAnchor* >& OutCloudAnchors
)

  
Public function EAzureSpatialAnchorsResult

GetCloudSpatialAnchorIdentifier ( CloudAnchorID InCloudAnchorID,
FString& OutCloudAnchorIdentifier
)

  
Public function EAzureSpatialAnchorsResult  
Public function EAzureSpatialAnchorsResult  
Public function Static FName  
Public function UAzureCloudSpatialAnchor *  
Public function EAzureSpatialAnchorsResult

GetSessionId ( FString& OutSessionID
)

 Virtual EAzureSpatialAnchorsResult GetSession() = 0; virtual EAzureSpatialAnchorsResult SetSession() = 0;
Public function const FAzureSpatialAnchorsSessionStatus & These functions provide basic housekeeping for AzureSpatialAnchors. The AzureSpatialAnchorsBase layer implements them.
Public function void  
Public function Static bool  
Public function Static void

OnLog ( const wchar_t* LogMsg
)

  
Public function void  
Public function EAzureSpatialAnchorsResult  
Public function EAzureSpatialAnchorsResult

SetCloudAnchorAppProperties ( CloudAnchorID InCloudAnchorID,
const TMap< FString, FString >& InAppProperties
)

  
Public function EAzureSpatialAnchorsResult

SetCloudAnchorExpiration ( CloudAnchorID InCloudAnchorID,
float InLifetimeInSeconds
)

  
Public function EAzureSpatialAnchorsResult  
Public function EAzureSpatialAnchorsResult  
Public function EAzureSpatialAnchorsResult  
Public function EAzureSpatialAnchorsResult  
Public function EAzureSpatialAnchorsResult  
Public function void  
Public function EAzureSpatialAnchorsResult

StopWatcher ( WatcherID WatcherID
)

  
Public function void

SubmitDiagnosticsManifestAsync ( const FString& ManifestPath,
Callback_Result Callback
)

  
Public function void  

Classes

  Type Name Description
Protected class FASAAnchorLocatedTask If an implementation generates events from a thread other than the game thread it should launch these tasks that will fire the delegates on the game thread  
Protected class FASALocateAnchorsCompletedTask    
Protected class FASASessionUpdatedTask    

Typedefs

Name Description
Callback_Result  
Callback_Result_CloudAnchorID  
Callback_Result_SessionStatus  
Callback_Result_String  
CloudAnchorID  
FASAAnchorLocatedDelegate WatcherIdentifier, status, anchor.
FASALocateAnchorsCompletedDelegate WatcherIdentifier, canceled.
FASASessionUpdatedDelegate ReadyForCreateProgress, RecommendedForCreateProgress, SessionCreateHash, SessionLocateHash, feedback.
LogFunctionPtr  
WatcherID  

Constants

Name Description
ASAAnchorLocatedDelegate  
ASALocateAnchorsCompletedDelegate  
ASASessionUpdatedDelegate  
CloudAnchorID_Invalid  
WatcherID_Invalid  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page