1. Epic GamesDeveloper
  3. UNeuralMorphModel

UNeuralMorphModel

Declare our log category.

API > API/Plugins > API/Plugins/NeuralMorphModel

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UNeuralMorphModel : public UMLDeformerMorphModel

Remarks

The neural morph model. This generates a set of highly compressed morph targets to approximate a target deformation based on bone rotations and/or curve inputs. During inference, the neural network inside this model runs on the CPU and outputs the morph target weights for the morph targets it generated during training. Groups of bones and curves can also be defined. Those groups will generate a set of morph targets together as well. This can help when shapes depend on multiple inputs. An external morph target set is generated during training and serialized inside the ML Deformer asset that contains this model. When the ML Deformer component initializes the morph target set is registered. Most of the heavy lifting is done by the UMLDeformerMorphModel class. The neural morph model has two modes: local and global. See the ENeuralMorphMode for a description of the two.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 BatchSize The number of frames per batch when training the model.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite bool bEnableBoneMasks Enable the use of per bone and bone group masks.
Public variable UProperty TMap< FName, FNeuralMorphMaskInfo > BoneGroupMaskInfos Information needed to generate a mask for each bone group.
Public variable UProperty TArray< FNeuralMorphBoneGroup > BoneGroups The set of bones that are grouped together and generate morph targets together as a whole.
Public variable UProperty TMap< FName, FNeuralMorphMaskInfo > BoneMaskInfos Information needed to generate a mask for each bone.
Public variable UProperty TArray< FNeuralMorphCurveGroup > CurveGroups The set of curves that are grouped together and generate morph targets together as a whole.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite displayname int32 GlobalNumHiddenLayers The number of hidden layers that the neural network model will have.\nHigher numbers will slow down performance but can deal with more complex deformations.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname int32 GlobalNumMorphTargets The number of morph targets to generate in total.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite displayname int32 GlobalNumNeuronsPerLayer The number of units/neurons per hidden layer.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float LearningRate The learning rate used during the model training.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite displayname int32 LocalNumHiddenLayers The number of hidden layers that the neural network model will have.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname int32 LocalNumMorphTargetsPerBone The number of morph targets to generate per bone, curve or group.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite displayname int32 LocalNumNeuronsPerLayer The number of units/neurons per hidden layer.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ENeuralMorphMode Mode The mode that the neural network will operate in.
Public variable UProperty TObjectPtr< UNeuralMorphNetwork > NeuralMorphNetwork The neural morph model network.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 NumIterations The number of iterations to train the model for.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float RegularizationFactor The regularization factor.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float SmoothLossBeta The beta parameter in the smooth L1 loss function, which describes below which absolute error to use a squared term.

Constructors

  Type Name Description
Public function  

UNeuralMorphModel ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UMLDeformerInputInfo *  
Public function Const int32  
Public function Const const TArray< FNeuralMorphBoneGroup > &  
Public function Const const TArray< FNeuralMorphCurveGroup > &  
Public function Virtual Const FString  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const float  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const ENeuralMorphMode  
Public function Const UNeuralMorphNetwork *  
Public function Virtual Const int32  
Public function Const int32  
Public function Const float  
Public function Const float  
Public function Const bool  
Public function Virtual Const bool  
Public function void  
Public function void

SetNumIterations ( int32 InNumIterations
)

  
Public function void  

Overridden from UMLDeformerMorphModel

  Type Name Description
Public function Virtual UMLDeformerModelInstance *  

Overridden from UMLDeformerGeomCacheModel

  Type Name Description
Public function Virtual Const void  
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual void  
Public function Virtual void

Serialize ( FArchive& Archive
)

  

See Also

ENeuralMorphMode

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page