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

#include <ARSystemSupportBase.h>

+ Inheritance diagram for FARSystemSupportBase:

Public Member Functions

virtual UE_API bool OnPinComponentToARPin (USceneComponent *ComponentToPin, UARPin *Pin) override
 
- Public Member Functions inherited from IARSystemSupport
virtual void OnARSystemInitialized ()
 
virtual bool OnStartARGameFrame (FWorldContext &WorldContext)
 
virtual EARTrackingQuality OnGetTrackingQuality () const =0
 
virtual EARTrackingQualityReason OnGetTrackingQualityReason () const =0
 
virtual void OnStartARSession (UARSessionConfig *SessionConfig)=0
 
virtual void OnPauseARSession ()=0
 
virtual void OnStopARSession ()=0
 
virtual FARSessionStatus OnGetARSessionStatus () const =0
 
virtual bool IsARAvailable () const =0
 
virtual void OnSetAlignmentTransform (const FTransform &InAlignmentTransform)=0
 
virtual TArray< FARTraceResult > OnLineTraceTrackedObjects (const FVector2D ScreenCoord, EARLineTraceChannels TraceChannels)=0
 
virtual TArray< FARTraceResult > OnLineTraceTrackedObjects (const FVector Start, const FVector End, EARLineTraceChannels TraceChannels)=0
 
virtual TArray< UARTrackedGeometry * > OnGetAllTrackedGeometries () const =0
 
virtual TArray< UARPin * > OnGetAllPins () const =0
 
virtual bool OnIsTrackingTypeSupported (EARSessionType SessionType) const =0
 
virtual bool OnToggleARCapture (const bool bOnOff, const EARCaptureType CaptureType)
 
virtual void OnSetEnabledXRCamera (bool bOnOff)
 
virtual FIntPoint OnResizeXRCamera (const FIntPoint &InSize)
 
virtual UARLightEstimate * OnGetCurrentLightEstimate () const =0
 
virtual UARPin * FindARPinByComponent (const USceneComponent *Component) const =0
 
virtual UARPin * OnPinComponent (USceneComponent *ComponentToPin, const FTransform &PinToWorldTransform, UARTrackedGeometry *TrackedGeometry=nullptr, const FName DebugName=NAME_None)=0
 
virtual void OnRemovePin (UARPin *PinToRemove)=0
 
virtual bool OnTryGetOrCreatePinForNativeResource (void *InNativeResource, const FString &InPinName, UARPin *&OutPin)
 
virtual bool OnAddManualEnvironmentCaptureProbe (FVector Location, FVector Extent)=0
 
virtual TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > OnGetCandidateObject (FVector Location, FVector Extent) const =0
 
virtual TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > OnSaveWorld () const =0
 
virtual EARWorldMappingState OnGetWorldMappingStatus () const =0
 
virtual TArray< FARVideoFormat > OnGetSupportedVideoFormats (EARSessionType SessionType) const =0
 
virtual TArray< FVector > OnGetPointCloud () const =0
 
virtual bool OnAddRuntimeCandidateImage (UARSessionConfig *SessionConfig, UTexture2D *CandidateTexture, FString FriendlyName, float PhysicalWidth)=0
 
virtual void * GetARSessionRawPointer ()=0
 
virtual void * GetGameThreadARFrameRawPointer ()=0
 
virtual bool OnIsSessionTrackingFeatureSupported (EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature) const
 
virtual TArray< FARPose2D > OnGetTracked2DPose () const
 
virtual bool OnIsSceneReconstructionSupported (EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod) const
 
virtual bool OnAddTrackedPointWithName (const FTransform &WorldTransform, const FString &PointName, bool bDeletePointsWithSameName)
 
virtual int32 OnGetNumberOfTrackedFacesSupported () const
 
virtual UARTexture * OnGetARTexture (EARTextureType TextureType) const
 
virtual ~IARSystemSupport ()
 
 DEFINE_AR_DELEGATE_ONE_PARAM (OnTrackableAdded, UARTrackedGeometry *)
 
 DEFINE_AR_DELEGATE_ONE_PARAM (OnTrackableUpdated, UARTrackedGeometry *)
 
 DEFINE_AR_DELEGATE_ONE_PARAM (OnTrackableRemoved, UARTrackedGeometry *)
 
virtual bool IsLocalPinSaveSupported () const
 
virtual bool ArePinsReadyToLoad ()
 
virtual void LoadARPins (TMap< FName, UARPin * > &LoadedPins)
 
virtual bool SaveARPin (FName InName, UARPin *InPin)
 
virtual void RemoveSavedARPin (FName InName)
 
virtual void RemoveAllSavedARPins ()
 
virtual bool OnGetCameraIntrinsics (FARCameraIntrinsics &OutCameraIntrinsics) const
 

Member Function Documentation

◆ OnPinComponentToARPin()

bool FARSystemSupportBase::OnPinComponentToARPin ( USceneComponent *  ComponentToPin,
UARPin *  Pin 
)
overridevirtual

Pin a component to an existing ARPin.
If the component is alreayd pinned it will first be removed from that pin, which will be left empty. If the target Pin is already in use the component previously pinned to it will be unpinned.

Returns
true if the operation was successful

Implements IARSystemSupport.

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