1. Epic GamesDeveloper
  3. IARSystemSupport

IARSystemSupport

Implement [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) for any platform that wants to be an Unreal Augmented Reality System.

Unreal Engine C++ API Reference > Runtime > AugmentedReality

Inheritance Hierarchy

References

   
Module AugmentedReality
Header /Engine/Source/Runtime/AugmentedReality/Public/ARSystem.h
Include #include "ARSystem.h"

Syntax

class IARSystemSupport

Remarks

Implement IARSystemSupport for any platform that wants to be an Unreal Augmented Reality System. e.g. AppleARKit, GoogleARCore. This interface is included as part of the abstract class `FARSupportInterface_ . The functions you must override are coalesced here for clarity.

Augmented Reality Spaces

Engineers working on supporting Augmented Reality must be aware of three spaces:

TrackingSpace : This is the space defined by the underlying AR system (e.g. ARKit, ARCore, etc.) Unreal has no control over the origin of this space.

AlignedTrackingSpace : To regain control of TrackingSpace, Unreal applies the AlignmentTransform so bend TrackingSpace to its will. If you are implementing IARSystemSupport, you will need to understand this transform and apply it accordingly.

WorldSpace : This is Unreal's coordinate system. Coordinates from Tracking Space can be translated into WorldSpace by using the AlignmentTransform and the TrackingToWorldTransform.

* [TrackingSpace]--(AlignmentTransform)-->[AlignedTrackingSpace]--(TrackingToWorld)-->[WorldSpace] *

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle

AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate& Delegate
)

  
Public function Virtual FDelegateHandle

AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate& Delegate
)

  
Public function Virtual FDelegateHandle

AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate& Delegate
)

  
Public function Virtual bool  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Const UARPin *

FindARPinByComponent ( const USceneComponent* Component
)

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

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

  
Public function bool

OnAddManualEnvironmentCaptureProbe ( FVector Location,
FVector Extent
)

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

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

 Add candidate image at runtime
Public function Virtual bool

OnAddTrackedPointWithName ( const FTransform& WorldTransform,
const FString& PointName,
bool bDeletePointsWithSameName
)

  
Public function Virtual void Invoked after the base AR system has been initialized.
Public function Const TArray< UARPin * >  
Public function Const TArray< UARTrackedGeometry * >  
Public function Const FARSessionStatus  
Public function Virtual Const UARTexture *

OnGetARTexture ( EARTextureType TextureType
)

  
Public function Virtual Const bool

OnGetCameraIntrinsics ( FARCameraIntrinsics& OutCameraIntrinsics
)

  
Public function 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 Const UARLightEstimate *  
Public function Virtual Const int32  
Public function Const TArray< FVector >  
Public function Const TArray< FARVideoFormat >

OnGetSupportedVideoFormats ( EARSessionType SessionType
)

  
Public function Virtual Const TArray< FARPose2D >  
Public function Const EARTrackingQuality  
Public function Const EARTrackingQualityReason  
Public function Const EARWorldMappingState  
Public function Virtual Const bool

OnIsSceneReconstructionSupported ( EARSessionType SessionType,
EARSceneReconstruction SceneReconstructionMethod
)

  
Public function Virtual Const bool

OnIsSessionTrackingFeatureSupported ( EARSessionType SessionType,
EARSessionTrackingFeature SessionTrackingFeature
)

  
Public function Const bool

OnIsTrackingTypeSupported ( EARSessionType SessionType
)

  
Public function 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 TArray< FARTraceResult >

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

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

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

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

OnPinComponentToARPin ( USceneComponent* ComponentToPin,
UARPin* Pin
)

 Pin a component to an existing ARPin.
Public function void

OnRemovePin ( UARPin* PinToRemove
)

 Given a pin, remove it and stop updating the associated component based on the tracked geometry.
Public function Virtual FIntPoint

OnResizeXRCamera ( const FIntPoint& InSize
)

  
Public function Const TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > Saves the AR world to a byte array using an async task
Public function void

OnSetAlignmentTransform ( const FTransform& InAlignmentTransform
)

 Set a transform that will align the Tracking Space origin to the World Space origin.
Public function Virtual void

OnSetEnabledXRCamera ( bool bOnOff
)

  
Public function Virtual bool

OnStartARGameFrame ( FWorldContext& WorldContext
)

  
Public function void

OnStartARSession ( UARSessionConfig* SessionConfig
)

 Start the AR system.
Public function void Stop the AR system and reset its internal state; this task must succeed.
Public function Virtual bool

OnToggleARCapture ( const bool bOnOff,
const EARCaptureType CaptureType
)

  
Public function Virtual bool

OnTryGetOrCreatePinForNativeResource ( void* InNativeResource,
const FString& InPinName,
UARPin*& OutPin
)

 Given the platform specific native resource for a pin, create a pin.
Public function Virtual void  
Public function Virtual void

RemoveSavedARPin ( FName InName
)

  
Public function Virtual bool

SaveARPin ( FName InName,
UARPin* InPin
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page