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

Unreal Engine C++ API Reference > Plugins > RemoteSession > Channels

Inheritance Hierarchy

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

  Type Name Description
Public function   Only the factory method should construct this

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function Static void

Destroy ()

  
Public function Static TSharedPtr< FARSystemProxy, ESPMode::ThreadSafe >

Get ()

  
Public function Static IARSystemSupport *  
Public function UARTrackedGeometry *

GetTrackable ( FGuid UniqueId
)

  
Public function void  
Public function Virtual UARTextureCameraDepth *  
Public function Virtual UARTextureCameraImage *  
Public function void

RemoveTrackable ( FGuid UniqueId
)

  
Public function void  
Public function void Methods called by the message handlers.

Overridden from IARSystemSupport

  Type Name Description
Public function Virtual Const UARPin *

FindARPinByComponent ( const USceneComponent* Component
)

 Given a scene component find the ARPin which it is pinned by, if any.
Public function Virtual void *  
Public function Virtual void *  
Public function Virtual Const bool Returns true/false based on whether AR features are available
Public function Virtual bool

OnAddManualEnvironmentCaptureProbe ( FVector Location,
FVector Extent
)

 Tells the ARSystem to generate a capture probe at the specified location if supported
Public function Virtual bool

OnAddRuntimeCandidateImage ( UARSessionConfig* SessionConfig,
UTexture2D* CandidateTexture,
FString FriendlyName,
float PhysicalWidth
)

 Add candidate image at runtime
Public function Virtual Const TArray< UARPin * >  
Public function Virtual Const TArray< UARTrackedGeometry * >  
Public function Virtual Const FARSessionStatus  
Public function Virtual Const TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe >

OnGetCandidateObject ( FVector Location,
FVector Extent
)

 Generates a UARCandidateObject from the point cloud data within the location and its extent using an async task
Public function Virtual Const UARLightEstimate * Not supported methods
Public function Virtual Const TArray< FVector >  
Public function Virtual Const TArray< FARVideoFormat >

OnGetSupportedVideoFormats ( EARSessionType SessionType
)

  
Public function Virtual Const EARTrackingQuality  
Public function Virtual Const EARTrackingQualityReason  
Public function Virtual Const EARWorldMappingState  
Public function Virtual Const bool

OnIsTrackingTypeSupported ( EARSessionType SessionType
)

  
Public function Virtual TArray< FARTraceResult >

OnLineTraceTrackedObjects ( const FVector2D ScreenCoord,
EARLineTraceChannels TraceChannels
)

 Trace all the tracked geometries and determine which have been hit by a ray cast from `ScreenCoord_.
Public function Virtual TArray< FARTraceResult >

OnLineTraceTrackedObjects ( const FVector Start,
const FVector End,
EARLineTraceChannels TraceChannels
)

  
Public function Virtual void Stop the AR system but leave its internal state intact.
Public function Virtual UARPin *

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

 Pin an Unreal Component to a location in the world.
Public function Virtual bool

OnPinComponentToARPin ( USceneComponent* ComponentToPin,
UARPin* Pin
)

 Pin a component to an existing ARPin.
Public function Virtual void

OnRemovePin ( UARPin* PinToRemove
)

 Given a pin, remove it and stop updating the associated component based on the tracked geometry.
Public function Virtual Const TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > Saves the AR world to a byte array using an async task
Public function Virtual void

OnSetAlignmentTransform ( const FTransform& InAlignmentTransform
)

 Set a transform that will align the Tracking Space origin to the World Space origin.
Public function Virtual void End todo block.
Public function Virtual void Stop the AR system and reset its internal state; this task must succeed.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Constants

Name Description
FactoryInstance  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page