1. Epic GamesDeveloper
  3. MLDeformerFramework

MLDeformerFramework

API > API/Plugins

Classes

  Type Name Description
Public struct UStruct FMLDeformerCurveReference A reference to a curve implemented as a name.  
Public struct FMLDeformerGeomCacheMeshMapping A mapping between a geometry cache track and a mesh inside a USkeletalMesh.  
Public class FMLDeformerGraphDebugDataProviderProxy    
Public class FMLDeformerModelOnPostEditProperty DEPRECATED: Use FMLDeformerReinitModelInstancesDelegate instead.  
Public class FMLDeformerModule The runtime module for the ML Deformer.  
Public struct UStruct FMLDeformerMorphModelQualityLevel A quality level for the Morph Model.  
Public struct FMLDeformerObjectVersion Custom serialization version for backwards compatibility during de-serialization.  
Public class FMLDeformerPerfCounter    
Public class FVertexMapBuffer The vertex map, but in a GPU buffer.  
Public class UClass BlueprintType HideCategories UMLDeformerAsset The machine learning deformer asset class.  
Public class UClass Blueprintable, BlueprintType ClassGroup, Meta UMLDeformerComponent The ML mesh deformer component.  
Public class UClass UMLDeformerGeomCacheModel A ML Deformer model that has a geometry cache as target mesh.  
Public class UClass UMLDeformerGeomCacheVizSettings The vizualization settings for a model that has a geometry cache.  
Public class UClass category UMLDeformerGraphDebugDataInterface Compute Framework Data Interface for MLDeformer debugging data.  
Public class UClass BlueprintType category, editinlinenew UMLDeformerGraphDebugDataProvider Compute Framework Data Provider for MLDeformer debugging data.  
Public class UClass UMLDeformerInputInfo The neural network input information.  
Public class UClass UMLDeformerModelInstance An instance of the ML Deformer model.  
Public class UClass UMLDeformerMorphModel The morph model base class.  
Public class UClass UMLDeformerMorphModelInputInfo    
Public class UClass UMLDeformerMorphModelInstance The model instance for the UMLDeformerMorphModel.  
Public class UClass UMLDeformerMorphModelVizSettings The vizualization settings specific to the UMLDeformerMorphModel class, or inherited classes.  
Public class UClass UMLDeformerVizSettings The vizualization settings.  

Constants

Name Description
NumFloatsPerBone The number of floats per bone in network input.
NumFloatsPerCurve The number of floats per curve in network input.

Typedefs

Name Description
FMLDeformerReinitModelInstancesDelegate Delegate used to signal that the UMLDeformerModelInstance should be reinitialized.

Enums

  Type Name Description
Public enum UEnum EMLDeformerHeatMapMode The heat map mode which selects what the colors of the heatmap represent.  
Public enum UEnum EMLDeformerMaskChannel The channel to get the mask data from.  
Public enum UEnum EMLDeformerVizMode The visualization mode, which selects whether you want to view the training data, or test your already trained model.  
Public enum UE::MLDeformer::EMemUsageRequestFlags The memory usage request flags, which you pass UMLDeformer::GetMemUsageInBytes method.  

Functions

  Type Name Description
Public function Virtual    
Public function Virtual void  
Public function Virtual UMLDeformerInputInfo * Create the input info for this model.
Public function Virtual UMLDeformerModelInstance * Create a new instance of this model, to be used in combination with a specific component.
Public function Virtual Const bool Defines whether this model supports bone transforms as input or not.
Public function Virtual Const bool Defines whether this model supports curves as inputs or not.
Public function Virtual Const bool Does this model support deformer quality levels? For example Morph based models can disable certain morph targets based on this quality level.
Public function Static int32 Extract the number of imported (DCC) vertices from a skeletal mesh.
Protected function void

FloatArrayToVector3Array ( const TArray< float >& FloatArray,
TArray< FVector3f >& OutVectorArray
)

 Convert an array of floats to an array of Vector3's.
Public function Const const FTransform & Get the target mesh alignment tranformation.
Public function Static FName  
Public function Const const UAnimSequence * Get the animation sequence that is used during training.
Public function Static FName  
Public function TArray< FBoneReference > & Get the list of bones that we configured to be included during training.
Public function Static FName  
Public function TArray< FMLDeformerCurveReference > & Get the list of curves that we configured to be included during training.
Public function Static FName  
Public function Virtual Const FString Get the default deformer graph asset path that this model uses, or an empty string if it doesn't require any deformer graph.
Public function Const UMLDeformerAsset * Get the ML deformer asset that this model is part of.
Public function Const float Get the delta cutoff length.
Public function Static FName  
Public function Virtual Const FString Get the display name of this model.
Public function Const uint64 Get the GPU memory usage for this model.
Public function Const UMLDeformerInputInfo * Get the input information, which is information about the inputs to the deformer.
Public function Static FName  
Public function Const uint64 Get the memory usage for this model.
Public function FNeuralNetworkModifyDelegate & This delegate will be removed.
Public function Const int32 Get the number of vertices in the base mesh (linear skinned skeletal mesh).
Public function Virtual Const int32 Get the number of floats used to represent a single bone rotation, used as input to the neural networks.
Public function Virtual Const int32 Get the number of floats used to represent a single bone rotation, used as input to the neural networks.
Public function Const int32 Get the number of vertices of the target mesh.
Public function FMLDeformerReinitModelInstancesDelegate & Get the delegate which will be called when to inform when the model instance needs to be reinitailized.
Public function Static FName This property has been removed and shouldn't be used anymore.
Public function Static FName This property has been removed and shouldn't be used anymore.
Public function Const const USkeletalMesh * Get the skeletal mesh that is used during training.
Public function Static FName Get property names.
Public function Virtual USkeleton *

GetSkeleton ( bool& bInvalidSkeletonIsError,
const IPropertyHandle* PropertyHandle
)

  
Public function Const int32 Get the maximum number of training frames to use during training.
Public function Const const TArray< int32 > & The mapping that maps from render vertices into dcc vertices.
Public function Const const UE::MLDeformer::FVertexMapBuffer & Get the GPU buffer of the VertexMap.
Public function Const UMLDeformerVizSettings * Get the visualization settings for this model.
Public function Virtual Const bool Check whether this model currently has a training mesh setup or not.
Public function Virtual void

Init ( UMLDeformerAsset* InDeformerAsset
)

 Initialize the ML Deformer model.
Public function Virtual void Initialize the data that should be stored on the GPU.
Public function void Initialize the vertex map.
Public function void Call this if you want it to recalculate the memory usage again after the tick has completed.
Public function Const bool Check whether we invalidated the memory usage. If this returns true, we need to recompute it.
Public function Virtual Const bool Check whether the neural network of this model should run on the GPU or not.
Public function Virtual bool  
Public function FMLDeformerModelOnPostEditProperty & The delegate that gets fired when a property value changes.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void

SampleGroundTruthPositions ( float SampleTime,
TArray< FVector3f >& OutPositions
)

 Sample the positions from the target (ground truth) mesh, at a specific time (in seconds).
Public function Virtual void

Serialize ( FArchive& Archive
)

  
Public function void

SetAlignmentTransform ( const FTransform& Transform
)

 Set the alignment transform, which is the transform applied to the target mesh vertices, before calculating the deltas.
Public function void Set the animation sequence object to use for training.
Public function void Set the list of bones that should be included during training.
Public function void Set the list of curves that should be included during training.
Public function void

SetDeltaCutoffLength ( float Length
)

 Set the delta cutoff length.
Protected function void Set the training input information.
Protected function void

SetNumBaseMeshVerts ( int32 NumVerts
)

 Set the number of vertices in the base mesh.
Protected function void

SetNumTargetMeshVerts ( int32 NumVerts
)

 Set the number of vertices in the target mesh.
Public function void This method and property has been removed and shouldn't be used anymore.
Public function void This method and property has been removed and shouldn't be used anymore.
Public function void Set the skeletal mesh that this deformer uses.
Public function void

SetTrainingFrameLimit ( int32 MaxNumFrames
)

 Set the maximum number of frames to train on.
Public function void

SetVertexMap ( const TArray< int32 >& Map
)

 Manually set the vertex map. This normally gets initialized automatically.
Public function void

SetVizSettings ( UMLDeformerVizSettings* VizSettingsObject
)

 Set the visualization settings object. You need to call this in the constructor of your model.
Public function Const bool This method and property has been removed and shouldn't be used anymore.
Public function Const bool This method and property has been removed and shouldn't be used anymore.
Public function Virtual void Update the cached number of vertices of both base and target meshes.
Public function Virtual void Force update the cached memory usage.
Public function Virtual void Update the cached number of vertices in the base mesh.
Public function Virtual void Update the cached number of target mesh vertices.

Variables

  Type Name Description
Private variable UProperty Category, EditAnywhere FTransform AlignmentTransform The transform that aligns the Geometry Cache to the SkeletalMesh.
Private variable UProperty Category, EditAnywhere TSoftObjectPtr< UAnimSequence > AnimSequence The animation sequence to apply to the base mesh.
Private variable UProperty bool bIncludeBones_DEPRECATED Specifies whether bone transformations should be included as inputs during the training process.
Private variable UProperty bool bIncludeCurves_DEPRECATED Specifies whether curve values (a float per curve) should be included as inputs during the training process.
Protected variable bool bInvalidateMemUsage Should we recalculate the memory usage?
Private variable UProperty Meta TArray< FBoneReference > BoneIncludeList The bones to include during training.
Protected variable uint64 CookedMemUsageInBytes The cooked memory usage.
Private variable UProperty Meta TArray< FMLDeformerCurveReference > CurveIncludeList The curves to include during training.
Private variable TObjectPtr< UMLDeformerAsset > DeformerAsset The deformer asset that this model is part of.
Private variable UProperty Category, EditAnywhere, Meta float DeltaCutoffLength Sometimes there can be some vertices that cause some issues that cause deltas to be very long.
Public variable FMLDeformerModelOnPostEditProperty FNeuralNetworkModifyDelegate  
Protected variable uint64 GPUMemUsageInBytes GPU memory usage.
Private variable UProperty TObjectPtr< UMLDeformerInputInfo > InputInfo The information about the neural network inputs.
Private variable UProperty Category, EditAnywhere, Meta int32 MaxTrainingFrames The maximum numer of training frames (samples) to train on.
Protected variable uint64 MemUsageInBytes The computed memory usage.
Private variable FNeuralNetworkModifyDelegate NeuralNetworkModifyDelegate_DEPRECATED Delegate that will be called immediately before the NeuralNetwork is changed.
Private variable UProperty int32 NumBaseMeshVerts Cached number of skeletal mesh vertices.
Private variable UProperty int32 NumTargetMeshVerts Cached number of target mesh vertices.
Private variable FMLDeformerModelOnPostEditProperty PostEditPropertyDelegate The delegate that gets fired when a property is being modified.
Private variable FMLDeformerReinitModelInstancesDelegate ReinitModelInstanceDelegate Delegate used to trigger reinitialization of the model instance.
Private variable FRenderCommandFence RenderResourceDestroyFence Fence used in render thread cleanup on destruction.
Private variable UProperty Category, EditAnywhere TObjectPtr< USkeletalMesh > SkeletalMesh The skeletal mesh that represents the linear skinned mesh.
Public variable FMLDeformerModelOnPostEditProperty UObject The ML Deformer runtime model base class. All models should be inherited from this class.
Private variable UProperty TArray< int32 > VertexMap This is an index per vertex in the mesh, indicating the imported vertex number from the source asset.
Private variable UE::MLDeformer::FVertexMapBuffer VertexMapBuffer GPU buffers for Vertex Map.
Private variable UProperty TObjectPtr< UMLDeformerVizSettings > VizSettings  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page