UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ARComponent.cpp File Reference

Macros

#define AR_DEBUG_MODE   1
 
#define DEFINE_AR_COMPONENT_DEBUG_MODE(VariableName, CVarName, CVarDescription, ComponentClass)
 
#define DEFINE_AR_COMPONENT_VIRTUALS(NetworkClassName, NativeClassName, UpdatePayloadClass)
 

Functions

 DECLARE_STATS_GROUP (TEXT("ARComponent"), STATGROUP_ARComponent, STATCAT_Advanced)
 
 DECLARE_CYCLE_STAT (TEXT("Update FaceComponent"), STAT_UpdateFaceComponent, STATGROUP_ARComponent)
 
 DECLARE_CYCLE_STAT (TEXT("Calculate Vertex Normals"), STAT_CalculateVertexNormals, STATGROUP_ARComponent)
 
template<class FReal >
void NotifyDebugModeUpdated ()
 
 DEFINE_AR_COMPONENT_DEBUG_MODE (PlaneComponentDebugMode, "ar.PlaneComponentDebugMode", "Debug mode for AR plane component, see EPlaneComponentDebugMode", ARPlaneComponent)
 
 DEFINE_AR_COMPONENT_DEBUG_MODE (ImageComponentDebugMode, "ar.ImageComponentDebugMode", "Debug mode for AR image component, see EImageComponentDebugMode", ARImageComponent)
 
 DEFINE_AR_COMPONENT_DEBUG_MODE (FaceComponentDebugMode, "ar.FaceComponentDebugMode", "Debug mode for AR face component, see EFaceComponentDebugMode", ARFaceComponent)
 
 DEFINE_AR_COMPONENT_DEBUG_MODE (PoseComponentDebugMode, "ar.PoseComponentDebugMode", "Debug mode for AR pose component, see EPoseComponentDebugMode", ARPoseComponent)
 
 DEFINE_AR_COMPONENT_DEBUG_MODE (QRCodeComponentDebugMode, "ar.QRCodeComponentDebugMode", "Debug mode for AR QR code component, see EQRCodeComponentDebugMode", ARQRCodeComponent)
 
 DEFINE_AR_COMPONENT_DEBUG_MODE (GeoAnchorComponentDebugMode, "ar.GeoAnchorComponentDebugMode", "Debug mode for AR Geo anchor component, see EGeoAnchorComponentDebugMode", ARGeoAnchorComponent)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARPlaneComponent, ARPlaneGeometry, ARPlaneUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARPointComponent, ARTrackedPoint, ARPointUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARFaceComponent, ARFaceGeometry, ARFaceUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARImageComponent, ARTrackedImage, ARImageUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARQRCodeComponent, ARTrackedQRCode, ARQRCodeUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARPoseComponent, ARTrackedPose, ARPoseUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (AREnvironmentProbeComponent, AREnvironmentCaptureProbe, AREnvironmentProbeUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARObjectComponent, ARTrackedObject, ARObjectUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARMeshComponent, ARTrackedGeometry, ARMeshUpdatePayload)
 
 DEFINE_AR_COMPONENT_VIRTUALS (ARGeoAnchorComponent, ARGeoAnchor, ARGeoAnchorUpdatePayload)
 

Macro Definition Documentation

◆ AR_DEBUG_MODE

#define AR_DEBUG_MODE   1

◆ DEFINE_AR_COMPONENT_DEBUG_MODE

#define DEFINE_AR_COMPONENT_DEBUG_MODE (   VariableName,
  CVarName,
  CVarDescription,
  ComponentClass 
)
Value:
static int32 G##VariableName = 0; \
static FAutoConsoleVariableRef CVar##VariableName(\
TEXT(CVarName), \
G##VariableName, \
FConsoleVariableDelegate::CreateLambda([](IConsoleVariable* InVariable) \
{ \
})); \
int32 U##ComponentClass::GetDebugMode() \
{ \
return G##VariableName; \
} \
void U##ComponentClass::Set##VariableName(E##VariableName NewDebugMode) \
{ \
CVar##VariableName->Set((int32)NewDebugMode); \
}
#define TEXT(x)
Definition Platform.h:1272
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
Definition IConsoleManager.h:1580
Definition IConsoleManager.h:558
virtual void Set(const TCHAR *InValue, const FResolvedContext &Context)=0
FAutoConsoleVariableRef CVar(TEXT("Slate.Spinbox.MouseMoveOptimization"), bUseSpinBoxMouseMoveOptimization,)

◆ DEFINE_AR_COMPONENT_VIRTUALS

#define DEFINE_AR_COMPONENT_VIRTUALS (   NetworkClassName,
  NativeClassName,
  UpdatePayloadClass 
)

Function Documentation

◆ DECLARE_CYCLE_STAT() [1/2]

DECLARE_CYCLE_STAT ( TEXT("Calculate Vertex Normals" ,
STAT_CalculateVertexNormals  ,
STATGROUP_ARComponent   
)

◆ DECLARE_CYCLE_STAT() [2/2]

DECLARE_CYCLE_STAT ( TEXT("Update FaceComponent" ,
STAT_UpdateFaceComponent  ,
STATGROUP_ARComponent   
)

◆ DECLARE_STATS_GROUP()

DECLARE_STATS_GROUP ( TEXT("ARComponent")  ,
STATGROUP_ARComponent  ,
STATCAT_Advanced   
)

◆ DEFINE_AR_COMPONENT_DEBUG_MODE() [1/6]

DEFINE_AR_COMPONENT_DEBUG_MODE ( FaceComponentDebugMode  ,
"ar.FaceComponentDebugMode"  ,
"Debug mode for AR face  component,
see EFaceComponentDebugMode"  ,
ARFaceComponent   
)

◆ DEFINE_AR_COMPONENT_DEBUG_MODE() [2/6]

DEFINE_AR_COMPONENT_DEBUG_MODE ( GeoAnchorComponentDebugMode  ,
"ar.GeoAnchorComponentDebugMode"  ,
"Debug mode for AR Geo anchor  component,
see EGeoAnchorComponentDebugMode"  ,
ARGeoAnchorComponent   
)

◆ DEFINE_AR_COMPONENT_DEBUG_MODE() [3/6]

DEFINE_AR_COMPONENT_DEBUG_MODE ( ImageComponentDebugMode  ,
"ar.ImageComponentDebugMode"  ,
"Debug mode for AR image  component,
see EImageComponentDebugMode"  ,
ARImageComponent   
)

◆ DEFINE_AR_COMPONENT_DEBUG_MODE() [4/6]

DEFINE_AR_COMPONENT_DEBUG_MODE ( PlaneComponentDebugMode  ,
"ar.PlaneComponentDebugMode"  ,
"Debug mode for AR plane  component,
see EPlaneComponentDebugMode"  ,
ARPlaneComponent   
)

◆ DEFINE_AR_COMPONENT_DEBUG_MODE() [5/6]

DEFINE_AR_COMPONENT_DEBUG_MODE ( PoseComponentDebugMode  ,
"ar.PoseComponentDebugMode"  ,
"Debug mode for AR pose  component,
see EPoseComponentDebugMode"  ,
ARPoseComponent   
)

◆ DEFINE_AR_COMPONENT_DEBUG_MODE() [6/6]

DEFINE_AR_COMPONENT_DEBUG_MODE ( QRCodeComponentDebugMode  ,
"ar.QRCodeComponentDebugMode"  ,
"Debug mode for AR QR code  component,
see EQRCodeComponentDebugMode"  ,
ARQRCodeComponent   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [1/10]

◆ DEFINE_AR_COMPONENT_VIRTUALS() [2/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARFaceComponent  ,
ARFaceGeometry  ,
ARFaceUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [3/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARGeoAnchorComponent  ,
ARGeoAnchor  ,
ARGeoAnchorUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [4/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARImageComponent  ,
ARTrackedImage  ,
ARImageUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [5/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARMeshComponent  ,
ARTrackedGeometry  ,
ARMeshUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [6/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARObjectComponent  ,
ARTrackedObject  ,
ARObjectUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [7/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARPlaneComponent  ,
ARPlaneGeometry  ,
ARPlaneUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [8/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARPointComponent  ,
ARTrackedPoint  ,
ARPointUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [9/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARPoseComponent  ,
ARTrackedPose  ,
ARPoseUpdatePayload   
)

◆ DEFINE_AR_COMPONENT_VIRTUALS() [10/10]

DEFINE_AR_COMPONENT_VIRTUALS ( ARQRCodeComponent  ,
ARTrackedQRCode  ,
ARQRCodeUpdatePayload   
)

◆ NotifyDebugModeUpdated()

template<class FReal >
void NotifyDebugModeUpdated ( )