unreal.GoogleARCoreSessionFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

A function library that provides static/Blueprint functions associated with GoogleARCore session.

C++ Source:

  • Plugin: GoogleARCore

  • Module: GoogleARCoreBase

  • File: GoogleARCoreFunctionLibrary.h

classmethod add_runtime_candidate_image_from_rawbytes(session_config, image_grayscale_pixels, image_width, image_height, friendly_name, physical_width, candidate_texture=None) → ARCandidateImage

Create an ARCandidateImage object from the raw pixel data and add it to the ARCandidateImageList of the given c UARSessionConfig object.

Note that you need to restart the AR session with the c UARSessionConfig you are adding to to make the change take effect.

On ARCore platform, you can leave the PhysicalWidth and PhysicalHeight to 0 if you don’t know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.

Parameters

  • session_config (ARSessionConfig) –

  • image_grayscale_pixels (Array(uint8)) –

  • image_width (int32) –

  • image_height (int32) –

  • friendly_name (str) –

  • physical_width (float) –

  • candidate_texture (Texture2D) –

Returns

A c UARCandidateImage Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.

Return type

ARCandidateImage

classmethod check_ar_core_availability(world_context_object, latent_info) → GoogleARCoreAvailability

Check ARCore Availability deprecated: This function is deprecated, use CheckARServiceAvailability from UARDependencyHandler.

Parameters
Returns

out_availability (GoogleARCoreAvailability):

Return type

GoogleARCoreAvailability

classmethod get_all_augmented_faces()

Get All Augmented Faces deprecated: This function is deprecated, use GetAllGeometriesByClass.

Returns

out_augmented_face_list (Array(GoogleARCoreAugmentedFace)):

Return type

Array(GoogleARCoreAugmentedFace)

classmethod get_all_augmented_images()

Get All Augmented Images deprecated: GetAllAugmentedImages is deprecated. Use GetAllGeometriesByClass.

Returns

out_augmented_image_list (Array(GoogleARCoreAugmentedImage)):

Return type

Array(GoogleARCoreAugmentedImage)

classmethod get_all_planes()

Get All Planes deprecated: GetAllPlanes is deprecated. Use GetAllGeometriesByClass.

Returns

out_plane_list (Array(ARPlaneGeometry)):

Return type

Array(ARPlaneGeometry)

classmethod get_all_trackable_points()

Get All Trackable Points deprecated: GetAllTrackablePoints is deprecated. Use GetAllGeometriesByClass.

Returns

out_trackable_point_list (Array(ARTrackedPoint)):

Return type

Array(ARTrackedPoint)

classmethod get_ar_core_camera_config() → GoogleARCoreCameraConfig or None

Get ARCore Camera Config deprecated: This function is deprecated, use GetSupportedVideoFormats.

Returns

out_current_camera_config (GoogleARCoreCameraConfig):

Return type

GoogleARCoreCameraConfig or None

classmethod get_ar_core_event_manager() → GoogleARCoreEventManager

Get ARCore Event Manager deprecated: This function is deprecated, use GetSupportedVideoFormats.

Returns

Return type

GoogleARCoreEventManager

classmethod get_passthrough_camera_image_uv(uv)

Get Passthrough Camera Image UV

Parameters

uv (Array(float)) –

Returns

out_uv (Array(float)):

Return type

Array(float)

classmethod install_ar_core_service(world_context_object, latent_info) → GoogleARCoreInstallRequestResult

Install ARCore Service deprecated: This function is deprecated, use InstallARService from UARDependencyHandler.

Parameters
Returns

out_install_result (GoogleARCoreInstallRequestResult):

Return type

GoogleARCoreInstallRequestResult

classmethod is_passthrough_camera_rendering_enabled() → bool

Is Passthrough Camera Rendering Enabled deprecated: This function is deprecated, use UARSessionConfig::ShouldRenderCameraOverlay.

Returns

Return type

bool

classmethod set_ar_core_camera_config(target_camera_config) → bool

Set ARCore Camera Config deprecated: This function is deprecated, use UARSessionConfig::SetDesiredVideoFormat.

Parameters

target_camera_config (GoogleARCoreCameraConfig) –

Returns

Return type

bool

classmethod set_passthrough_camera_rendering_enabled(enable) → None

Set Passthrough Camera Rendering Enabled deprecated: This function is deprecated, use UARSessionConfig::bEnableAutomaticCameraOverlay.

Parameters

enable (bool) –

classmethod start_ar_core_session(world_context_object, latent_info, configuration) → None

Start ARCore Session deprecated: This function is deprecated, use StartARSession.

Parameters