Navigation
API > API/Runtime > API/Runtime/AugmentedReality
Composition Components for tracking system features
| Name | FARSupportInterface |
| Type | class |
| Header File | /Engine/Source/Runtime/AugmentedReality/Public/ARSupportInterface.h |
| Include Path | #include "ARSupportInterface.h" |
Syntax
class FARSupportInterface :
public TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe >,
public FGCObject,
public IModularFeature
Inheritance Hierarchy
- TSharedFromThis< FARSupportInterface, ESPMode::ThreadSafe > → FARSupportInterface
- FGCObject → FARSupportInterface
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FARSupportInterface
(
IARSystemSupport* InARImplementation, |
ARSupportInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FARSupportInterface() |
ARSupportInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnAlignmentTransformUpdated | FARSystemOnAlignmentTransformUpdated | ARSupportInterface.h | ||
| OnARSessionStarted | FARSystemOnSessionStarted | ARSupportInterface.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AlignmentTransform | FTransform | Alignment transform between AR System's tracking space and Unreal's World Space. | ARSupportInterface.h | |
| ARImplemention | IARSystemSupport * | ARSupportInterface.h | ||
| ARSettings | TObjectPtr< UARSessionConfig > | ARSupportInterface.h | ||
| XRTrackingSystem | IXRTrackingSystem * | ARSupportInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UARSessionConfig & AccessSessionConfig() |
ARSupportInterface.h | ||
bool AddManualEnvironmentCaptureProbe
(
FVector Location, |
ARSupportInterface.h | ||
FDelegateHandle AddOnTrackableAddedDelegate_Handle
(
const FOnTrackableAddedDelegate& Delegate |
Pass through helpers to create the methods needed to add/remove delegates from the AR system. | ARSupportInterface.h | |
FDelegateHandle AddOnTrackableRemovedDelegate_Handle
(
const FOnTrackableRemovedDelegate& Delegate |
ARSupportInterface.h | ||
FDelegateHandle AddOnTrackableUpdatedDelegate_Handle
(
const FOnTrackableUpdatedDelegate& Delegate |
ARSupportInterface.h | ||
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
ARSupportInterface.h | ||
UARCandidateImage * AddRuntimeCandidateImage
(
UARSessionConfig* SessionConfig, |
ARSupportInterface.h | ||
bool AddTrackedPointWithName
(
const FTransform& WorldTransform, |
ARSupportInterface.h | ||
bool ArePinsReadyToLoad() |
ARSupportInterface.h | ||
void ClearOnTrackableAddedDelegate_Handle
(
FDelegateHandle& Handle |
ARSupportInterface.h | ||
void ClearOnTrackableAddedDelegates
(
FDelegateUserObject Object |
ARSupportInterface.h | ||
void ClearOnTrackableRemovedDelegate_Handle
(
FDelegateHandle& Handle |
ARSupportInterface.h | ||
void ClearOnTrackableRemovedDelegates
(
FDelegateUserObject Object |
ARSupportInterface.h | ||
void ClearOnTrackableUpdatedDelegate_Handle
(
FDelegateHandle& Handle |
ARSupportInterface.h | ||
void ClearOnTrackableUpdatedDelegates
(
FDelegateUserObject Object |
ARSupportInterface.h | ||
const FTransform & GetAlignmentTransform() |
ARSupportInterface.h | ||
TArray< UARPin * > GetAllPins () |
ARSupportInterface.h | ||
TArray< UARTrackedGeometry * > GetAllTrackedGeometries () |
ARSupportInterface.h | ||
void * GetARSessionRawPointer() |
ARSupportInterface.h | ||
| ARSupportInterface.h | |||
UARTexture * GetARTexture
(
EARTextureType TextureType |
ARSupportInterface.h | ||
bool GetCameraIntrinsics
(
FARCameraIntrinsics& OutCameraIntrinsics |
ARSupportInterface.h | ||
TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > GetCandidateObject
(
FVector Location, |
Creates an async task that will perform the work in the background | ARSupportInterface.h | |
| ARSupportInterface.h | |||
void * GetGameThreadARFrameRawPointer() |
ARSupportInterface.h | ||
int32 GetNumberOfTrackedFacesSupported () |
ARSupportInterface.h | ||
TArray< FVector > GetPointCloud() |
ARSupportInterface.h | ||
virtual FString GetReferencerName() |
ARSupportInterface.h | ||
const UARSessionConfig & GetSessionConfig() |
ARSupportInterface.h | ||
TArray< FARVideoFormat > GetSupportedVideoFormats
(
EARSessionType SessionType |
ARSupportInterface.h | ||
TArray< FARPose2D > GetTracked2DPose () |
ARSupportInterface.h | ||
| ARSupportInterface.h | |||
| ARSupportInterface.h | |||
EARWorldMappingState GetWorldMappingStatus() |
ARSupportInterface.h | ||
IXRTrackingSystem * GetXRTrackingSystem() |
ARSupportInterface.h | ||
void InitializeARSystem() |
ARSupportInterface.h | ||
bool IsARAvailable () |
ARSupportInterface.h | ||
bool IsEnvironmentCaptureSupported () |
ARSupportInterface.h | ||
bool IsLocalPinSaveSupported() |
ARSupportInterface.h | ||
bool IsSceneReconstructionSupported
(
EARSessionType SessionType, |
ARSupportInterface.h | ||
bool IsSessionTrackingFeatureSupported
(
EARSessionType SessionType, |
ARSupportInterface.h | ||
bool IsSessionTypeSupported
(
EARSessionType SessionType |
ARSupportInterface.h | ||
TArray< FARTraceResult > LineTraceTrackedObjects
(
const FVector Start, |
ARSupportInterface.h | ||
TArray< FARTraceResult > LineTraceTrackedObjects
(
const FVector2D ScreenCoords, |
ARSupportInterface.h | ||
void LoadARPins
(
TMap< FName, UARPin* >& LoadedPins |
ARSupportInterface.h | ||
void PauseARSession () |
ARSupportInterface.h | ||
bool PinComponent
(
USceneComponent* ComponentToPin, |
Pin Interface | ARSupportInterface.h | |
UARPin * PinComponent
(
USceneComponent* ComponentToPin, |
ARSupportInterface.h | ||
UARPin * PinComponent
(
USceneComponent* ComponentToPin, |
ARSupportInterface.h | ||
void RemoveAllSavedARPins() |
ARSupportInterface.h | ||
| ARSupportInterface.h | |||
void RemoveSavedARPin
(
FName InName |
ARSupportInterface.h | ||
FIntPoint ResizeXRCamera
(
const FIntPoint& InSize |
ARSupportInterface.h | ||
bool SaveARPin
(
FName InName, |
ARSupportInterface.h | ||
TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > SaveWorld() |
Creates an async task that will perform the work in the background | ARSupportInterface.h | |
void SetAlignmentTransform
(
const FTransform& InAlignmentTransform |
ARSupportInterface.h | ||
void SetEnabledXRCamera
(
bool bOnOff |
ARSupportInterface.h | ||
bool StartARGameFrame
(
FWorldContext& WorldContext |
ARSupportInterface.h | ||
void StartARSession
(
UARSessionConfig* InSessionConfig |
ARSupportInterface.h | ||
void StopARSession () |
ARSupportInterface.h | ||
bool ToggleARCapture
(
const bool bOnOff, |
ARSupportInterface.h | ||
bool TryGetOrCreatePinForNativeResource
(
void* InNativeResource, |
ARSupportInterface.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetModularFeatureName() |
ARSupportInterface.h |