1. Epic GamesDeveloper
  3. FNeuralMorphEditorModel

FNeuralMorphEditorModel

The editor model related to the neural morph model's runtime class ([UNeuralMorphModel](API\Plugins\NeuralMorphModel\UNeuralMorphModel)).

API > API/Plugins > API/Plugins/NeuralMorphModelEditor

Inheritance Hierarchy

References

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

Syntax

class FNeuralMorphEditorModel : public UE::MLDeformer::FMLDeformerMorphModelEditorModel

Remarks

The editor model related to the neural morph model's runtime class (UNeuralMorphModel).

Variables

  Type Name Description
Protected variable int32 MaskVizItemIndex  
Public variable   PRAGMA_DISABLE_DEPRECATION_WARNINGS  

Functions

  Type Name Description
Public function void

ApplyMaskInfoToMaskBuffer ( const USkeletalMesh* SkeletalMesh,
const FNeuralMorphMaskInfo& MaskInfo,
TArrayView< float > ItemMaskBuffer
)

  
Public function void

BuildMaskBuffer ( TArray< float >& OutMaskBuffer
)

 Build a set of masks, all concatenated into one flat array.
Public function void

DebugDrawItemMask ( FPrimitiveDrawInterface* PDI,
int32 MaskItemIndex,
const FVector& DrawOffset
)

 Draw the mask for a given item. An item can be a bone, curve or anything else that has a mask.
Public function void

GenerateBoneGroupMaskInfo ( int32 InputInfoBoneGroupIndex,
int32 HierarchyDepth
)

 Generate the mask info for a given bone group.
Public function void

GenerateBoneGroupMaskInfos ( int32 HierarchyDepth
)

 Generate the mask infos for all bone groups.
Public function void

GenerateBoneMaskInfo ( int32 InputInfoBoneIndex,
int32 HierarchyDepth
)

 Generate the mask info for a given bone.
Public function void

GenerateBoneMaskInfos ( int32 HierarchyDepth
)

 Generate bone mask infos for all bones in the bone input list.
Public function Const FName Generate a unique name for a bone group.
Public function Const FName Generate a unique name for a curve group.
Public function Const int32 Get the mask visualization item index.
Public function Const UNeuralMorphModel * Get a pointer to the neural morph runtime model.
Public function Static FMLDeformerEditorModel * We need to implement this static MakeInstance method.
Public function void Rebuild the mask buffer.
Public function void Remove mask infos for bones that do not exist in the bone include list.
Public function void Clear all bone group mask infos.
Public function void Clear all bone mask infos.
Public function void

SetMaskVisualizationItemIndex ( int32 InMaskVizItemIndex
)

 Set the mask visualization item index.

Overridden from FMLDeformerMorphModelEditorModel

  Type Name Description
Public function Virtual Const const TArrayView< const float >

GetMaskForMorphTarget ( int32 MorphTargetIndex
)

 Get the mask buffer for a given morph target.
Public function Virtual Const bool Check if input masking is supported in this model.

Overridden from FMLDeformerEditorModel

  Type Name Description
Public function Virtual TSharedPtr< SMLDeformerInputWidget > Create the input widget.
Public function Virtual Const FText Get the text that we should display as overlay on top of the asset editor viewport.
Public function Virtual Const bool Check whether this model supports a per training input animation vertex mask.
Public function Virtual void

Init ( const InitSettings& Settings
)

 Initialize the model.
Public function Virtual void Initialize the input information, which basically describes what the inputs to the neural network are going to be.
Public function Virtual Const bool Load the trained network from an onnx file.
Public function Virtual void This is executed after the input assets have changed.
Public function Virtual void

OnPropertyChanged ( FPropertyChangedEvent& PropertyChangedEvent
)

 This is called whenever a property value changes in the UI.
Public function Virtual void

Render ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

 Render additional (debug) things in the viewport.
Public function Virtual ETrainingResult

Train ()

 Launch the training.
Public function Virtual void Update the state that is used to decide whether the Train button in the UI is enabled or not.
Public function Virtual void This should update the list of available training devices.

Overridden from FGCObject

  Type Name Description
Public function Virtual Const FString Overload this method to report a name for your referencer

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page