UGoogleARCoreServicesFunctionLibrary

#include <GoogleARCoreServicesFunctionLibrary.h>

A function library that provides static/Blueprint functions for Google ARCore Services.

Summary

Inheritance

Inherits from: UBlueprintFunctionLibrary

Public static functions
`ConfigGoogleARCoreServices(FGoogleARCoreServicesConfig ServiceConfig)`	`bool` Configure the current Unreal AR session with the desired GoogleARCoreServices configuration.
`CreateAndHostCloudARPin(UARPin *ARPinToHost, EARPinCloudTaskResult & OutTaskResult)`	`UCloudARPin *` Creating and hosting a CloudARPin and return it immediately.
`CreateAndHostCloudARPinLatentAction(UObject WorldContextObject, struct FLatentActionInfo LatentInfo, UARPin ARPinToHost, EARPinCloudTaskResult & OutHostingResult, UCloudARPin *& OutCloudARPin)`	`void` This will start a Latent Action to host the ARPin and creating a UCloudARPin from it.
`CreateAndResolveCloudARPin(FString CloudId, EARPinCloudTaskResult & OutTaskResult)`	`UCloudARPin *` Creating and Resolving a CloudARPin and return it immediately.
`CreateAndResolveCloudARPinLatentAction(UObject WorldContextObject, struct FLatentActionInfo LatentInfo, FString CloudId, EARPinCloudTaskResult & OutAcquiringResult, UCloudARPin & OutCloudARPin)`	`void` This will start a Latent Action to create UCloudARPin using the given CloudId.
`GetAllCloudARPin()`	`TArray< UCloudARPin * >` Get a list of all CloudARPin in the current ARSession.
`RemoveCloudARPin(UCloudARPin *PinToRemove)`	`void` Remove the given CloudARPin from the current ARSession.

Public static functions

ConfigGoogleARCoreServices

bool ConfigGoogleARCoreServices(
  FGoogleARCoreServicesConfig ServiceConfig
)

Configure the current Unreal AR session with the desired GoogleARCoreServices configuration.

If there is an running AR session, the configuration will take effect immediately. Otherwise, it will take effect when the next AR session is running.

Details

Parameters

ServiceConfig

The desired GoogleARCoreServices configuration.

Returns

True if GoogleARCoreServices is configured successfully. False if the configuration failed to apply.

CreateAndHostCloudARPin

UCloudARPin * CreateAndHostCloudARPin(
  UARPin *ARPinToHost,
  EARPinCloudTaskResult & OutTaskResult
)

Creating and hosting a CloudARPin and return it immediately.

Note that this function only start the hosting process. Call GetARPinCloudState to check if the hosting is finished or failed with error.

CreateAndHostCloudARPinLatentAction

void CreateAndHostCloudARPinLatentAction(
  UObject *WorldContextObject,
  struct FLatentActionInfo LatentInfo,
  UARPin *ARPinToHost,
  EARPinCloudTaskResult & OutHostingResult,
  UCloudARPin *& OutCloudARPin
)

This will start a Latent Action to host the ARPin and creating a UCloudARPin from it.

The complete flow of this Latent Action will be triggered if the hosting is complete or an error has occurred.

Note that a UCloudARPin will be always created when this function is called, even in the case that the CloudId is failed to host. You can check the CloudState of returning UCloudARPin to see why the hosting failed.

Details

Parameters

`ARPinToHost`	The ARPin to host.
`OutHostingResult`	The ARPin hosting result.
`OutCloudARPin`	A new instance of UCloudARPin created using the input ARPinToHost.

CreateAndResolveCloudARPin

UCloudARPin * CreateAndResolveCloudARPin(
  FString CloudId,
  EARPinCloudTaskResult & OutTaskResult
)

Creating and Resolving a CloudARPin and return it immediately.

Note that this function only start the acquiring process. Call GetARPinCloudState to check if the acquiring is finished or failed with error.

CreateAndResolveCloudARPinLatentAction

void CreateAndResolveCloudARPinLatentAction(
  UObject *WorldContextObject,
  struct FLatentActionInfo LatentInfo,
  FString CloudId,
  EARPinCloudTaskResult & OutAcquiringResult,
  UCloudARPin *& OutCloudARPin
)

This will start a Latent Action to create UCloudARPin using the given CloudId.

The complete flow of this Latent Action will be triggered if creating the UCloudARPin is successfully or an error has occurred.

Note that a UCloudARPin will be always created when this function is called, even in the case that the CloudId is failed to resolve. You can check the CloudState of returning UCloudARPin to see why the resolving failed.

Details

Parameters

`CloudId`	The CloudId that will be used to resolve the ARPin
`OutAcquiringResult`	The ARPin acquiring result.
`OutARPin`	The ARPin that is created when calling this function.

GetAllCloudARPin

TArray< UCloudARPin * > GetAllCloudARPin()

Get a list of all CloudARPin in the current ARSession.

RemoveCloudARPin

void RemoveCloudARPin(
  UCloudARPin *PinToRemove
)

Remove the given CloudARPin from the current ARSession.