1. Epic GamesDeveloper
  3. UAppleARKitFaceMeshComponent

UAppleARKitFaceMeshComponent

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

API > API/Plugins > API/Plugins/AppleARKitFaceSupport

Inheritance Hierarchy

References

   
Module AppleARKitFaceSupport
Header /Engine/Plugins/Runtime/AR/AppleAR/AppleARKitFaceSupport/Source/AppleARKitFaceSupport/Public/AppleARKitFaceMeshComponent.h
Include #include "AppleARKitFaceMeshComponent.h"

Syntax

UCLASS&40;HideCategories&61;&40;Object, LOD, "Components&124;ProceduralMesh"&41;,  
       Meta&61;&40;BlueprintSpawnableComponent&41;, ClassGroup&61;"AR"&41;  
class UAppleARKitFaceMeshComponent : public UProceduralMeshComponent

Remarks

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

Variables

  Type 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 TObjectPtr< class UMaterialInterface > 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< FNetQuantizeFaceCurve > RemoteCurves The set of changed curves to replicate to the other clients
Public variable UProperty Category, EditAnywhere BlueprintReadOnly EARFaceComponentTransformMixing TransformSetting Determines how the transform from tracking data and the component's transform are mixed together

Constructors

  Type Name Description
Public function  

UAppleARKitFaceMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type 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 Returns the frame number that was last used to update this component
Public function Const UFunction BlueprintPure, Category float Returns the frame timestamp that was last used to update this component
Public function Const UFunction BlueprintPure, Category FTransform 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, float >& InBlendShapes
)

 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 Create/replace the face mesh from the current set of blend shapes if the device supports it

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page