UAppleARKitFaceMeshComponent

This component is updated by the ARSystem with face data on devices that have support for it

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AppleARKitFaceSupport

Header

/Engine/Plugins/Runtime/AR/AppleAR/AppleARKitFaceSupport/Source/AppleARKitFaceSupport/Public/AppleARKitFaceMeshComponent.h

Include

#include "AppleARKitFaceMeshComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Object, LOD, "Components|ProceduralMesh"),
       Meta=(BlueprintSpawnableComponent), ClassGroup="AR")
class UAppleARKitFaceMeshComponent : public UProceduralMeshComponent

Remarks

This component is updated by the ARSystem with face data on devices that have support for it

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bAutoBindToLocalFaceMesh

If true, the mesh data will come from the local ARKit face mesh data.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bFlipTrackedRotation

If true, the face mesh will be rotated to face out of the screen (-X) rather than into the screen (+X) and corresponding axises to match

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bWantsCollision

Indicates whether collision should be created for this face mesh.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

bWantsMeshUpdates

Indicates whether the face mesh data should be built for rendering or not

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

UMaterialInterf...

 

FaceMaterial

Used when rendering the face mesh (mostly debug reasons)

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FName

 

LiveLinkSubjectName

Used to identify this component's face ar data uniquely as part of the LiveLink animation pipeline

Public variable UProperty Transient replicatedusing

TArray< FNetQua...

 

RemoteCurves

The set of changed curves to replicate to the other clients

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

EARFaceComponen...

 

TransformSetting

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

Constructors

Name Description

Public function

UAppleARKitFaceMeshComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function UFunction BlueprintCallable, Category, Meta

void

 

CreateMesh

(
    const TArray< FVector >& Vertices,
    const TArray< int32 >& Triangles,
    const TArray< FVector2D >& UV0
)

Create the initial face mesh from raw mesh data

Public function Const UFunction BlueprintPure, Category

float

 

GetFaceBlendShapeAmount

(
    EARFaceBlendShape BlendShape
)

Returns the value of the specified blend shape

Public function Const UFunction BlueprintPure, Category

int32

 

GetLastUpdateFrameNumber()

Returns the frame number that was last used to update this component

Public function Const UFunction BlueprintPure, Category

float

 

GetLastUpdateTimestamp()

Returns the frame timestamp that was last used to update this component

Public function Const UFunction BlueprintPure, Category

FTransform

 

GetTransform()

Get the transform that the AR camera has detected

Public function UFunction BlueprintCallable, Category

void

 

PublishViaLiveLink

(
    FName SubjectName
)

Starts LiveLink publishing of this face component's data so that it can be used by the animation system

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetAutoBind

(
    bool bAutoBind
)

If auto bind is true, then this component will update itself from the local face tracking data each tick.

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetBlendShapeAmount

(
    EARFaceBlendShape BlendShape,
    float Amount
)

Sets the amount for a given blend shape

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetBlendShapes

(
    const TMap< EARFaceBlendShape, floa...
)

Set all of the blend shapes for this instance from a set of blend shapes

Public function UFunction BlueprintCallable, Category, Meta

void

 

UpdateMesh

(
    const TArray< FVector >& Vertices
)

Updates the face mesh vertices.

Public function UFunction BlueprintCallable, Category, Meta

void

 

UpdateMeshFromBlendShapes()

Create/replace the face mesh from the current set of blend shapes if the device supports it
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss