UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UARFaceComponent Class Reference

#include <ARComponent.h>

+ Inheritance diagram for UARFaceComponent:

Public Member Functions

virtual UE_API void TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
 
UE_API void ReceiveAdd (const FARFaceUpdatePayload &Payload)
 
UE_API void ReceiveUpdate (const FARFaceUpdatePayload &Payload)
 
virtual UE_API void Update (UARTrackedGeometry *TrackedGeometry) override
 
- Public Member Functions inherited from UARComponent
UE_API UARComponent ()
 
UE_API void SetNativeID (FGuid NativeID)
 
UMRMeshComponent * GetMRMesh ()
 
UE_API void ReceiveRemove ()
 
UE_API void UpdateVisualization ()
 
virtual UE_API void Remove (UARTrackedGeometry *TrackedGeometry)
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FMRMeshDelegate, UMRMeshComponent *)
 

Static Public Member Functions

static UE_API void SetFaceComponentDebugMode (EFaceComponentDebugMode NewDebugMode)
 

Protected Member Functions

UE_API void ServerUpdatePayload (const FARFaceUpdatePayload &NewPayload)
 
virtual UE_API void OnRep_Payload () override
 
virtual UE_API void UpdateVisualization_Implementation () override
 
- Protected Member Functions inherited from UARComponent
virtual UE_API void OnUnregister () override
 
UE_API void RemoveMeshComponent (UARTrackedGeometry *TrackedGeometry)
 
UE_API void ManageMeshComponentForDebugMode (bool bDebugModeEnabled, const FARSessionPayload &SessionPayload)
 
UE_API FLinearColor GetDebugColor () const
 

Static Protected Member Functions

static UE_API int32 GetDebugMode ()
 

Protected Attributes

EARFaceTransformMixing TransformSetting = EARFaceTransformMixing::TrackingOnly
 
bool bUpdateVertexNormal = false
 
bool bFaceOutOfScreen = true
 
FARFaceUpdatePayload ReplicatedPayload
 
- Protected Attributes inherited from UARComponent
bool bUseDefaultReplication = true
 
TObjectPtr< UMaterialInterfaceDefaultMeshMaterial = nullptr
 
TObjectPtr< UMaterialInterfaceDefaultWireframeMeshMaterial = nullptr
 
TObjectPtr< UMRMeshComponent > MRMeshComponent
 
TObjectPtr< UARTrackedGeometryMyTrackedGeometry
 
bool bFirstUpdate = true
 
bool bIsRemoved = false
 
bool bInDebugMode = false
 
bool bSavedWireframeMode
 
FLinearColor SavedWireframeColor
 

Additional Inherited Members

- Public Attributes inherited from UARComponent
FGuid NativeID
 
FMRMeshDelegate OnMRMeshCreated
 
FMRMeshDelegate OnMRMeshDestroyed
 

Member Function Documentation

◆ GetDebugMode()

static UE_API int32 UARFaceComponent::GetDebugMode ( )
staticprotected

◆ OnRep_Payload()

virtual UE_API void UARFaceComponent::OnRep_Payload ( )
overrideprotectedvirtual

Reimplemented from UARComponent.

◆ ReceiveAdd()

UE_API void UARFaceComponent::ReceiveAdd ( const FARFaceUpdatePayload Payload)

Event when native representation is first added, called on server and clients.

◆ ReceiveUpdate()

UE_API void UARFaceComponent::ReceiveUpdate ( const FARFaceUpdatePayload Payload)

Event when native representation is updated, called on server and clients.

◆ ServerUpdatePayload()

UE_API void UARFaceComponent::ServerUpdatePayload ( const FARFaceUpdatePayload NewPayload)
protected

◆ SetFaceComponentDebugMode()

static UE_API void UARFaceComponent::SetFaceComponentDebugMode ( EFaceComponentDebugMode  NewDebugMode)
static

◆ TickComponent()

void UARFaceComponent::TickComponent ( float  DeltaTime,
enum ELevelTick  TickType,
FActorComponentTickFunction ThisTickFunction 
)
overridevirtual

◆ Update()

virtual UE_API void UARFaceComponent::Update ( UARTrackedGeometry TrackedGeometry)
overridevirtual

Overridable native event for when native representation is updated.

Reimplemented from UARComponent.

◆ UpdateVisualization_Implementation()

void UARFaceComponent::UpdateVisualization_Implementation ( )
overrideprotectedvirtual

Member Data Documentation

◆ bFaceOutOfScreen

bool UARFaceComponent::bFaceOutOfScreen = true
protected

Whether the mesh should be rotated so that it's facing out of the screen.

◆ bUpdateVertexNormal

bool UARFaceComponent::bUpdateVertexNormal = false
protected

Whether to automatically update the vertex normal when the mesh is updated.

◆ ReplicatedPayload

FARFaceUpdatePayload UARFaceComponent::ReplicatedPayload
protected

◆ TransformSetting

EARFaceTransformMixing UARFaceComponent::TransformSetting = EARFaceTransformMixing::TrackingOnly
protected

Determines how the transform from tracking data and the component's transform are mixed together.


The documentation for this class was generated from the following files: