1. Epic GamesDeveloper
  3. FARSupportInterface

FARSupportInterface

Composition Components for tracking system features

Unreal Engine C++ API Reference > Runtime > AugmentedReality

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

  Type Name Description
Public variable FARSystemOnAlignmentTransformUpdated OnAlignmentTransformUpdated  
Public variable FARSystemOnSessionStarted OnARSessionStarted  

Constructors

  Type Name Description
Public function  

FARSupportInterface ( IARSystemSupport* InARImplementation,
IXRTrackingSystem* InXRTrackingSystem
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UARSessionConfig &  
Public function bool

AddManualEnvironmentCaptureProbe ( FVector Location,
FVector Extent
)

  
Public function FDelegateHandle

AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate& Delegate
)

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

AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate& Delegate
)

  
Public function FDelegateHandle

AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate& Delegate
)

  
Public function UARCandidateImage *

AddRuntimeCandidateImage ( UARSessionConfig* SessionConfig,
UTexture2D* CandidateTexture,
FString FriendlyName,
float PhysicalWidth
)

  
Public function bool

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

  
Public function bool  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function Const const FTransform &  
Public function Const TArray< UARPin * >  
Public function Const TArray< UARTrackedGeometry * >  
Public function void *  
Public function Const FARSessionStatus  
Public function Const UARTexture *

GetARTexture ( EARTextureType TextureType
)

  
Public function Const bool

GetCameraIntrinsics ( FARCameraIntrinsics& OutCameraIntrinsics
)

  
Public function Const TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe >

GetCandidateObject ( FVector Location,
FVector Extent
)

 Creates an async task that will perform the work in the background
Public function Const UARLightEstimate *  
Public function void *  
Public function Static FName  
Public function Const int32  
Public function Const TArray< FVector >  
Public function Const const UARSessionConfig &  
Public function Const TArray< FARVideoFormat >

GetSupportedVideoFormats ( EARSessionType SessionType
)

  
Public function Const TArray< FARPose2D >  
Public function Const EARTrackingQuality  
Public function Const EARTrackingQualityReason  
Public function Const EARWorldMappingState  
Public function IXRTrackingSystem *  
Public function void  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsSceneReconstructionSupported ( EARSessionType SessionType,
EARSceneReconstruction SceneReconstructionMethod
)

  
Public function Const bool

IsSessionTrackingFeatureSupported ( EARSessionType SessionType,
EARSessionTrackingFeature SessionTrackingFeature
)

  
Public function Const bool

IsSessionTypeSupported ( EARSessionType SessionType
)

  
Public function TArray< FARTraceResult >

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

  
Public function TArray< FARTraceResult >

LineTraceTrackedObjects ( const FVector2D ScreenCoords,
EARLineTraceChannels TraceChannels
)

  
Public function void

LoadARPins ( TMap< FName, UARPin* >& LoadedPins
)

  
Public function void  
Public function bool

PinComponent ( USceneComponent* ComponentToPin,
UARPin* Pin
)

 Pin Interface
Public function UARPin *

PinComponent ( USceneComponent* ComponentToPin,
const FTransform& PinToWorldTransform,
UARTrackedGeometry* TrackedGeometry,
const FName DebugName
)

  
Public function UARPin *

PinComponent ( USceneComponent* ComponentToPin,
const FARTraceResult& HitResult,
const FName DebugName
)

  
Public function void  
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< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > Creates an async task that will perform the work in the background
Public function void

SetAlignmentTransform ( const FTransform& InAlignmentTransform
)

  
Public function void

SetEnabledXRCamera ( bool bOnOff
)

  
Public function bool

StartARGameFrame ( FWorldContext& WorldContext
)

  
Public function void

StartARSession ( UARSessionConfig* InSessionConfig
)

  
Public function void  
Public function bool

ToggleARCapture ( const bool bOnOff,
const EARCaptureType CaptureType
)

  
Public function bool

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

  

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page