UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ARComponent.h File Reference
#include "ARTypes.h"
#include "Components/SceneComponent.h"
#include "PackedNormal.h"
#include "MRMeshBufferDefines.h"
#include "ARComponent.generated.h"

Go to the source code of this file.

Classes

struct  FARSessionPayload
 
struct  FARPlaneUpdatePayload
 
struct  FARPointUpdatePayload
 
struct  FARFaceUpdatePayload
 
struct  FARImageUpdatePayload
 
struct  FARQRCodeUpdatePayload
 
struct  FARPoseUpdatePayload
 
struct  FAREnvironmentProbeUpdatePayload
 
struct  FARObjectUpdatePayload
 
struct  FARMeshUpdatePayload
 
struct  FARGeoAnchorUpdatePayload
 
struct  FAccumulatedNormal
 
class  UARComponent
 
class  UARPlaneComponent
 
class  UARPointComponent
 
class  UARFaceComponent
 
class  UARImageComponent
 
class  UARQRCodeComponent
 
class  UARPoseComponent
 
class  UAREnvironmentProbeComponent
 
class  UARObjectComponent
 
class  UARMeshComponent
 
class  UARGeoAnchorComponent
 

Macros

#define UE_API   AUGMENTEDREALITY_API
 

Enumerations

enum class  EARSessionConfigFlags : uint8 {
  None = 0 , GenerateMeshData = 1 << 0 , RenderMeshDataInWireframe = 1 << 1 , GenerateCollisionForMeshData = 1 << 2 ,
  GenerateNavMeshForMeshData = 1 << 3 , UseMeshDataForOcclusion = 1 << 4
}
 
enum class  EPlaneComponentDebugMode : uint8 { None = 0 , ShowNetworkRole = 1 , ShowClassification = 2 }
 
enum class  EFaceComponentDebugMode : uint8 { None = 0 , ShowEyeVectors = 1 , ShowFaceMesh = 2 }
 
enum class  EARFaceTransformMixing : uint8 { ComponentOnly , ComponentLocationTrackedRotation , ComponentWithTracked , TrackingOnly }
 
enum class  EImageComponentDebugMode : uint8 { None = 0 , ShowDetectedImage = 1 }
 
enum class  EQRCodeComponentDebugMode : uint8 { None = 0 , ShowQRCode = 1 }
 
enum class  EPoseComponentDebugMode : uint8 { None = 0 , ShowSkeleton = 1 }
 
enum class  EGeoAnchorComponentDebugMode : uint8 { None = 0 , ShowGeoData = 1 }
 

Macro Definition Documentation

◆ UE_API

Enumeration Type Documentation

◆ EARFaceTransformMixing

Enumerator
ComponentOnly 

Uses the component's transform exclusively. Only setting for non-tracked meshes

ComponentLocationTrackedRotation 

Use the component's location and apply the rotation from the tracked mesh

ComponentWithTracked 

Concatenate the component and the tracked face transforms

TrackingOnly 

Use only the tracked face transform

◆ EARSessionConfigFlags

Enumerator
None 
GenerateMeshData 
RenderMeshDataInWireframe 
GenerateCollisionForMeshData 
GenerateNavMeshForMeshData 
UseMeshDataForOcclusion 

◆ EFaceComponentDebugMode

Enumerator
None 

The debug mode is disabled

ShowEyeVectors 

Display vectors for both eyes

ShowFaceMesh 

Display the face mesh in wireframe

◆ EGeoAnchorComponentDebugMode

Enumerator
None 

The debug mode is disabled

ShowGeoData 

Display Geo related data

◆ EImageComponentDebugMode

Enumerator
None 

The debug mode is disabled

ShowDetectedImage 

Display info about the detected image

◆ EPlaneComponentDebugMode

Enumerator
None 

The debug mode is disabled

ShowNetworkRole 

Use different coloration to indicate if the plane belongs to the local or remote client

ShowClassification 

Use different coloration to indicate the classification of this plane

◆ EPoseComponentDebugMode

Enumerator
None 

The debug mode is disabled

ShowSkeleton 

Show the skeleton with debug draw

◆ EQRCodeComponentDebugMode

Enumerator
None 

The debug mode is disabled

ShowQRCode 

Show info about the detected QR code