Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AugmentedReality > FARSupportInterface

Light Theme

Dark Theme

FARSupportInterface

Composition Components for tracking system features

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FGCObject

IModularFeature

FARSupportInterface

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

		Name	Description
	FARSystemOnAlig...	OnAlignmentTransformUpdated
	FARSystemOnSess...	OnARSessionStarted

Constructors

	Name	Description
	FARSupportInterface ( IARSystemSupport* InARImplemen..., IXRTrackingSystem* InXRTrackin... )

Destructors

	Name	Description
	~FARSupportInterface()

Functions

	Name	Description
UARSessionCo...	AccessSessionConfig()
bool	AddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )
FDelegateHan...	AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate& D... )	Pass through helpers to create the methods needed to add/remove delegates from the AR system.
FDelegateHan...	AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate&... )
FDelegateHan...	AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate&... )
UARCandidate...	AddRuntimeCandidateImage ( UARSessionConfig* SessionConfi..., UTexture2D* CandidateTexture, FString FriendlyName, float PhysicalWidth )
void	ClearOnTrackableAddedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableAddedDelegates ( void* Object )
void	ClearOnTrackableRemovedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableRemovedDelegates ( void* Object )
void	ClearOnTrackableUpdatedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableUpdatedDelegates ( void* Object )
const FTrans...	GetAlignmentTransform()
TArray< UARP...	GetAllPins()
TArray< UART...	GetAllTrackedGeometries()
void *	GetARSessionRawPointer()
FARSessionSt...	GetARSessionStatus()
UARTextureCa...	GetCameraDepth()
UARTextureCa...	GetCameraImage()
TSharedPtr< ...	GetCandidateObject ( FVector Location, FVector Extent )	Creates an async task that will perform the work in the background
UARLightEsti...	GetCurrentLightEstimate()
void *	GetGameThreadARFrameRawPointer()
FName	GetModularFeatureName()
UARTextureCa...	GetPersonSegmentationDepthImage()
UARTextureCa...	GetPersonSegmentationImage()
TArray< FVec...	GetPointCloud()
const UARSes...	GetSessionConfig()
TArray< FARV...	GetSupportedVideoFormats ( EARSessionType SessionType )
TArray< FARP...	GetTracked2DPose()
EARTrackingQ...	GetTrackingQuality()
EARWorldMapp...	GetWorldMappingStatus()
IXRTrackingS...	GetXRTrackingSystem()
void	InitializeARSystem()
bool	IsEnvironmentCaptureSupported()
bool	IsSessionTrackingFeatureSupported ( EARSessionType SessionType, EARSessionTrackingFeature SessionTr... )
bool	IsSessionTypeSupported ( EARSessionType SessionType )
TArray< FART...	LineTraceTrackedObjects ( const FVector2D ScreenCoords, EARLineTraceChannels TraceChannels )
TArray< FART...	LineTraceTrackedObjects ( const FVector Start, const FVector End, EARLineTraceChannels TraceChannels )
void	PauseARSession()
UARPin *	PinComponent ( USceneComponent* ComponentToPi..., const FARTraceResult& HitResult, const FName DebugName )
UARPin *	PinComponent ( USceneComponent* ComponentToPi..., const FTransform& PinToWorldTransf..., UARTrackedGeometry* TrackedGeo..., const FName DebugName )
void	RemovePin ( UARPin* PinToRemove )
TSharedPtr< ...	SaveWorld()	Creates an async task that will perform the work in the background
void	SetAlignmentTransform ( const FTransform& InAlignmentTrans... )
bool	StartARGameFrame ( FWorldContext& WorldContext )
void	StartARSession ( UARSessionConfig* InSessionCon... )
void	StopARSession()

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss