UMLDeformerInputInfo | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MLDeformerFramework

The neural network input information. This contains arrays of names for things such as bones and curves. Knowing what bones etc are used as inputs, and in what order, helps us feeding the data during inference. It can also help us detect issues, for example when the character we apply the deformer to is missing any of those bones.


Name	UMLDeformerInputInfo
Type	class
Header File	/Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFramework/Public/MLDeformerInputInfo.h
Include Path	#include "MLDeformerInputInfo.h"

Syntax

UCLASS (MinimalAPI)  
class UMLDeformerInputInfo : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UMLDeformerInputInfo

Derived Classes

UMLDeformerMorphModelInputInfo

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~UMLDeformerInputInfo()		MLDeformerInputInfo.h

Functions

Public

Name	Remarks	Include Path
virtual int32 CalcNumNeuralNetInputs ( int32 NumFloatsPerBone, int32 NumFloatsPerCurve ) const	Calculate how many inputs this input info generates for the neural network.	MLDeformerInputInfo.h
virtual int32 CalcNumNeuralNetInputs ()	Calculate how many inputs this input info generates for the neural network.	MLDeformerInputInfo.h
virtual void CopyMembersFrom ( UMLDeformerInputInfo* Other )	Copy members from the other class.	MLDeformerInputInfo.h
virtual void ExtractBoneRotations ( USkeletalMeshComponent* SkelMeshComponent, TArray< float >& OutRotations ) const	Extract bone space rotations, as a float array.	MLDeformerInputInfo.h
virtual void ExtractCurveValues ( USkeletalMeshComponent* SkelMeshComponent, TArray< float >& OutValues, int32 NumFloatsPerCurve ) const	Extract the curve values for all curves we're interested in.	MLDeformerInputInfo.h
virtual void ExtractCurveValues ( USkeletalMeshComponent* SkelMeshComponent, TArray< float >& OutValues ) const	Extract the curve values for all curves we're interested in. Assume one float per curve.	MLDeformerInputInfo.h
virtual FString GenerateCompatibilityErrorString ( const USkeletalMeshComponent* InSkeletalMeshComponent ) const	Get the compatibility error report.	MLDeformerInputInfo.h
virtual FString GenerateCompatibilityErrorString ( USkeletalMesh* InSkeletalMesh ) const	Get the compatibility error report.	MLDeformerInputInfo.h
virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context ) const		MLDeformerInputInfo.h
virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags ) const		MLDeformerInputInfo.h
FName GetBoneName ( int32 Index ) const	Get the bone name as an FName, for a given bone we included during training.	MLDeformerInputInfo.h
const TArray< FName > & GetBoneNames ()		MLDeformerInputInfo.h
TArray< FName > & GetBoneNames ()	Get the list of bone names that should be included as training inputs.	MLDeformerInputInfo.h
const FString & GetBoneNameString ( int32 Index ) const		MLDeformerInputInfo.h
TArray< FString > & GetBoneNameStrings()		MLDeformerInputInfo.h
FName GetCurveName ( int32 Index ) const	Get the curve name as an FName, for a given curve we included during training.	MLDeformerInputInfo.h
const TArray< FName > & GetCurveNames ()		MLDeformerInputInfo.h
TArray< FName > & GetCurveNames ()	Get the list of curve names that should be included as training inputs.	MLDeformerInputInfo.h
const FString & GetCurveNameString ( int32 Index ) const		MLDeformerInputInfo.h
TArray< FString > & GetCurveNameStrings()		MLDeformerInputInfo.h
int32 GetNumBaseMeshVertices()	Get the number of imported vertices in the base mesh, which is the linear skinned skeletal mesh.	MLDeformerInputInfo.h
int32 GetNumBones()	Get the number of bones that we trained on.	MLDeformerInputInfo.h
int32 GetNumCurves()	Get the number of curves that we trained on.	MLDeformerInputInfo.h
int32 GetNumTargetMeshVertices ()	Get the number of imported vertices in the target mesh, which is our training target/ground truth mesh.	MLDeformerInputInfo.h
const FSoftObjectPath & GetSkeletalMesh()	Get the path to the skeletal mesh that this deformer was trained on.	MLDeformerInputInfo.h
virtual bool IsCompatible ( USkeletalMesh* InSkeletalMesh ) const	Check whether the current inputs are compatible with a given skeletal mesh.	MLDeformerInputInfo.h
virtual bool IsCompatible ( const USkeletalMeshComponent* InSkeletalMeshComponent ) const	Check whether the current inputs are compatible with a given skeletal mesh component.	MLDeformerInputInfo.h
virtual bool IsEmpty ()	Check whether we have any training inputs or not.	MLDeformerInputInfo.h
virtual void OnPostLoad()	This method is executed post loading of the ML Deformer asset.	MLDeformerInputInfo.h
virtual void Reset ()	Clear all contents.	MLDeformerInputInfo.h
void SetNumBaseVertices ( int32 NumVerts )	Set the number of vertices of our base mesh, which is the linear skinned skeletal mesh.	MLDeformerInputInfo.h
void SetNumTargetVertices ( int32 NumVerts )	Set the number of target mesh vertices.	MLDeformerInputInfo.h
void SetSkeletalMesh ( USkeletalMesh* InSkeletalMesh )	Set skeletal mesh that we trained on.	MLDeformerInputInfo.h
void UpdateFNames()		MLDeformerInputInfo.h
void UpdateNameStrings()		MLDeformerInputInfo.h

Static

Name	Remarks	Include Path
static void BuildCurveList ( USkeletalMesh* InSkeletalMesh, TArray< FName >& OutCurveNames )	Builds a list of available curves on the Skeletal Mesh provided, including its skeleton.	MLDeformerInputInfo.h
static void RotationToTwoVectorsAsSixFloats ( const FQuat& Rotation, float* SixFloatsOutputBuffer )	Convert a rotation quaternion to two basis vectors, each represented as 3 floats, so 6 floats in total.	MLDeformerInputInfo.h
static void RotationToTwoVectorsAsSixFloats ( TArrayView< FTransform > Transforms, float* OutputBuffer )	Batch convert a set of transform rotation quaternions into two column vectors.	MLDeformerInputInfo.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
BoneNameStrings_DEPRECATED	TArray< FString >	The list of bone names, but as string. This is deprecated since UE 5.2.	MLDeformerInputInfo.h	Meta=(DeprecatedProperty, DeprecationMessage="Use BoneNames instead.")
CurveNameStrings_DEPRECATED	TArray< FString >	The list of curve names, but as string. This is deprecated since UE 5.2.	MLDeformerInputInfo.h	Meta=(DeprecatedProperty, DeprecationMessage="Use CurveNames instead.")

Navigation