1. Epic GamesDeveloper
  3. FState

FState

API > API/Plugins > API/Plugins/MetaHumanCoreTechLib > API/Plugins/MetaHumanCoreTechLib/FMetaHumanCharacterIdentity

   
Name FState
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanCoreTechLib/Source/MetaHumanCoreTechLib/Public/MetaHumanCharacterIdentity.h
Include Path #include "MetaHumanCharacterIdentity.h"

Syntax

class FState

Constructors

Name Remarks Include Path Unreal Specifiers

FState ( const FState& InOther
)

   MetaHumanCharacterIdentity.h  

FState ()

   MetaHumanCharacterIdentity.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FState()

   MetaHumanCharacterIdentity.h  

Structs

Name Remarks
FImpl  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Impl TPimplPtr< FImpl >   MetaHumanCharacterIdentity.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddLandmark ( int32 InVertexIndex
)

 Adds a single landmark. MetaHumanCharacterIdentity.h  

void BlendPresets ( int32 InGizmoIndex,
const TArray< TPair< float, const FState* > >& InStates,
EBlendOptions InBlendOptions,
bool bInBlendSymmetrically
)

 Blend region based on preset weights MetaHumanCharacterIdentity.h  

bool Deserialize ( const FSharedBuffer& InArchive
)

   MetaHumanCharacterIdentity.h  
Evaluate the DNA vertices and vertex normals based on the state MetaHumanCharacterIdentity.h  

TArray< FVector3f > EvaluateGizmos ( const TArray< FVector3f >& InVertices
) const

 Evaluate the Gizmos MetaHumanCharacterIdentity.h  

TArray< FVector3f > EvaluateLandmarks ( const TArray< FVector3f >& InVertices
) const

 Evaluate the Landmarks MetaHumanCharacterIdentity.h  

bool FitToFaceDna ( TSharedRef< class IDNAReader > InFaceDna,
const FFitToTargetOptions& InFitToTargetOptions
)

 Fit the Character Identity to the supplied DNA, using the supplied options. MetaHumanCharacterIdentity.h  

bool FitToTarget ( const TMap< int32, TArray< FVector3f > >& InPartsVertices,
const FFitToTargetOptions& InFitToTargetOptions
)

 Fit the Character Identity to the map of supplied part vertices (which must contain the Head, but also optionally can contain Eyes and Teeth), using the supplied options. MetaHumanCharacterIdentity.h  

void GetCoefficients ( TArray< float >& OutCoefficients
) const

 Get the coefficients of the underlying model MetaHumanCharacterIdentity.h  

float GetFaceScale()

 Returns the face scale relative to the body. MetaHumanCharacterIdentity.h  

void GetGizmoPosition ( int32 InGizmoIndex,
FVector3f& OutPosition
) const

 Get the gizmo position MetaHumanCharacterIdentity.h  

void GetGizmoPositionBounds ( int32 InGizmoIndex,
FVector3f& OutMinPosition,
FVector3f& OutMaxPosition,
float InBBoxReduction,
bool bInExpandToCurrent
) const

 Get the gizmo position bounds MetaHumanCharacterIdentity.h  

void GetGizmoRotation ( int32 InGizmoIndex,
FVector3f& OutRotation
) const

 Get the gizmo rotation MetaHumanCharacterIdentity.h  

void GetGizmoRotationBounds ( int32 InGizmoIndex,
FVector3f& OutMinRotation,
FVector3f& OutMaxRotation,
bool bInExpandToCurrent
) const

 Get the gizmo rotation bounds MetaHumanCharacterIdentity.h  

void GetGizmoScale ( int32 InGizmoIndex,
float& OutScale
) const

 Get the gizmo scale MetaHumanCharacterIdentity.h  

void GetGizmoScaleBounds ( int32 InGizmoIndex,
float& OutMinScale,
float& OutMaxScale,
bool bInExpandToCurrent
) const

 Get the gizmo scale bounds MetaHumanCharacterIdentity.h  

bool GetGlobalScale ( float& scale
) const

 Get global scale MetaHumanCharacterIdentity.h  

int32 GetHighFrequenctVariant()

 Returns the high frequency variant used by this state. MetaHumanCharacterIdentity.h  

void GetModelIdentifier ( FString& OutModelIdentifier
) const

 Get the identifier of the underlying model MetaHumanCharacterIdentity.h  

int32 GetNumHighFrequencyVariants()

 Returns the maximum number of High Frequency variants supported by the state MetaHumanCharacterIdentity.h  

void GetPreset ( const FString& PresetName,
int32 InPresetType,
int32 InPresetRegion
)

 Create a state based on preset MetaHumanCharacterIdentity.h  

void GetRawBindPose ( const TArray< FVector3f >& InVertices,
TArray< float >& OutBindPose
) const

 Get the raw bind pose (in DNA coord system) MetaHumanCharacterIdentity.h  

FVector3f GetRawVertex ( const TArray< FVector3f >& InVertices,
int32 InDNAMeshIndex,
int32 InDNAVertexIndex
) const

 Get vertex in unconverted for a specific dna mesh and dna vertex index MetaHumanCharacterIdentity.h  
Get settings MetaHumanCharacterIdentity.h  

int32 GetVariantsCount ( const FString& InVariantName
) const

 Returns the number of variants for variant of name InVariantName (can be "eyelashes" or "teeth") MetaHumanCharacterIdentity.h  

FVector3f GetVertex ( const TArray< FVector3f >& InVertices,
int32 InDNAMeshIndex,
int32 InDNAVertexIndex
) const

 Get vertex in UE coordinate system for a specific dna mesh and dna vertex index MetaHumanCharacterIdentity.h  

bool HasLandmark ( int32 InVertexIndex
) const

 Is there a landmark present for the supplied vertex index MetaHumanCharacterIdentity.h  

int32 NumGizmos()

 Get the number of gizmos MetaHumanCharacterIdentity.h  

int32 NumLandmarks()

 Get the number of landmarks MetaHumanCharacterIdentity.h  

void Randomize ( float InMagnitude
)

 Randomize the face MetaHumanCharacterIdentity.h  

void RemoveLandmark ( int32 InLandmarkIndex
)

 Removes a single landmark for a given landmark index. MetaHumanCharacterIdentity.h  

void Reset()

 Reset the face to the archetype MetaHumanCharacterIdentity.h  

void ResetNeckExclusionMask()

 Reset the neck exclusion mask MetaHumanCharacterIdentity.h  

void ResetNeckRegion()

 Reset the neck region to the body state MetaHumanCharacterIdentity.h  

int32 SelectFaceVertex ( FVector3f InOrigin,
FVector3f InDirection,
FVector3f& OutVertex,
FVector3f& OutNormal
)

 Selects a face vertex given the input ray MetaHumanCharacterIdentity.h  

void Serialize ( FSharedBuffer& OutArchive
) const

   MetaHumanCharacterIdentity.h  

void SetBodyJointsAndBodyFaceVertices ( const TArray< FMatrix44f >& InBodyJoints,
const TArray< FVector3f >& InVertices
)

 Update the face state from body (bind pose, vertices) MetaHumanCharacterIdentity.h  

void SetBodyVertexNormals ( const TArray< FVector3f >& InVertexNormals,
const TArray< int32 >& InNumVerticesPerLod
)

 TODO perhaps combined this with the method above. MetaHumanCharacterIdentity.h  

void SetExpressionActivations ( TMap< FString, float >& InExpressionActivations
)

 Set the expression activations for the face state to those defined in the InExpressionActivations map MetaHumanCharacterIdentity.h  

void SetFaceScale ( float InFaceScale
)

 Set the face scale relative to the body. MetaHumanCharacterIdentity.h  

void SetGizmoPosition ( int32 InGizmoIndex,
const FVector3f& InPosition,
bool bInSymmetric,
bool bInEnforceBounds
)

 Set the gizmo position MetaHumanCharacterIdentity.h  

void SetGizmoRotation ( int32 InGizmoIndex,
const FVector3f& InRotation,
bool bInSymmetric,
bool bInEnforceBounds
)

 Set the gizmo rotation MetaHumanCharacterIdentity.h  

void SetGizmoScale ( int32 InGizmoIndex,
float InScale,
bool bInSymmetric,
bool bInExpandToCurrent
)

 Scale the gizmo MetaHumanCharacterIdentity.h  

void SetHighFrequenctVariant ( int32 InHighFrequencyVariant
)

 Set the high frequency variant to be used by this state. Set <0 for no variant. MetaHumanCharacterIdentity.h  

void SetSettings ( const FMetaHumanCharacterIdentity::FSettings& InSettings
)

 Set settings MetaHumanCharacterIdentity.h  

void SetVariant ( const FString& InVariantName,
TConstArrayView< float > InVariantWeights
)

 Sets variant of name InVariantName to State (can be "eyelashes" or "teeth") MetaHumanCharacterIdentity.h  

TSharedRef< class IDNAReader > StateToDna ( dna::Reader* InDnaReader
) const

   MetaHumanCharacterIdentity.h  

TSharedRef< class IDNAReader > StateToDna ( UDNAAsset* InFaceDNA
) const

   MetaHumanCharacterIdentity.h  

void TranslateLandmark ( int32 InLandmarkIndex,
const FVector3f& InDelta,
bool bInSymmetric
)

 Translate the landmarks MetaHumanCharacterIdentity.h  

void WriteDebugAutoriggingData ( const FString& DirectoryPath
) const

   MetaHumanCharacterIdentity.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page