FMLDeformerMorphModelEditorModel

The editor model related to the runtime [UMLDeformerMorphModel](API\Plugins\MLDeformerFramework\UMLDeformerMorphModel) class, or models inherited from that.

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

Inheritance Hierarchy

References

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

Syntax

class FMLDeformerMorphModelEditorModel : public UE::MLDeformer::FMLDeformerGeomCacheEditorModel

Remarks

The editor model related to the runtime UMLDeformerMorphModel class, or models inherited from that.

Variables

  Type Name Description
Protected variable TArray< float > InputItemMaskBufferBackup The backup of the input item mask buffer. This contains all the bone and bone group masks.
Protected variable TArray< FVector3f > MorphTargetDeltasBackup The entire set of morph target deltas, 3 per vertex, for each morph target, as one flattened buffer.

Functions

  Type Name Description
Public function void

AddRequiredBones ( const FReferenceSkeleton& RefSkel,
int32 SkeletonBoneIndex,
const TArray< int32 >& VirtualParentTable,
TArray< int32 >& OutBonesAdded
)

 Add any required bone to the mask.
Public function void

ApplyBoneToMask ( int32 SkeletonBoneIndex,
TArrayView< float > MaskBuffer
)

 Add bone influences to the mask.
Public function Const TArray< int32 >

BuildVirtualParentTable ( const FReferenceSkeleton& RefSkel,
const TArray< FName >& IncludedBoneNames
)

 Build a mapping table that tells us the virtual parent for each bone in the ref skeleton.
Protected function Const float

CalcGlobalMaskWeight ( int32 RenderVertexIndex,
const FColorVertexBuffer& ColorBuffer,
EMLDeformerMaskChannel MaskChannel,
bool bInvertMaskChannel
)

 Calculate the global mask weight for a specific render vertex, using a color buffer and specified mask channel settings.
Protected function Virtual void

CalcMorphTargetNormals ( int32 LOD,
const USkeletalMesh* SkelMesh,
int32 MorphTargetIndex,
const TArrayView< const FVector3f > Deltas,
const TArrayView< const FVector3f > BaseVertexPositions,
const TArrayView< const FVector3f > BaseNormals,
const TArrayView< const int32 > ImportedVertexToRenderVertexMapping,
const FColorVertexBuffer& ColorBuffer,
EMLDeformerMaskChannel MaskChannel,
bool bInvertGlobalMaskChannel,
TArray< FVector3f >& OutDeltaNormals
)

 Calculate the delta normals for a given morph target.
Protected function Const void

CalcVertexNormals ( TArrayView< const FVector3f > VertexPositions,
TArrayView< const uint32 > IndexArray,
TArrayView< const int32 > VertexMap,
TArray< FVector3f >& OutNormals
)

 Calculate the normals for each vertex, given the triangle data and positions.
Protected function void Clamp the current morph target number inside the visualization settings to a valid range.
Protected function void

CompressMorphTargets ( FMorphTargetVertexInfoBuffers& OutMorphBuffers,
const TArray< UMorphTarget* >& MorphTargets,
int32 LOD,
float MorphErrorTolerance
)

 Compress morph targets into GPU based morph buffers.
Protected function void

CreateMorphTargets ( TArray< UMorphTarget* >& OutMorphTargets,
const TArray< FVector3f >& Deltas,
const FString& NamePrefix,
int32 LOD,
float DeltaThreshold,
bool bIncludeNormals,
const EMLDeformerMaskChannel MaskChannel,
bool bInvertMaskChannel
)

 Generate engine morph targets from a set of deltas.
Protected function void

DebugDrawMorphTarget ( FPrimitiveDrawInterface* PDI,
const TArray< FVector3f >& MorphDeltas,
float DeltaThreshold,
int32 MorphTargetIndex,
const FVector& DrawOffset
)

 Debug draw specific morph targets using lines and points.
Public function Const void

FillMaskValues ( TArrayView< float > ItemMaskBuffer,
float Value
)

 Fill the mask buffer for a given item with a specific value.
Public function Const int32

FindVirtualParentIndex ( const FReferenceSkeleton& RefSkel,
int32 BoneIndex,
const TArray< FName >& IncludedBoneNames
)

 Find the virtual parent for a given bone.
Public function Virtual Const const TArrayView< const float >

GetMaskForMorphTarget ( int32 MorphTargetIndex
)

 Get the mask buffer for a given morph target.
Public function Const UMLDeformerMorphModel * Helpers.
Public function Const UMLDeformerMorphModelVizSettings * Helpers.
Protected function Virtual void

InitEngineMorphTargets ( const TArray< FVector3f >& Deltas
)

 Initialize a set of engine morph targets and compress them to GPU friendly buffers.
Public function Virtual Const bool Check if input masking is supported in this model.
Public function Static FMLDeformerEditorModel * We need to implement this static MakeInstance method.
Protected function Const bool

ProcessVertexDelta ( FVector3f& OutScaledDelta,
FVector3f& OutScaledDeltaNormal,
const FVector3f RawDelta,
const FVector3f RawDeltaNormal,
float DeltaThreshold,
float MorphMaskWeight,
float GlobalMaskWeight
)

 Process and filter a vertex delta position and normal and apply scaling to it.
Public function void

RecursiveAddBoneToMaskDownwards ( const FReferenceSkeleton& RefSkel,
int32 SkeletonBoneIndex,
int32 MaxHierarchyDepth,
const TArray< int32 >& VirtualParentTable,
TArray< int32 >& OutBonesAdded,
int32 CurHierarchyDepth
)

 Recursively add bone masks for this bone and its children.
Public function void

RecursiveAddBoneToMaskUpwards ( const FReferenceSkeleton& RefSkel,
int32 SkeletonBoneIndex,
int32 MaxHierarchyDepth,
const TArray< int32 >& VirtualParentTable,
TArray< int32 >& OutBonesAdded,
int32 CurHierarchyDepth
)

 Recursively add bone masks for this bone and its parents.
Protected function void Update the morph target error values.
Protected function void

ZeroDeltasByLengthThreshold ( TArray< FVector3f >& Deltas,
float Threshold
)

 Zero all deltas with a length equal to, or smaller than the threshold value.

Overridden from FMLDeformerEditorModel

  Type Name Description
Public function Virtual Const FString Get the path to the heat map deformer graph asset.
Public function Virtual void

OnPostTraining ( ETrainingResult TrainingResult,
bool bUsePartiallyTrainedWhenAborted
)

 This method is executed after training.
Public function Virtual void This is called just before we start the training process.
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.

Overridden from FGCObject

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

Deprecated Functions

  Type Name Description
Protected function Virtual void

CalcMorphTargetNormals ( int32 LOD,
USkeletalMesh* SkelMesh,
int32 MorphTargetIndex,
TArrayView< const FVector3f > Deltas,
TArrayView< const FVector3f > BaseVertexPositions,
TArrayView< FVector3f > BaseNormals,
TArray< FVector3f >& OutDeltaNormals
)

 Please use the CalcMorphTargetNormals method that takes more parameters.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page