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 > Runtime > AugmentedReality > IARSystemSupport

Light Theme

Dark Theme

IARSystemSupport

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

Windows

MacOS

Linux

Inheritance Hierarchy

IARSystemSupport

	FARSystemProxy
	FARSystemSupportBase

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

	Name	Description
	~IARSystemSupport()

Functions

	Name	Description
FDelegateHan...	AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate& D... )
FDelegateHan...	AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate&... )
FDelegateHan...	AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate&... )
bool	ArePinsReadyToLoad()
void	ClearOnTrackableAddedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableAddedDelegates ( void* Object )
void	ClearOnTrackableRemovedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableRemovedDelegates ( void* Object )
void	ClearOnTrackableUpdatedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableUpdatedDelegates ( void* Object )
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	IsLocalPinSaveSupported()	ARPin Local Store support.
void	LoadARPins ( TMap< FName, UARPin* >& Loade... )
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
bool	OnAddTrackedPointWithName ( const FTransform& WorldTransform, const FString& PointName, bool bDeletePointsWithSameName )
void	OnARSystemInitialized()	Invoked after the base AR system has been initialized.
TArray< UARP...	OnGetAllPins()
TArray< UART...	OnGetAllTrackedGeometries()
FARSessionSt...	OnGetARSessionStatus()
UARTexture &...	OnGetARTexture ( EARTextureType TextureType )
bool	OnGetCameraIntrinsics ( FARCameraIntrinsics& OutCameraIntr... )
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()
int32	OnGetNumberOfTrackedFacesSupported()
TArray< FVec...	OnGetPointCloud()
TArray< FARV...	OnGetSupportedVideoFormats ( EARSessionType SessionType )
TArray< FARP...	OnGetTracked2DPose()
EARTrackingQ...	OnGetTrackingQuality()
EARTrackingQ...	OnGetTrackingQualityReason()
EARWorldMapp...	OnGetWorldMappingStatus()
bool	OnIsSceneReconstructionSupported ( EARSessionType SessionType, EARSceneReconstruction SceneReconst... )
bool	OnIsSessionTrackingFeatureSupported ( EARSessionType SessionType, EARSessionTrackingFeature SessionTr... )
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.
FIntPoint	OnResizeXRCamera ( const FIntPoint& InSize )
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	OnSetEnabledXRCamera ( bool bOnOff )
bool	OnStartARGameFrame ( FWorldContext& WorldContext )
void	OnStartARSession ( UARSessionConfig* SessionConfi... )	Start the AR system.
void	OnStopARSession()	Stop the AR system and reset its internal state; this task must succeed.
bool	OnToggleARCapture ( const bool bOnOff, const EARCaptureType CaptureType )
bool	OnTryGetOrCreatePinForNativeResource ( void* InNativeResource, const FString& InPinName, UARPin*& OutPin )	Given the platform specific native resource for a pin, create a pin.
void	RemoveAllSavedARPins()
void	RemoveSavedARPin ( FName InName )
bool	SaveARPin ( FName InName, UARPin* InPin )
void	TriggerOnTrackableAddedDelegates ( UARTrackedGeometry* Param1 )
void	TriggerOnTrackableRemovedDelegates ( UARTrackedGeometry* Param1 )
void	TriggerOnTrackableUpdatedDelegates ( UARTrackedGeometry* Param1 )

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

Take our survey

Dismiss