FARSupportInterface

Composition Components for tracking system features

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AugmentedReality

Header

/Engine/Source/Runtime/AugmentedReality/Public/ARSupportInterface.h

Include

#include "ARSupportInterface.h"

Syntax

class FARSupportInterface :
    public TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe >,
    public FGCObject,
    public IModularFeature

Remarks

Composition Components for tracking system features

Variables

Constructors

Name Description

Public function

FARSupportInterface

(
    IARSystemSupport* InARImplemen...,
    IXRTrackingSystem* InXRTrackin...
)

Destructors

Name Description

Public function Virtual

~FARSupportInterface()

Functions

Name Description

Public function

UARSessionCo...

 

AccessSessionConfig()

Public function

bool

 

AddManualEnvironmentCaptureProbe

(
    FVector Location,
    FVector Extent
)

Public function

FDelegateHan...

 

AddOnTrackableAddedDelegate_Handle

(
    const FOnTrackableAddedDelegate& D...
)

Pass through helpers to create the methods needed to add/remove delegates from the AR system.

Public function

FDelegateHan...

 

AddOnTrackableRemovedDelegate_Handle

(
    const FOnTrackableRemovedDelegate&...
)

Public function

FDelegateHan...

 

AddOnTrackableUpdatedDelegate_Handle

(
    const FOnTrackableUpdatedDelegate&...
)

Public function

UARCandidate...

 

AddRuntimeCandidateImage

(
    UARSessionConfig* SessionConfi...,
    UTexture2D* CandidateTexture,
    FString FriendlyName,
    float PhysicalWidth
)

Public function

bool

 

AddTrackedPointWithName

(
    const FTransform& WorldTransform,
    const FString& PointName,
    bool bDeletePointsWithSameName
)

Public function

bool

 

ArePinsReadyToLoad()

Public function

void

 

ClearOnTrackableAddedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function

void

 

ClearOnTrackableAddedDelegates

(
    void* Object
)

Public function

void

 

ClearOnTrackableRemovedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function

void

 

ClearOnTrackableRemovedDelegates

(
    void* Object
)

Public function

void

 

ClearOnTrackableUpdatedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function

void

 

ClearOnTrackableUpdatedDelegates

(
    void* Object
)

Public function Const

const FTrans...

 

GetAlignmentTransform()

Public function Const

TArray< UARP...

 

GetAllPins()

Public function Const

TArray< UART...

 

GetAllTrackedGeometries()

Public function

void *

 

GetARSessionRawPointer()

Public function Const

FARSessionSt...

 

GetARSessionStatus()

Public function Const

UARTexture &...

 

GetARTexture

(
    EARTextureType TextureType
)

Public function Const

bool

 

GetCameraIntrinsics

(
    FARCameraIntrinsics& OutCameraIntr...
)

Public function Const

TSharedPtr< ...

 

GetCandidateObject

(
    FVector Location,
    FVector Extent
)

Creates an async task that will perform the work in the background

Public function Const

UARLightEsti...

 

GetCurrentLightEstimate()

Public function

void *

 

GetGameThreadARFrameRawPointer()

Public function Static

FName

 

GetModularFeatureName()

Public function Const

int32

 

GetNumberOfTrackedFacesSupported()

Public function Const

TArray< FVec...

 

GetPointCloud()

Public function Const

const UARSes...

 

GetSessionConfig()

Public function Const

TArray< FARV...

 

GetSupportedVideoFormats

(
    EARSessionType SessionType
)

Public function Const

TArray< FARP...

 

GetTracked2DPose()

Public function Const

EARTrackingQ...

 

GetTrackingQuality()

Public function Const

EARTrackingQ...

 

GetTrackingQualityReason()

Public function Const

EARWorldMapp...

 

GetWorldMappingStatus()

Public function

IXRTrackingS...

 

GetXRTrackingSystem()

Public function

void

 

InitializeARSystem()

Public function Const

bool

 

IsARAvailable()

Public function Const

bool

 

IsEnvironmentCaptureSupported()

Public function Const

bool

 

IsLocalPinSaveSupported()

Public function Const

bool

 

IsSceneReconstructionSupported

(
    EARSessionType SessionType,
    EARSceneReconstruction SceneReconst...
)

Public function Const

bool

 

IsSessionTrackingFeatureSupported

(
    EARSessionType SessionType,
    EARSessionTrackingFeature SessionTr...
)

Public function Const

bool

 

IsSessionTypeSupported

(
    EARSessionType SessionType
)

Public function

TArray< FART...

 

LineTraceTrackedObjects

(
    const FVector Start,
    const FVector End,
    EARLineTraceChannels TraceChannels
)

Public function

TArray< FART...

 

LineTraceTrackedObjects

(
    const FVector2D ScreenCoords,
    EARLineTraceChannels TraceChannels
)

Public function

void

 

LoadARPins

(
    TMap< FName, UARPin* >& Loade...
)

Public function

void

 

PauseARSession()

Public function

bool

 

PinComponent

(
    USceneComponent* ComponentToPi...,
    UARPin* Pin
)

Pin Interface

Public function

UARPin *

 

PinComponent

(
    USceneComponent* ComponentToPi...,
    const FTransform& PinToWorldTransf...,
    UARTrackedGeometry* TrackedGeo...,
    const FName DebugName
)

Public function

UARPin *

 

PinComponent

(
    USceneComponent* ComponentToPi...,
    const FARTraceResult& HitResult,
    const FName DebugName
)

Public function

void

 

RemoveAllSavedARPins()

Public function

void

 

RemovePin

(
    UARPin* PinToRemove
)

Public function

void

 

RemoveSavedARPin

(
    FName InName
)

Public function

FIntPoint

 

ResizeXRCamera

(
    const FIntPoint& InSize
)

Public function

bool

 

SaveARPin

(
    FName InName,
    UARPin* InPin
)

Public function Const

TSharedPtr< ...

 

SaveWorld()

Creates an async task that will perform the work in the background

Public function

void

 

SetAlignmentTransform

(
    const FTransform& InAlignmentTrans...
)

Public function

void

 

SetEnabledXRCamera

(
    bool bOnOff
)

Public function

bool

 

StartARGameFrame

(
    FWorldContext& WorldContext
)

Public function

void

 

StartARSession

(
    UARSessionConfig* InSessionCon...
)

Public function

void

 

StopARSession()

Public function

bool

 

ToggleARCapture

(
    const bool bOnOff,
    const EARCaptureType CaptureType
)

Public function

bool

 

TryGetOrCreatePinForNativeResource

(
    void* InNativeResource,
    const FString& InAnchorName,
    UARPin*& OutAnchor
)

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.