1. Epic GamesDeveloper
  3. FMLDeformerMorphModelEditorModel

FMLDeformerMorphModelEditorModel

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

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

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

   
Name FMLDeformerMorphModelEditorModel
Type class
Header File /Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFrameworkEditor/Public/MLDeformerMorphModelEditorModel.h
Include Path #include "MLDeformerMorphModelEditorModel.h"

Syntax

class FMLDeformerMorphModelEditorModel : public UE::MLDeformer::FMLDeformerGeomCacheEditorModel

Inheritance Hierarchy

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Add any required bone to the mask. MLDeformerMorphModelEditorModel.h  

void ApplyBoneToMask ( int32 SkeletonBoneIndex,
TArrayView< float > MaskBuffer
)

 Add bone influences to the mask. MLDeformerMorphModelEditorModel.h  

void ApplyGeneratedMaskToVertexAttributes ( USkeletalMesh* SkeletalMesh,
FMLDeformerMaskInfo& MaskInfo,
TVertexAttributesRef< float > AttributeRef
)

 Apply a generated mask to a specific vertex attribute. MLDeformerMorphModelEditorModel.h  

void ApplyMaskInfoToBuffer ( const USkeletalMesh* SkeletalMesh,
const FMLDeformerMaskInfo& MaskInfo,
TArrayView< float > ItemMaskBuffer
)

 Apply the mask info to the mask buffer of floats. MLDeformerMorphModelEditorModel.h  

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

 Build a mapping table that tells us the virtual parent for each bone in the ref skeleton. MLDeformerMorphModelEditorModel.h  

void FillMaskValues ( TArrayView< float > ItemMaskBuffer,
float Value
) const

 Fill the mask buffer for a given item with a specific value. MLDeformerMorphModelEditorModel.h  

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

 Find the virtual parent for a given bone. MLDeformerMorphModelEditorModel.h  

virtual const TArrayView< const float > GetMaskForMorphTarget ( int32 MorphTargetIndex
) const

 Get the mask buffer for a given morph target. MLDeformerMorphModelEditorModel.h  

UMLDeformerMorphModel * GetMorphModel()

 Helpers. MLDeformerMorphModelEditorModel.h  

UMLDeformerMorphModelVizSettings * GetMorphModelVizSettings()

   MLDeformerMorphModelEditorModel.h  

virtual bool IsInputMaskingSupported ()

 Check if input masking is supported in this model. MLDeformerMorphModelEditorModel.h  
Returns whether this model supports morph output weight clamping or not. MLDeformerMorphModelEditorModel.h  

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

   MLDeformerMorphModelEditorModel.h  

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

 Recursively add bone masks for this bone and its children. MLDeformerMorphModelEditorModel.h  

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

 Recursively add bone masks for this bone and its parents. MLDeformerMorphModelEditorModel.h  

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

   MLDeformerMorphModelEditorModel.h  

Overridden from FMLDeformerEditorModel

Name Remarks Include Path Unreal Specifiers

virtual void CopyBaseSettingsFromModel ( const FMLDeformerEditorModel* SourceEditorModel
)

 Copy the common property values from a source model into this model. MLDeformerMorphModelEditorModel.h  

virtual FString GetHeatMapDeformerGraphDualQuatPath()

 Get the path to the heat map deformer graph asset, when using dual quaternion skinning. MLDeformerMorphModelEditorModel.h  

virtual FString GetHeatMapDeformerGraphPath()

 Get the path to the heat map deformer graph asset, when using linear skinning. MLDeformerMorphModelEditorModel.h  

virtual void OnMaxNumLODsChanged ()

 Executed when the maximum number of LOD levels changed. MLDeformerMorphModelEditorModel.h  

virtual void OnObjectModified ( UObject* Object
)

 Called whenever an engine object is being modified. MLDeformerMorphModelEditorModel.h  

virtual void OnPostTraining ( ETrainingResult TrainingResult,
bool bUsePartiallyTrainedWhenAborted
)

 This method is executed after training. MLDeformerMorphModelEditorModel.h  

virtual void OnPreTraining ()

 This is called just before we start the training process. MLDeformerMorphModelEditorModel.h  

virtual void OnPropertyChanged ( FPropertyChangedEvent& PropertyChangedEvent
)

 This is called whenever a property value changes in the UI. MLDeformerMorphModelEditorModel.h  

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

 Render additional (debug) things in the viewport. MLDeformerMorphModelEditorModel.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual FString GetReferencerName()

   MLDeformerMorphModelEditorModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

   MLDeformerMorphModelEditorModel.h  

TArray< float > CalcGlobalMaskWeights ( const TArray< int32 >& VertexMap,
const FColorVertexBuffer& ColorBuffer,
EMLDeformerMaskChannel MaskChannel,
bool bInvertMaskChannel
) const

 Calculate the global mask weight for a specific render vertex, using a color buffer and specified mask channel settings. MLDeformerMorphModelEditorModel.h  

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,
const TArray< float >& GlobalMaskWeights,
TArray< FVector3f >& OutDeltaNormals
)

 Calculate the delta normals for a given morph target. MLDeformerMorphModelEditorModel.h  

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
)

   MLDeformerMorphModelEditorModel.h  

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

 Calculate the normals for a given morph target. MLDeformerMorphModelEditorModel.h  

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

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

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

 Compress morph targets into GPU based morph buffers. MLDeformerMorphModelEditorModel.h  

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. MLDeformerMorphModelEditorModel.h  

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

 Debug draw specific morph targets using lines and points. MLDeformerMorphModelEditorModel.h  

virtual void InitEngineMorphTargets ( const TArray< FVector3f >& Deltas
)

 Initialize a set of engine morph targets and compress them to GPU friendly buffers. MLDeformerMorphModelEditorModel.h  

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

 Process and filter a vertex delta position and normal and apply scaling to it. MLDeformerMorphModelEditorModel.h  

void SetNeedsRebuildMaskBuffer()

 Tell the editor model that we should update the mask buffer on the next Tick call. MLDeformerMorphModelEditorModel.h  

void TransferMorphTargets ( TArray< UMorphTarget* > MorphTargetsLODZero
)

   MLDeformerMorphModelEditorModel.h  

void UpdateMorphErrorValues ( TArrayView< UMorphTarget* > MorphTargets
)

 Update the morph target error values. MLDeformerMorphModelEditorModel.h  

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

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

Static

Name Remarks Include Path Unreal Specifiers

static FMLDeformerEditorModel * MakeInstance()

 We need to implement this static MakeInstance method. MLDeformerMorphModelEditorModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page