UGoogleARCoreSessionFunctionLibrary

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UGoogleARCoreSessionFunctionLibrary

References

Module

GoogleARCoreBase

Header

/Engine/Plugins/Runtime/AR/Google/GoogleARCore/Source/GoogleARCoreBase/Public/GoogleARCoreFunctionLibrary.h

Include

#include "GoogleARCoreFunctionLibrary.h"

Syntax

UCLASS()
class UGoogleARCoreSessionFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

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

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

UARCandidate...

 

AddRuntimeCandidateImageFromRawbytes

(
    UARSessionConfig* SessionConfi...,
    const TArray< uint8 >& ImageGraysc...,
    int ImageWidth,
    int ImageHeight,
    FString FriendlyName,
    float PhysicalWidth,
    UTexture2D* CandidateTexture
)

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

Public function Static

void

 

GetAllTrackable

(
    TArray< T* >& OutTrackableLis...
)

Template function to get all trackables from a given type.

Deprecated Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

CheckARCoreAvailability

(
    UObject* WorldContextObject,
    FLatentActionInfo LatentInfo,
    EGoogleARCoreAvailability& OutAvai...
)

This function is deprecated, use CheckARServiceAvailability from UARDependencyHandler.

Public function Static

EGoogleARCor...

 

CheckARCoreAvailableStatus()

This function is deprecated, use CheckARServiceAvailability from UARDependencyHandler.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

GetAllAugmentedFaces

This function is deprecated, use GetAllGeometriesByClass.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

GetAllAugmentedImages

This function is deprecated. Use "GetAllGeometriesByClass" instead.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

GetAllPlanes

(
    TArray< UARPlaneGeometry* >& ...
)

This function is deprecated. Use "GetAllGeometriesByClass" instead.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

GetAllTrackablePoints

(
    TArray< UARTrackedPoint* >& O...
)

This function is deprecated. Use "GetAllGeometriesByClass" instead.

Public function Static

EGoogleARCor...

 

GetARCoreAPKInstallResult()

This function is deprecated, use CheckARServiceAvailability from UARDependencyHandler.

Public function Static UFunction BlueprintPure, Category, Meta

bool

 

GetARCoreCameraConfig

(
    FGoogleARCoreCameraConfig& OutCurr...
)

This function is deprecated, use GetSupportedVideoFormats.

Public function Static UFunction BlueprintPure, Category, Meta

UGoogleARCor...

 

GetARCoreEventManager()

This function is deprecated, use GetSupportedVideoFormats.

Public function Static UFunction BlueprintPure, Category, Meta

void

 

GetPassthroughCameraImageUV

(
    const TArray< float >& InUV,
    TArray< float >& OutUV
)

Use UGoogleARCoreFrameFunctionLibrary::TransformARCoordinates2D(EGoogleARCoreCoordinates2DType::Viewport, InUV, EGoogleARCoreCoordinates2DType::Texture, OutUV) instead.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

InstallARCoreService

(
    UObject* WorldContextObject,
    FLatentActionInfo LatentInfo,
    EGoogleARCoreInstallRequestResult&...
)

This function is deprecated, use InstallARService from UARDependencyHandler.

Public function Static UFunction BlueprintPure, Category, Meta

bool

 

IsPassthroughCameraRenderingEnabled()

This function is deprecated, use UARSessionConfig::ShouldRenderCameraOverlay.

Public function Static

EGoogleARCor...

 

RequestInstallARCoreAPK()

This function is deprecated, use InstallARService from UARDependencyHandler.

Public function Static UFunction BlueprintCallable, Category, Meta

bool

 

SetARCoreCameraConfig

(
    FGoogleARCoreCameraConfig TargetCam...
)

This function is deprecated, use UARSessionConfig::SetDesiredVideoFormat.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetPassthroughCameraRenderingEnabled

(
    bool bEnable
)

This function is deprecated, use UARSessionConfig::bEnableAutomaticCameraOverlay.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

StartARCoreSession

(
    UObject* WorldContextObject,
    FLatentActionInfo LatentInfo,
    UGoogleARCoreSessionConfig* Co...
)

This function is deprecated, use StartARSession.