1. Epic GamesDeveloper
  3. UMLDeformerInputInfo

UMLDeformerInputInfo

The neural network input information.

API > API/Plugins > API/Plugins/MLDeformerFramework

Inheritance Hierarchy

References

   
Module MLDeformerFramework
Header /Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFramework/Public/MLDeformerInputInfo.h
Include #include "MLDeformerInputInfo.h"

Syntax

UCLASS ()  
class UMLDeformerInputInfo : public UObject

Remarks

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.

Variables

  Type Name Description
Protected variable UProperty TArray< FName > BoneNames The name of each bone.
Protected variable UProperty TArray< FName > CurveNames The name of each curve.
Protected variable UProperty assetregistrysearchable int32 NumBaseMeshVertices Number of imported base mesh vertices, so not render vertices.
Protected variable UProperty int32 NumTargetMeshVertices Number of imported target mesh vertices, so not render vertices.
Protected variable UProperty FSoftObjectPath SkeletalMesh The path to the skeletal mesh that this model was trained on.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual Const int32 Calculate how many inputs this input info generates for the neural network.
Public function Virtual Const int32

CalcNumNeuralNetInputs ( int32 NumFloatsPerBone,
int32 NumFloatsPerCurve
)

 Calculate how many inputs this input info generates for the neural network.
Public function Virtual void Copy members from the other class.
Public function Virtual Const void

ExtractBoneRotations ( USkeletalMeshComponent* SkelMeshComponent,
TArray< float >& OutRotations
)

 Extract bone space rotations, as a float array.
Public function Virtual Const void

ExtractCurveValues ( USkeletalMeshComponent* SkelMeshComponent,
TArray< float >& OutValues,
int32 NumFloatsPerCurve
)

 Extract the curve values for all curves we're interested in.
Public function Virtual Const void

ExtractCurveValues ( USkeletalMeshComponent* SkelMeshComponent,
TArray< float >& OutValues
)

 Extract the curve values for all curves we're interested in. Assume one float per curve.
Public function Virtual Const FString Get the compatibility error report.
Public function Const FName

GetBoneName ( int32 Index
)

 Get the bone name as an FName, for a given bone we included during training.
Public function Const const TArray< FName > &  
Public function TArray< FName > & Get the list of bone names that should be included as training inputs.
Public function Const const FString &  
Public function TArray< FString > &  
Public function Const FName

GetCurveName ( int32 Index
)

 Get the curve name as an FName, for a given curve we included during training.
Public function Const const TArray< FName > &  
Public function TArray< FName > & Get the list of curve names that should be included as training inputs.
Public function Const const FString &  
Public function TArray< FString > &  
Public function Const int32 Get the number of imported vertices in the base mesh, which is the linear skinned skeletal mesh.
Public function Const int32 Get the number of bones that we trained on.
Public function Const int32 Get the number of curves that we trained on.
Public function Const int32 Get the number of imported vertices in the target mesh, which is our training target/ground truth mesh.
Public function Const const FSoftObjectPath & Get the path to the skeletal mesh that this deformer was trained on.
Public function Virtual Const bool

IsCompatible ( USkeletalMesh* InSkeletalMesh
)

 Check whether the current inputs are compatible with a given skeletal mesh.
Public function Virtual Const bool

IsEmpty ()

 Check whether we have any training inputs or not.
Public function Virtual void This method is executed post loading of the ML Deformer asset.
Public function Virtual void

Reset ()

 Clear all contents.
Public function Static void

RotationToTwoVectorsAsSixFloats ( TArrayView< FTransform > Transforms,
float* OutputBuffer
)

 Batch convert a set of transform rotation quaternions into two column vectors.
Public function 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.
Public function void

SetNumBaseVertices ( int32 NumVerts
)

 Set the number of vertices of our base mesh, which is the linear skinned skeletal mesh.
Public function void Set the number of target mesh vertices.
Public function void

SetSkeletalMesh ( USkeletalMesh* InSkeletalMesh
)

 Set skeletal mesh that we trained on.
Public function void  
Public function void  

Overridden from UObject

  Type Name Description
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

Deprecated Variables

  Type Name Description
Protected variable UProperty Meta TArray< FString > BoneNameStrings_DEPRECATED The list of bone names, but as string. This is deprecated since UE 5.2.
Protected variable UProperty Meta TArray< FString > CurveNameStrings_DEPRECATED The list of curve names, but as string. This is deprecated since UE 5.2.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page