UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FARSupportInterface Class Reference

#include <ARSupportInterface.h>

+ Inheritance diagram for FARSupportInterface:

Public Member Functions

UE_API FARSupportInterface (IARSystemSupport *InARImplementation, IXRTrackingSystem *InXRTrackingSystem)
 
virtual UE_API ~FARSupportInterface ()
 
UE_API void InitializeARSystem ()
 
UE_API IXRTrackingSystem * GetXRTrackingSystem ()
 
UE_API bool StartARGameFrame (FWorldContext &WorldContext)
 
UE_API const FTransform & GetAlignmentTransform () const
 
UE_API const UARSessionConfig & GetSessionConfig () const
 
UE_API UARSessionConfig & AccessSessionConfig ()
 
UE_API EARTrackingQuality GetTrackingQuality () const
 
UE_API EARTrackingQualityReason GetTrackingQualityReason () const
 
UE_API void StartARSession (UARSessionConfig *InSessionConfig)
 
UE_API void PauseARSession ()
 
UE_API void StopARSession ()
 
UE_API FARSessionStatus GetARSessionStatus () const
 
UE_API bool IsSessionTypeSupported (EARSessionType SessionType) const
 
UE_API bool ToggleARCapture (const bool bOnOff, const EARCaptureType CaptureType)
 
UE_API void SetEnabledXRCamera (bool bOnOff)
 
UE_API FIntPoint ResizeXRCamera (const FIntPoint &InSize)
 
UE_API void SetAlignmentTransform (const FTransform &InAlignmentTransform)
 
UE_API TArray< FARTraceResult > LineTraceTrackedObjects (const FVector2D ScreenCoords, EARLineTraceChannels TraceChannels)
 
UE_API TArray< FARTraceResult > LineTraceTrackedObjects (const FVector Start, const FVector End, EARLineTraceChannels TraceChannels)
 
UE_API TArray< UARTrackedGeometry * > GetAllTrackedGeometries () const
 
UE_API TArray< UARPin * > GetAllPins () const
 
UE_API bool IsEnvironmentCaptureSupported () const
 
UE_API bool AddManualEnvironmentCaptureProbe (FVector Location, FVector Extent)
 
UE_API TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > GetCandidateObject (FVector Location, FVector Extent) const
 
UE_API TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > SaveWorld () const
 
UE_API EARWorldMappingState GetWorldMappingStatus () const
 
UE_API UARLightEstimate * GetCurrentLightEstimate () const
 
UE_API UARPin * PinComponent (USceneComponent *ComponentToPin, const FTransform &PinToWorldTransform, UARTrackedGeometry *TrackedGeometry=nullptr, const FName DebugName=NAME_None)
 
UE_API UARPin * PinComponent (USceneComponent *ComponentToPin, const FARTraceResult &HitResult, const FName DebugName=NAME_None)
 
UE_API void RemovePin (UARPin *PinToRemove)
 
UE_API bool TryGetOrCreatePinForNativeResource (void *InNativeResource, const FString &InAnchorName, UARPin *&OutAnchor)
 
UE_API TArray< FARVideoFormat > GetSupportedVideoFormats (EARSessionType SessionType=EARSessionType::World) const
 
UE_API TArray< FVector > GetPointCloud () const
 
UE_API UARCandidateImage * AddRuntimeCandidateImage (UARSessionConfig *SessionConfig, UTexture2D *CandidateTexture, FString FriendlyName, float PhysicalWidth)
 
UE_API void * GetARSessionRawPointer ()
 
UE_API void * GetGameThreadARFrameRawPointer ()
 
UE_API bool IsSessionTrackingFeatureSupported (EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature) const
 
UE_API TArray< FARPose2D > GetTracked2DPose () const
 
UE_API bool IsSceneReconstructionSupported (EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod) const
 
UE_API bool AddTrackedPointWithName (const FTransform &WorldTransform, const FString &PointName, bool bDeletePointsWithSameName)
 
UE_API int32 GetNumberOfTrackedFacesSupported () const
 
UE_API UARTexture * GetARTexture (EARTextureType TextureType) const
 
UE_API bool GetCameraIntrinsics (FARCameraIntrinsics &OutCameraIntrinsics) const
 
UE_API bool IsARAvailable () const
 
virtual UE_API void AddReferencedObjects (FReferenceCollector &Collector) override
 
virtual FString GetReferencerName () const override
 
UE_API bool PinComponent (USceneComponent *ComponentToPin, UARPin *Pin)
 
UE_API bool IsLocalPinSaveSupported () const
 
UE_API bool ArePinsReadyToLoad ()
 
UE_API void LoadARPins (TMap< FName, UARPin * > &LoadedPins)
 
UE_API bool SaveARPin (FName InName, UARPin *InPin)
 
UE_API void RemoveSavedARPin (FName InName)
 
UE_API void RemoveAllSavedARPins ()
 
- Public Member Functions inherited from TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe >
TSharedRef< FARSupportInterface, Mode > AsShared ()
 
TSharedRef< FARSupportInterface const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FARSupportInterface, Mode > AsWeak ()
 
TWeakPtr< FARSupportInterface const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 
- Public Member Functions inherited from FGCObject
 FGCObject ()
 
 FGCObject (const FGCObject &Other)
 
 FGCObject (FGCObject &&Other)
 
 FGCObject (EFlags Flags)
 
virtual ~FGCObject ()
 
FGCObject & operator= (const FGCObject &)
 
FGCObject & operator= (FGCObject &&)
 
COREUOBJECT_API void RegisterGCObject ()
 
COREUOBJECT_API void UnregisterGCObject ()
 
virtual bool GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const
 

Static Public Member Functions

static FName GetModularFeatureName ()
 
- Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void StaticInit ()
 

Public Attributes

FARSystemOnSessionStarted OnARSessionStarted
 
FARSystemOnAlignmentTransformUpdated OnAlignmentTransformUpdated
 

Additional Inherited Members

- Public Types inherited from FGCObject
enum class  EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
 
- Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer * GGCObjectReferencer = nullptr
 
- Protected Member Functions inherited from TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Composition Components for tracking system features

Constructor & Destructor Documentation

◆ FARSupportInterface()

FARSupportInterface::FARSupportInterface ( IARSystemSupport *  InARImplementation,
IXRTrackingSystem *  InXRTrackingSystem 
)

◆ ~FARSupportInterface()

FARSupportInterface::~FARSupportInterface ( )
virtual

Member Function Documentation

◆ AccessSessionConfig()

UARSessionConfig & FARSupportInterface::AccessSessionConfig ( )

◆ AddManualEnvironmentCaptureProbe()

bool FARSupportInterface::AddManualEnvironmentCaptureProbe ( FVector  Location,
FVector  Extent 
)
See also
UARBlueprintLibrary::AddEnvironmentCaptureProbe()

◆ AddReferencedObjects()

void FARSupportInterface::AddReferencedObjects ( FReferenceCollector &  Collector)
overridevirtual

Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

Parameters
CollectorThe collector of referenced objects.

Implements FGCObject.

◆ AddRuntimeCandidateImage()

UARCandidateImage * FARSupportInterface::AddRuntimeCandidateImage ( UARSessionConfig *  SessionConfig,
UTexture2D *  CandidateTexture,
FString  FriendlyName,
float  PhysicalWidth 
)
See also
UARBlueprintLibrary::AddRuntimeCandidateImage()

◆ AddTrackedPointWithName()

bool FARSupportInterface::AddTrackedPointWithName ( const FTransform &  WorldTransform,
const FString &  PointName,
bool  bDeletePointsWithSameName 
)
See also
UARBlueprintLibrary::AddTrackedPointWithName()

◆ ArePinsReadyToLoad()

bool FARSupportInterface::ArePinsReadyToLoad ( )

◆ GetAlignmentTransform()

const FTransform & FARSupportInterface::GetAlignmentTransform ( ) const

◆ GetAllPins()

TArray< UARPin * > FARSupportInterface::GetAllPins ( ) const
See also
UARBlueprintLibrary::GetAllPins()

◆ GetAllTrackedGeometries()

TArray< UARTrackedGeometry * > FARSupportInterface::GetAllTrackedGeometries ( ) const
See also
UARBlueprintLibrary::GetAllTrackedGeometries()

◆ GetARSessionRawPointer()

void * FARSupportInterface::GetARSessionRawPointer ( )

◆ GetARSessionStatus()

FARSessionStatus FARSupportInterface::GetARSessionStatus ( ) const
See also
UARBlueprintLibrary::GetARSessionStatus()

◆ GetARTexture()

UARTexture * FARSupportInterface::GetARTexture ( EARTextureType  TextureType) const
See also
UARBlueprintLibrary::GetARTexture()

◆ GetCameraIntrinsics()

bool FARSupportInterface::GetCameraIntrinsics ( FARCameraIntrinsics &  OutCameraIntrinsics) const
See also
UARBlueprintLibrary::GetCameraIntrinsics()

◆ GetCandidateObject()

TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > FARSupportInterface::GetCandidateObject ( FVector  Location,
FVector  Extent 
) const

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

◆ GetCurrentLightEstimate()

UARLightEstimate * FARSupportInterface::GetCurrentLightEstimate ( ) const
See also
UARBlueprintLibrary::GetCurrentLightEstimate()

◆ GetGameThreadARFrameRawPointer()

void * FARSupportInterface::GetGameThreadARFrameRawPointer ( )

◆ GetModularFeatureName()

static FName FARSupportInterface::GetModularFeatureName ( )
inlinestatic

◆ GetNumberOfTrackedFacesSupported()

int32 FARSupportInterface::GetNumberOfTrackedFacesSupported ( ) const
See also
UARBlueprintLibrary::GetNumberOfTrackedFacesSupported()

◆ GetPointCloud()

TArray< FVector > FARSupportInterface::GetPointCloud ( ) const
Returns
the current point cloud data for the ar scene

◆ GetReferencerName()

virtual FString FARSupportInterface::GetReferencerName ( ) const
inlineoverridevirtual

Overload this method to report a name for your referencer

Implements FGCObject.

◆ GetSessionConfig()

const UARSessionConfig & FARSupportInterface::GetSessionConfig ( ) const

◆ GetSupportedVideoFormats()

TArray< FARVideoFormat > FARSupportInterface::GetSupportedVideoFormats ( EARSessionType  SessionType = EARSessionType::World) const
See also
UARBlueprintLibrary::GetSupportedVideoFormats()

◆ GetTracked2DPose()

TArray< FARPose2D > FARSupportInterface::GetTracked2DPose ( ) const
See also
UARBlueprintLibrary::GetTracked2DPose()

◆ GetTrackingQuality()

EARTrackingQuality FARSupportInterface::GetTrackingQuality ( ) const
See also
UARBlueprintLibrary::GetTrackingQuality()

◆ GetTrackingQualityReason()

EARTrackingQualityReason FARSupportInterface::GetTrackingQualityReason ( ) const
See also
UARBlueprintLibrary::GetTrackingQualityReason()

◆ GetWorldMappingStatus()

EARWorldMappingState FARSupportInterface::GetWorldMappingStatus ( ) const
Returns
the current mapping status

◆ GetXRTrackingSystem()

IXRTrackingSystem * FARSupportInterface::GetXRTrackingSystem ( )

◆ InitializeARSystem()

void FARSupportInterface::InitializeARSystem ( )

◆ IsARAvailable()

bool FARSupportInterface::IsARAvailable ( ) const
See also
UARBlueprintLibrary::IsARSupported()

◆ IsEnvironmentCaptureSupported()

UE_API bool FARSupportInterface::IsEnvironmentCaptureSupported ( ) const
See also
UARBlueprintLibrary::IsEnvironmentCaptureSupported()

◆ IsLocalPinSaveSupported()

bool FARSupportInterface::IsLocalPinSaveSupported ( ) const

◆ IsSceneReconstructionSupported()

bool FARSupportInterface::IsSceneReconstructionSupported ( EARSessionType  SessionType,
EARSceneReconstruction  SceneReconstructionMethod 
) const
See also
UARBlueprintLibrary::IsSceneReconstructionSupported()

◆ IsSessionTrackingFeatureSupported()

bool FARSupportInterface::IsSessionTrackingFeatureSupported ( EARSessionType  SessionType,
EARSessionTrackingFeature  SessionTrackingFeature 
) const
See also
UARBlueprintLibrary::IsSessionTrackingFeatureSupported()

◆ IsSessionTypeSupported()

bool FARSupportInterface::IsSessionTypeSupported ( EARSessionType  SessionType) const
See also
UARBlueprintLibrary::IsSessionTypeSupported()

◆ LineTraceTrackedObjects() [1/2]

TArray< FARTraceResult > FARSupportInterface::LineTraceTrackedObjects ( const FVector  Start,
const FVector  End,
EARLineTraceChannels  TraceChannels 
)
See also
UARBlueprintLibrary::LineTraceTrackedObjects()

◆ LineTraceTrackedObjects() [2/2]

TArray< FARTraceResult > FARSupportInterface::LineTraceTrackedObjects ( const FVector2D  ScreenCoords,
EARLineTraceChannels  TraceChannels 
)
See also
UARBlueprintLibrary::LineTraceTrackedObjects()

◆ LoadARPins()

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

◆ PauseARSession()

void FARSupportInterface::PauseARSession ( )
See also
UARBlueprintLibrary::PauseARSession()

◆ PinComponent() [1/3]

UARPin * FARSupportInterface::PinComponent ( USceneComponent *  ComponentToPin,
const FARTraceResult &  HitResult,
const FName  DebugName = NAME_None 
)
See also
UARBlueprintLibrary::PinComponentToTraceResult()

◆ PinComponent() [2/3]

UARPin * FARSupportInterface::PinComponent ( USceneComponent *  ComponentToPin,
const FTransform &  PinToWorldTransform,
UARTrackedGeometry *  TrackedGeometry = nullptr,
const FName  DebugName = NAME_None 
)
See also
UARBlueprintLibrary::PinComponent()

◆ PinComponent() [3/3]

bool FARSupportInterface::PinComponent ( USceneComponent *  ComponentToPin,
UARPin *  Pin 
)

Pin Interface

◆ RemoveAllSavedARPins()

void FARSupportInterface::RemoveAllSavedARPins ( )

◆ RemovePin()

void FARSupportInterface::RemovePin ( UARPin *  PinToRemove)
See also
UARBlueprintLibrary::RemovePin()

◆ RemoveSavedARPin()

void FARSupportInterface::RemoveSavedARPin ( FName  InName)

◆ ResizeXRCamera()

FIntPoint FARSupportInterface::ResizeXRCamera ( const FIntPoint &  InSize)
See also
UARBlueprintLibrary::ToggleARCapture()

◆ SaveARPin()

bool FARSupportInterface::SaveARPin ( FName  InName,
UARPin *  InPin 
)

◆ SaveWorld()

TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > FARSupportInterface::SaveWorld ( ) const

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

◆ SetAlignmentTransform()

void FARSupportInterface::SetAlignmentTransform ( const FTransform &  InAlignmentTransform)
See also
UARBlueprintLibrary::SetAlignmentTransform()
IARSystemSupport To understand the various spaces involved in Augmented Reality system,
IARSystemSupport.

◆ SetEnabledXRCamera()

void FARSupportInterface::SetEnabledXRCamera ( bool  bOnOff)
See also
UARBlueprintLibrary::ToggleARCapture()

◆ StartARGameFrame()

bool FARSupportInterface::StartARGameFrame ( FWorldContext &  WorldContext)

◆ StartARSession()

void FARSupportInterface::StartARSession ( UARSessionConfig *  InSessionConfig)
See also
UARBlueprintLibrary::StartARSession()

◆ StopARSession()

void FARSupportInterface::StopARSession ( )
See also
UARBlueprintLibrary::StopARSession()

◆ ToggleARCapture()

bool FARSupportInterface::ToggleARCapture ( const bool  bOnOff,
const EARCaptureType  CaptureType 
)
See also
UARBlueprintLibrary::ToggleARCapture()

◆ TryGetOrCreatePinForNativeResource()

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

Member Data Documentation

◆ OnAlignmentTransformUpdated

FARSystemOnAlignmentTransformUpdated FARSupportInterface::OnAlignmentTransformUpdated

◆ OnARSessionStarted

FARSystemOnSessionStarted FARSupportInterface::OnARSessionStarted
The documentation for this class was generated from the following files: