unreal.GoogleARCoreServicesFunctionLibrary

class unreal.GoogleARCoreServicesFunctionLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

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

C++ Source:

  • Plugin: GoogleARCoreServices

  • Module: GoogleARCoreServices

  • File: GoogleARCoreServicesFunctionLibrary.h

classmethod config_google_ar_core_services(service_config) → bool

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.

Parameters

service_config (GoogleARCoreServicesConfig) – The desired GoogleARCoreServices configuration.

Returns

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

Return type

bool

classmethod create_and_host_cloud_ar_pin(ar_pin_to_host) -> (CloudARPin, out_task_result=ARPinCloudTaskResult)

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.

Parameters

ar_pin_to_host (ARPin) –

Returns

out_task_result (ARPinCloudTaskResult):

Return type

ARPinCloudTaskResult

classmethod create_and_host_cloud_ar_pin_latent_action(world_context_object, latent_info, ar_pin_to_host) -> (out_hosting_result=ARPinCloudTaskResult, out_cloud_ar_pin=CloudARPin)

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.

Parameters
Returns

out_hosting_result (ARPinCloudTaskResult): The ARPin hosting result.

out_cloud_ar_pin (CloudARPin): A new instance of UCloudARPin created using the input ARPinToHost.

Return type

tuple

classmethod create_and_resolve_cloud_ar_pin(cloud_id) -> (CloudARPin, out_task_result=ARPinCloudTaskResult)

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.

Parameters

cloud_id (str) –

Returns

out_task_result (ARPinCloudTaskResult):

Return type

ARPinCloudTaskResult

classmethod create_and_resolve_cloud_ar_pin_latent_action(world_context_object, latent_info, cloud_id) -> (out_acquiring_result=ARPinCloudTaskResult, out_cloud_ar_pin=CloudARPin)

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.

Parameters

  • world_context_object (Object) –

  • latent_info (LatentActionInfo) –

  • cloud_id (str) – The CloudId that will be used to resolve the ARPin

Returns

out_acquiring_result (ARPinCloudTaskResult): The ARPin acquiring result.

out_cloud_ar_pin (CloudARPin):

Return type

tuple

classmethod get_all_cloud_ar_pin()

Get a list of all CloudARPin in the current ARSession.

Returns

Return type

Array(CloudARPin)

classmethod remove_cloud_ar_pin(pin_to_remove) → None

Remove the given CloudARPin from the current ARSession.

Parameters

pin_to_remove (CloudARPin) –