Navigation
| Name | AugmentedReality |
| Type | Runtime |
| Location | /Engine/Source/Runtime/AugmentedReality/ |
| Module Build Rules | AugmentedReality.Build.cs |
Classes
| Name | Remarks |
|---|---|
| AARActor | |
| AAROriginActor | Simple actor that is spawned at the origin for AR systems that want to hang components on an actor Spawned as a custom class for easier TObjectIterator use |
| AARSharedWorldGameMode | |
| AARSharedWorldGameState | |
| AARSharedWorldPlayerController | |
| AARSkyLight | This sky light class forces a refresh of the cube map data when an AR environment probe changes |
| FARAsyncTask | Base class for async AR requests |
| FARErrorGetCandidateObjectAsyncTask | |
| FARErrorSaveWorldAsyncTask | |
| FARGetCandidateObjectAsyncTask | Async task that builds a candidate object used for detection from the ar session |
| FARGetCandidateObjectPin | |
| FARSaveWorldAsyncTask | Async task that saves the world data into a buffer |
| FARSaveWorldPin | |
| FARSupportInterface | Composition Components for tracking system features |
| FARSystemSupportBase | |
| FCheckGeoTrackingAvailabilityAsyncTask | Async task to check Geo tracking availability. |
| FGetGeoLocationAsyncTask | Async task to convert Geo location. |
| FOnARTrackingStateChanged | |
| FOnARTransformUpdated | |
| FTrackableDelegate | |
| FTrackableEnvProbeDelegate | |
| FTrackableFaceDelegate | |
| FTrackableImageDelegate | |
| FTrackableObjectDelegate | |
| FTrackablePlaneDelegate | |
| FTrackablePointDelegate | |
| UARBaseAsyncTaskBlueprintProxy | |
| UARBasicLightEstimate | |
| UARBlueprintLibrary | |
| UARCandidateImage | An asset that points to an image to be detected in a scene and provides the size of the object in real life |
| UARCandidateObject | An asset that points to an object to be detected in a scene |
| UARComponent | ARComponent handles replication and visualization update for AR tracked geometries ARComponent is created in either multiplayer or local only environment |
| UARDependencyHandler | Helper class that allows the user to explicitly request AR service installation and permission granting. |
| UAREnvironmentCaptureProbe | A tracked environment texture probe that gives you a cube map for reflections |
| UAREnvironmentCaptureProbeTexture | Base class for all AR textures that represent the environment for lighting and reflection |
| UAREnvironmentProbeComponent | |
| UARFaceComponent | |
| UARFaceGeometry | |
| UARGeoAnchor | |
| UARGeoAnchorComponent | |
| UARGeoTrackingSupport | Interface class for Geo tracking related features. |
| UARGetCandidateObjectAsyncTaskBlueprintProxy | |
| UARImageComponent | |
| UARLifeCycleComponent | |
| UARLightEstimate | |
| UARMeshComponent | |
| UARMeshGeometry | |
| UARObjectComponent | |
| UARPin | |
| UARPlaneComponent | |
| UARPlaneGeometry | |
| UARPointComponent | |
| UARPoseComponent | |
| UARQRCodeComponent | |
| UARSaveWorldAsyncTaskBlueprintProxy | |
| UARSessionConfig | An Unreal Data Asset that defines what features are used in the AR session. |
| UARTexture | Base class for all AR texture types. |
| UARTextureCameraDepth | Base class for all AR textures that represent the camera depth data |
| UARTextureCameraImage | Base class for all AR textures that represent the camera image data |
| UARTraceResultDummy | |
| UARTraceResultLibrary | |
| UARTrackableNotifyComponent | Component used to listen to ar trackable object changes |
| UARTrackedGeometry | |
| UARTrackedImage | |
| UARTrackedObject | |
| UARTrackedPoint | |
| UARTrackedPose | |
| UARTrackedQRCode | |
| UARTypesDummyClass | |
| UCheckGeoTrackingAvailabilityAsyncTaskBlueprintProxy | Blueprint async task to check Geo tracking availability. |
| UGetGeoLocationAsyncTaskBlueprintProxy | Blueprint async task to convert Geo location. |
Structs
| Name | Remarks |
|---|---|
| FAccumulatedNormal | |
| FARCameraIntrinsics | AR camera intrinsics |
| FAREnvironmentProbeUpdatePayload | |
| FARFaceUpdatePayload | |
| FARGeoAnchorUpdatePayload | |
| FARImageUpdatePayload | |
| FARMeshUpdatePayload | |
| FARObjectUpdatePayload | |
| FARPlaneUpdatePayload | |
| FARPointUpdatePayload | |
| FARPose2D | Represents a human pose tracked in the 2D space |
| FARPose3D | Represents a human pose tracked in the 3D space |
| FARPoseUpdatePayload | |
| FARQRCodeUpdatePayload | |
| FARSessionPayload | |
| FARSessionStatus | The current state of the AR subsystem including an optional explanation string. |
| FARSharedWorldReplicationState | Per player information about what data has been sent to them |
| FARSkeletonDefinition | Represents a hierarchy of a human pose skeleton tracked by the AR system |
| FARTraceResult | A result of an intersection found during a hit-test. |
| FARVideoFormat | A specific AR video format |
| FTrackedGeometryGroup |
Interfaces
| Name | Remarks |
|---|---|
| IARRef | A reference to a system-level AR object |
| IARSessionConfigCookSupport | |
| IARSystemSupport | Implement IARSystemSupport for any platform that wants to be an Unreal Augmented Reality System. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FARBlendShapeMap | TMap< EARFaceBlendShape, float > | ARTrackable.h | |
| FARSystemOnAlignmentTransformUpdated | TMulticastDelegate_OneParam< void, const FTransform & > | ARSupportInterface.h | |
| FARSystemOnSessionStarted | TMulticastDelegate_NoParams< void > | ARSupportInterface.h | |
| FOnTrackableAdded | TMulticastDelegate_OneParam< void, UARTrackedGeometry * > | ARTypes.h | |
| FOnTrackableAddedDelegate | FOnTrackableAdded::FDelegate | ARTypes.h | |
| FOnTrackableRemoved | TMulticastDelegate_OneParam< void, UARTrackedGeometry * > | ARTypes.h | |
| FOnTrackableRemovedDelegate | FOnTrackableRemoved::FDelegate | ARTypes.h | |
| FOnTrackableUpdated | TMulticastDelegate_OneParam< void, UARTrackedGeometry * > | ARTypes.h | |
| FOnTrackableUpdatedDelegate | FOnTrackableUpdated::FDelegate | ARTypes.h |
Enums
Public
| Name | Remarks |
|---|---|
| EARAltitudeSource | |
| EARCandidateImageOrientation | Tells the image detection code how to assume the image is oriented |
| EARCaptureType | |
| EARDepthAccuracy | |
| EARDepthQuality | |
| EAREnvironmentCaptureProbeType | Options for how environment textures are generated. This feature is used by ARKit. |
| EAREye | |
| EARFaceBlendShape | |
| EARFaceTrackingDirection | |
| EARFaceTrackingUpdate | Options for the kind of data to update during Face Tracking. This feature is used by ARKit. |
| EARFaceTransformMixing | |
| EARFrameSyncMode | Options for how the Unreal frame synchronizes with camera image updates. |
| EARGeoTrackingAccuracy | |
| EARGeoTrackingState | |
| EARGeoTrackingStateReason | |
| EARJointTransformSpace | Describes the potential spaces in which the join transform can be defined with AR pose tracking |
| EARLightEstimationMode | Options for how light is estimated based on the camera capture. |
| EARLineTraceChannels | Channels that let users select which kind of tracked geometry to trace against. |
| EARObjectClassification | Indicates what type of object the scene understanding system thinks it is |
| EARPlaneDetectionMode | Options for how flat surfaces are detected. This feature is used by ARCore and ARKit. |
| EARPlaneOrientation | Describes the tracked plane orientation |
| EARSceneReconstruction | Options for how the scene should be reconstructed. This feature is used by ARKit. |
| EARServiceAvailability | |
| EARServiceInstallRequestResult | |
| EARServicePermissionRequestResult | |
| EARSessionConfigFlags | |
| EARSessionStatus | Describes the current status of the AR session. |
| EARSessionTrackingFeature | Options for more tracking features to be enabled for the session, in addition to what is already defined in the project’s @EARSessionType. |
| EARSessionType | Options for the tracking type of the session. |
| EARSpatialMeshUsageFlags | Indicates how the spatial mesh should be visualized |
| EARTextureType | |
| EARTrackingQuality | |
| EARTrackingQualityReason | |
| EARTrackingState | |
| EARWorldAlignment | Options for how the scene’s coordinate system is constructed. This feature is used by ARKit. |
| EARWorldMappingState | Gives feedback as to whether the AR data can be saved and relocalized or not |
| EFaceComponentDebugMode | |
| EGeoAnchorComponentDebugMode | |
| EImageComponentDebugMode | |
| EPlaneComponentDebugMode | |
| EPoseComponentDebugMode | |
| EQRCodeComponentDebugMode |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| ARSessionConfig.h | |||
| ARTypes.h |