1. Epic GamesDeveloper
  3. AugmentedReality

AugmentedReality

Unreal Engine C++ API Reference > Runtime

Classes

  Type Name Description
Public class UClass BlueprintType category, experimental AARActor    
Public class UClass BlueprintType 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  
Public class UClass BlueprintType AARSharedWorldGameMode    
Public class UClass BlueprintType AARSharedWorldGameState    
Public class UClass AARSharedWorldPlayerController    
Public class UClass AARSkyLight This sky light class forces a refresh of the cube map data when an AR environment probe changes  
Public struct FAccumulatedNormal    
Public class FARAsyncTask Base class for async AR requests  
Public struct UStruct BlueprintType FARCameraIntrinsics AR camera intrinsics  
Public struct UStruct BlueprintType category FAREnvironmentProbeUpdatePayload    
Public class FARErrorGetCandidateObjectAsyncTask    
Public class FARErrorSaveWorldAsyncTask    
Public struct UStruct BlueprintType category FARFaceUpdatePayload    
Public struct UStruct BlueprintType category FARGeoAnchorUpdatePayload    
Public class FARGetCandidateObjectAsyncTask Async task that builds a candidate object used for detection from the ar session  
Public class FARGetCandidateObjectPin    
Public struct UStruct BlueprintType category FARImageUpdatePayload    
Public struct UStruct BlueprintType category FARMeshUpdatePayload    
Public struct UStruct BlueprintType category FARObjectUpdatePayload    
Public struct UStruct BlueprintType category FARPlaneUpdatePayload    
Public struct UStruct BlueprintType category FARPointUpdatePayload    
Public struct UStruct BlueprintType FARPose2D Represents a human pose tracked in the 2D space  
Public struct UStruct BlueprintType FARPose3D Represents a human pose tracked in the 3D space  
Public struct UStruct BlueprintType category FARPoseUpdatePayload    
Public struct UStruct BlueprintType category FARQRCodeUpdatePayload    
Public class FARSaveWorldAsyncTask Async task that saves the world data into a buffer  
Public class FARSaveWorldPin    
Public struct UStruct BlueprintType category FARSessionPayload    
Public struct UStruct BlueprintType FARSessionStatus The current state of the AR subsystem including an optional explanation string.  
Public struct UStruct BlueprintType FARSharedWorldReplicationState Per player information about what data has been sent to them  
Public struct UStruct BlueprintType FARSkeletonDefinition Represents a hierarchy of a human pose skeleton tracked by the AR system  
Public class FARSupportInterface Composition Components for tracking system features  
Public class FARSystemSupportBase    
Public struct UStruct BlueprintType category, meta FARTraceResult A result of an intersection found during a hit-test.  
Public struct UStruct BlueprintType FARVideoFormat A specific AR video format  
Public class FCheckGeoTrackingAvailabilityAsyncTask Async task to check Geo tracking availability.  
Public class FGetGeoLocationAsyncTask Async task to convert Geo location.  
Public class FOnARTrackingStateChanged    
Public class FOnARTransformUpdated    
Public class FTrackableDelegate    
Public class FTrackableEnvProbeDelegate    
Public class FTrackableFaceDelegate    
Public class FTrackableImageDelegate    
Public class FTrackableObjectDelegate    
Public class FTrackablePlaneDelegate    
Public class FTrackablePointDelegate    
Public struct UStruct FTrackedGeometryGroup    
Public class IARRef A reference to a system-level AR object  
Public class IARSessionConfigCookSupport    
Public class IARSystemSupport Implement IARSystemSupport for any platform that wants to be an Unreal Augmented Reality System.  
Public class UClass Abstract UARBaseAsyncTaskBlueprintProxy    
Public class UClass BlueprintType category UARBasicLightEstimate    
Public class UClass Meta UARBlueprintLibrary    
Public class UClass BlueprintType UARCandidateImage An asset that points to an image to be detected in a scene and provides the size of the object in real life  
Public class UClass BlueprintType UARCandidateObject An asset that points to an object to be detected in a scene  
Public class UClass Abstract BlueprintType category UARComponent ARComponent handles replication and visualization update for AR tracked geometries ARComponent is created in either multiplayer or local only environment  
Public class UClass Abstract BlueprintType category UARDependencyHandler Helper class that allows the user to explicitly request AR service installation and permission granting.  
Public class UClass BlueprintType UAREnvironmentCaptureProbe A tracked environment texture probe that gives you a cube map for reflections  
Public class UClass Abstract BlueprintType UAREnvironmentCaptureProbeTexture Base class for all AR textures that represent the environment for lighting and reflection  
Public class UClass Blueprintable, BlueprintType category UAREnvironmentProbeComponent    
Public class UClass Blueprintable, BlueprintType category UARFaceComponent    
Public class UClass BlueprintType UARFaceGeometry    
Public class UClass BlueprintType UARGeoAnchor    
Public class UClass Blueprintable, BlueprintType category UARGeoAnchorComponent    
Public class UClass Abstract BlueprintType category UARGeoTrackingSupport Interface class for Geo tracking related features.  
Public class UClass UARGetCandidateObjectAsyncTaskBlueprintProxy    
Public class UClass Blueprintable, BlueprintType category UARImageComponent    
Public class UClass BlueprintType ClassGroup, Meta experimental UARLifeCycleComponent    
Public class UClass BlueprintType category, experimental UARLightEstimate    
Public class UClass Blueprintable, BlueprintType category UARMeshComponent    
Public class UClass BlueprintType UARMeshGeometry    
Public class UClass Blueprintable, BlueprintType category UARObjectComponent    
Public class UClass BlueprintType category, experimental UARPin    
Public class UClass Blueprintable, BlueprintType category UARPlaneComponent    
Public class UClass BlueprintType UARPlaneGeometry    
Public class UClass Blueprintable, BlueprintType category UARPointComponent    
Public class UClass Blueprintable, BlueprintType category UARPoseComponent    
Public class UClass Blueprintable, BlueprintType category UARQRCodeComponent    
Public class UClass UARSaveWorldAsyncTaskBlueprintProxy    
Public class UClass BlueprintType category UARSessionConfig An Unreal Data Asset that defines what features are used in the AR session.  
Public class UClass Abstract BlueprintType UARTexture Base class for all AR texture types.  
Public class UClass Abstract BlueprintType UARTextureCameraDepth Base class for all AR textures that represent the camera depth data  
Public class UClass Abstract BlueprintType UARTextureCameraImage Base class for all AR textures that represent the camera image data  
Public class UClass UARTraceResultDummy    
Public class UClass Meta UARTraceResultLibrary    
Public class UClass Meta UARTrackableNotifyComponent Component used to listen to ar trackable object changes  
Public class UClass BlueprintType UARTrackedGeometry    
Public class UClass BlueprintType UARTrackedImage    
Public class UClass BlueprintType UARTrackedObject    
Public class UClass BlueprintType UARTrackedPoint    
Public class UClass BlueprintType UARTrackedPose    
Public class UClass BlueprintType UARTrackedQRCode    
Public class UClass UARTypesDummyClass    
Public class UClass UCheckGeoTrackingAvailabilityAsyncTaskBlueprintProxy Blueprint async task to check Geo tracking availability.  
Public class UClass UGetGeoLocationAsyncTaskBlueprintProxy Blueprint async task to convert Geo location.  

Typedefs

Name Description
FARBlendShapeMap  
FARSystemOnAlignmentTransformUpdated  
FARSystemOnSessionStarted  
FOnTrackableAdded  
FOnTrackableAddedDelegate  
FOnTrackableRemoved  
FOnTrackableRemovedDelegate  
FOnTrackableUpdated  
FOnTrackableUpdatedDelegate  

Enums

  Type Name Description
Public enum UEnum BlueprintType EARAltitudeSource    
Public enum UEnum BlueprintType EARCandidateImageOrientation Tells the image detection code how to assume the image is oriented  
Public enum UEnum BlueprintType category, meta EARCaptureType    
Public enum UEnum BlueprintType category, meta EARDepthAccuracy    
Public enum UEnum BlueprintType category, meta EARDepthQuality    
Public enum UEnum BlueprintType EAREnvironmentCaptureProbeType Options for how environment textures are generated. This feature is used by ARKit.  
Public enum UEnum BlueprintType category, meta EAREye    
Public enum UEnum BlueprintType category, meta EARFaceBlendShape    
Public enum UEnum BlueprintType category, meta EARFaceTrackingDirection    
Public enum UEnum BlueprintType EARFaceTrackingUpdate Options for the kind of data to update during Face Tracking. This feature is used by ARKit.  
Public enum UEnum BlueprintType EARFaceTransformMixing    
Public enum UEnum BlueprintType category, meta EARFrameSyncMode Options for how the Unreal frame synchronizes with camera image updates.  
Public enum UEnum BlueprintType EARGeoTrackingAccuracy    
Public enum UEnum BlueprintType EARGeoTrackingState    
Public enum UEnum BlueprintType EARGeoTrackingStateReason    
Public enum UEnum BlueprintType EARJointTransformSpace Describes the potential spaces in which the join transform can be defined with AR pose tracking  
Public enum UEnum BlueprintType category, meta EARLightEstimationMode Options for how light is estimated based on the camera capture.  
Public enum UEnum BlueprintType category, meta EARLineTraceChannels Channels that let users select which kind of tracked geometry to trace against.  
Public enum UEnum BlueprintType EARObjectClassification Indicates what type of object the scene understanding system thinks it is  
Public enum UEnum BlueprintType category, meta EARPlaneDetectionMode Options for how flat surfaces are detected. This feature is used by ARCore and ARKit.  
Public enum UEnum BlueprintType EARPlaneOrientation Describes the tracked plane orientation  
Public enum UEnum BlueprintType EARSceneReconstruction Options for how the scene should be reconstructed. This feature is used by ARKit.  
Public enum UEnum BlueprintType EARServiceAvailability    
Public enum UEnum BlueprintType EARServiceInstallRequestResult    
Public enum UEnum BlueprintType EARServicePermissionRequestResult    
Public enum UEnum BlueprintType EARSessionConfigFlags    
Public enum UEnum BlueprintType meta EARSessionStatus Describes the current status of the AR session.  
Public enum UEnum BlueprintType EARSessionTrackingFeature Options for more tracking features to be enabled for the session, in addition to what is already defined in the project’s @EARSessionType.  
Public enum UEnum BlueprintType category, meta EARSessionType Options for the tracking type of the session.  
Public enum UEnum BlueprintType EARSpatialMeshUsageFlags Indicates how the spatial mesh should be visualized  
Public enum UEnum BlueprintType category, meta EARTextureType    
Public enum UEnum BlueprintType category, meta EARTrackingQuality    
Public enum UEnum BlueprintType category, meta EARTrackingQualityReason    
Public enum UEnum BlueprintType category, meta EARTrackingState    
Public enum UEnum BlueprintType category, meta EARWorldAlignment Options for how the scene’s coordinate system is constructed. This feature is used by ARKit.  
Public enum UEnum BlueprintType category, meta EARWorldMappingState Gives feedback as to whether the AR data can be saved and relocalized or not  
Public enum UEnum BlueprintType EFaceComponentDebugMode    
Public enum UEnum BlueprintType EGeoAnchorComponentDebugMode    
Public enum UEnum BlueprintType EImageComponentDebugMode    
Public enum UEnum BlueprintType EPlaneComponentDebugMode    
Public enum UEnum BlueprintType EPoseComponentDebugMode    
Public enum UEnum BlueprintType EQRCodeComponentDebugMode    

Functions

  Type Name Description
Public function    
Public function    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page