FARSupportInterface

Composition Components for tracking system features

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

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

UARTextureCa...

 

GetCameraDepth()

Public function

UARTextureCa...

 

GetCameraImage()

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

TArray< FVec...

 

GetPointCloud()

Public function Const

const UARSes...

 

GetSessionConfig()

Public function Const

TArray< FARV...

 

GetSupportedVideoFormats

(
    EARSessionType SessionType
)

Public function Const

EARTrackingQ...

 

GetTrackingQuality()

Public function Const

EARWorldMapp...

 

GetWorldMappingStatus()

Public function

IXRTrackingS...

 

GetXRTrackingSystem()

Public function

void

 

InitializeARSystem()

Public function Const

bool

 

IsEnvironmentCaptureSupported()

Public function Const

bool

 

IsSessionTypeSupported

(
    EARSessionType SessionType
)

Public function

TArray< FART...

 

LineTraceTrackedObjects

(
    const FVector2D ScreenCoords,
    EARLineTraceChannels TraceChannels
)

Public function

TArray< FART...

 

LineTraceTrackedObjects

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

Public function

void

 

PauseARSession()

Public function

UARPin *

 

PinComponent

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

Public function

UARPin *

 

PinComponent

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

Public function

void

 

RemovePin

(
    UARPin* PinToRemove
)

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

bool

 

StartARGameFrame

(
    FWorldContext& WorldContext
)

Public function

void

 

StartARSession

(
    UARSessionConfig* InSessionCon...
)

Public function

void

 

StopARSession()

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback