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 > Plugins > RemoteSession > Channels > FARSystemProxy

Light Theme

Dark Theme

FARSystemProxy

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

Windows

MacOS

Linux

Inheritance Hierarchy

IARSystemSupport

FGCObject

TSharedFromThis

FARSystemProxy

References

Module	RemoteSession
Header	/Engine/Plugins/Experimental/RemoteSession/Source/RemoteSession/Public/Channels/RemoteSessionARSystemChannel.h
Include	#include "Channels/RemoteSessionARSystemChannel.h"

Syntax

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

Remarks

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

Constructors

	Name	Description
	FARSystemProxy()	Only the factory method should construct this

Destructors

	Name	Description
	~FARSystemProxy()

Functions

	Name	Description
void	AddTrackable ( UARTrackedGeometry* Added )
void	Destroy()
TSharedPtr< ...	Get()
IARSystemSup...	GetARSystemPtr()
UARTrackedGe...	GetTrackable ( FGuid UniqueId )
void	NotifyUpdated ( UARTrackedGeometry* Updated )
UARTextureCa...	OnGetCameraDepth()
UARTextureCa...	OnGetCameraImage()
void	RemoveTrackable ( FGuid UniqueId )
void	SetSessionConfig ( UARSessionConfig* InConfig )
void	SetSupportedVideoFormats ( const TArray< FARVideoFormat >& In... )	Methods called by the message handlers.

Overridden from IARSystemSupport

	Name	Description
UARPin *	FindARPinByComponent ( const USceneComponent* Compone... )	Given a scene component find the ARPin which it is pinned by, if any.
void *	GetARSessionRawPointer()
void *	GetGameThreadARFrameRawPointer()
bool	IsARAvailable()	Returns true/false based on whether AR features are available
bool	OnAddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )	Tells the ARSystem to generate a capture probe at the specified location if supported
bool	OnAddRuntimeCandidateImage ( UARSessionConfig* SessionConfi..., UTexture2D* CandidateTexture, FString FriendlyName, float PhysicalWidth )	Add candidate image at runtime
TArray< UARP...	OnGetAllPins()
TArray< UART...	OnGetAllTrackedGeometries()
FARSessionSt...	OnGetARSessionStatus()
TSharedPtr< ...	OnGetCandidateObject ( FVector Location, FVector Extent )	Generates a UARCandidateObject from the point cloud data within the location and its extent using an async task
UARLightEsti...	OnGetCurrentLightEstimate()	Not supported methods
TArray< FVec...	OnGetPointCloud()
TArray< FARV...	OnGetSupportedVideoFormats ( EARSessionType SessionType )
EARTrackingQ...	OnGetTrackingQuality()
EARTrackingQ...	OnGetTrackingQualityReason()
EARWorldMapp...	OnGetWorldMappingStatus()
bool	OnIsTrackingTypeSupported ( EARSessionType SessionType )
TArray< FART...	OnLineTraceTrackedObjects ( const FVector2D ScreenCoord, EARLineTraceChannels TraceChannels )	Trace all the tracked geometries and determine which have been hit by a ray cast from `ScreenCoord_.
TArray< FART...	OnLineTraceTrackedObjects ( const FVector Start, const FVector End, EARLineTraceChannels TraceChannels )
void	OnPauseARSession()	Stop the AR system but leave its internal state intact.
UARPin *	OnPinComponent ( USceneComponent* ComponentToPi..., const FTransform& PinToWorldTransf..., UARTrackedGeometry* TrackedGeo..., const FName DebugName )	Pin an Unreal Component to a location in the world.
bool	OnPinComponentToARPin ( USceneComponent* ComponentToPi..., UARPin* Pin )	Pin a component to an existing ARPin.
void	OnRemovePin ( UARPin* PinToRemove )	Given a pin, remove it and stop updating the associated component based on the tracked geometry.
TSharedPtr< ...	OnSaveWorld()	Saves the AR world to a byte array using an async task
void	OnSetAlignmentTransform ( const FTransform& InAlignmentTrans... )	Set a transform that will align the Tracking Space origin to the World Space origin.
void	OnStartARSession ( UARSessionConfig* Config )	End todo block.
void	OnStopARSession()	Stop the AR system and reset its internal state; this task must succeed.

Overridden from FGCObject

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

Constants

Name	Description
FactoryInstance

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

Take our survey

Dismiss