1. Epic GamesDeveloper
  3. FARSystemProxy

FARSystemProxy

This class acts as if there is a AR system present on the desktop that is receiving data from a remote device

API > API/Plugins > API/Plugins/RemoteSession

This class acts as if there is a AR system present on the desktop that is receiving data from a remote device

   
Name FARSystemProxy
Type class
Header File /Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/Channels/RemoteSessionARSystemChannel.h
Include Path #include "Channels/RemoteSessionARSystemChannel.h"

Syntax

class FARSystemProxy :  
    public IARSystemSupport ,  
    public FGCObject ,  
    public TSharedFromThis< FARSystemProxy, ESPMode::ThreadSafe >

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FARSystemProxy()

 Only the factory method should construct this Channels/RemoteSessionARSystemChannel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FARSystemProxy()

   Channels/RemoteSessionARSystemChannel.h  

Constants

Name Type Remarks Include Path
FactoryInstance TSharedPtr< FARSystemProxy, ESPMode::ThreadSafe >   Channels/RemoteSessionARSystemChannel.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
SessionConfig TObjectPtr< UARSessionConfig > Used to return the session config object the remote is using Channels/RemoteSessionARSystemChannel.h  
SupportedFormats TArray< FARVideoFormat > The video formats that are supported Channels/RemoteSessionARSystemChannel.h  
TrackedGeometries TMap< FGuid, TObjectPtr< UARTrackedGeometry > > Map of unique ids to tracked geometries Channels/RemoteSessionARSystemChannel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTrackable ( UARTrackedGeometry* Added
)

   Channels/RemoteSessionARSystemChannel.h  

UARTrackedGeometry * GetTrackable ( FGuid UniqueId
)

   Channels/RemoteSessionARSystemChannel.h  

void NotifyUpdated ( UARTrackedGeometry* Updated
)

   Channels/RemoteSessionARSystemChannel.h  

virtual UARTextureCameraDepth * OnGetCameraDepth()

   Channels/RemoteSessionARSystemChannel.h  

virtual UARTextureCameraImage * OnGetCameraImage()

   Channels/RemoteSessionARSystemChannel.h  

void RemoveTrackable ( FGuid UniqueId
)

   Channels/RemoteSessionARSystemChannel.h  

void SetSessionConfig ( UARSessionConfig* InConfig
)

   Channels/RemoteSessionARSystemChannel.h  

void SetSupportedVideoFormats ( const TArray< FARVideoFormat >& InFormats
)

 Methods called by the message handlers. Channels/RemoteSessionARSystemChannel.h  

Overridden from IARSystemSupport

Name Remarks Include Path Unreal Specifiers

virtual UARPin * FindARPinByComponent ( const USceneComponent* Component
) const

   Channels/RemoteSessionARSystemChannel.h  

virtual void * GetARSessionRawPointer()

   Channels/RemoteSessionARSystemChannel.h  

virtual void * GetGameThreadARFrameRawPointer()

   Channels/RemoteSessionARSystemChannel.h  

virtual bool IsARAvailable()

 Returns true/false based on whether AR features are available Channels/RemoteSessionARSystemChannel.h  

virtual bool OnAddManualEnvironmentCaptureProbe ( FVector Location,
FVector Extent
)

   Channels/RemoteSessionARSystemChannel.h  

virtual bool OnAddRuntimeCandidateImage ( UARSessionConfig* Config,
UTexture2D* CandidateTexture,
FString FriendlyName,
float PhysicalWidth
)

   Channels/RemoteSessionARSystemChannel.h  

virtual TArray< UARPin * > OnGetAllPins()

   Channels/RemoteSessionARSystemChannel.h  

virtual TArray< UARTrackedGeometry * > OnGetAllTrackedGeometries()

   Channels/RemoteSessionARSystemChannel.h  

virtual FARSessionStatus OnGetARSessionStatus()

   Channels/RemoteSessionARSystemChannel.h  

virtual TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > OnGetCandidateObject ( FVector Location,
FVector Extent
) const

   Channels/RemoteSessionARSystemChannel.h  

virtual UARLightEstimate * OnGetCurrentLightEstimate()

 Not supported methods Channels/RemoteSessionARSystemChannel.h  

virtual TArray< FVector > OnGetPointCloud()

   Channels/RemoteSessionARSystemChannel.h  

virtual TArray< FARVideoFormat > OnGetSupportedVideoFormats ( EARSessionType SessionType
) const

   Channels/RemoteSessionARSystemChannel.h  

virtual EARTrackingQuality OnGetTrackingQuality()

   Channels/RemoteSessionARSystemChannel.h  

virtual EARTrackingQualityReason OnGetTrackingQualityReason()

   Channels/RemoteSessionARSystemChannel.h  

virtual EARWorldMappingState OnGetWorldMappingStatus()

   Channels/RemoteSessionARSystemChannel.h  

virtual bool OnIsTrackingTypeSupported ( EARSessionType SessionType
) const

   Channels/RemoteSessionARSystemChannel.h  

virtual TArray< FARTraceResult > OnLineTraceTrackedObjects ( const FVector2D ScreenCoord,
EARLineTraceChannels TraceChannels
)

   Channels/RemoteSessionARSystemChannel.h  

virtual TArray< FARTraceResult > OnLineTraceTrackedObjects ( const FVector Start,
const FVector End,
EARLineTraceChannels TraceChannels
)

   Channels/RemoteSessionARSystemChannel.h  

virtual void OnPauseARSession()

   Channels/RemoteSessionARSystemChannel.h  

virtual UARPin * OnPinComponent ( USceneComponent* ComponentToPin,
const FTransform& PinToWorldTransform,
UARTrackedGeometry* TrackedGeometry,
const FName DebugName
)

   Channels/RemoteSessionARSystemChannel.h  

virtual bool OnPinComponentToARPin ( USceneComponent* ComponentToPin,
UARPin* Pin
)

   Channels/RemoteSessionARSystemChannel.h  

virtual void OnRemovePin ( UARPin* PinToRemove
)

   Channels/RemoteSessionARSystemChannel.h  
  Channels/RemoteSessionARSystemChannel.h  

virtual void OnSetAlignmentTransform ( const FTransform& InAlignmentTransform
)

   Channels/RemoteSessionARSystemChannel.h  

virtual void OnStartARSession ( UARSessionConfig* Config
)

 End todo block. Channels/RemoteSessionARSystemChannel.h  

virtual void OnStopARSession()

   Channels/RemoteSessionARSystemChannel.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   Channels/RemoteSessionARSystemChannel.h  

virtual FString GetReferencerName()

   Channels/RemoteSessionARSystemChannel.h  

Static

Name Remarks Include Path Unreal Specifiers

static void Destroy()

   Channels/RemoteSessionARSystemChannel.h  
  Channels/RemoteSessionARSystemChannel.h  

static IARSystemSupport * GetARSystemPtr()

   Channels/RemoteSessionARSystemChannel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page