1. Epic GamesDeveloper
  3. UMLDeformerMorphModel

UMLDeformerMorphModel

The morph model base class.

API > API/Plugins > API/Plugins/MLDeformerFramework

The morph model base class. This is the base class for models that generate and drive morph targets. Use this in combination with UMLDeformerMorphModelInstance or inherited classes.

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

Syntax

UCLASS (MinimalAPI)  
class UMLDeformerMorphModel : public UMLDeformerGeomCacheModel

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMLDeformerMorphModel ( const FObjectInitializer& ObjectInitializer
)

   MLDeformerMorphModel.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bClampMorphWeights bool Should we enable morph target weight clamping? The minimum and maximum values that it will be clamped against will be the min/max morph target weight values that have been seen when running the training dataset through the network. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
bHasOnlyEmptyMorphs bool Set to true when all the morph targets got their deltas filtered out. MLDeformerMorphModel.h  
bIncludeNormals bool Include vertex normals in the morph targets? The advantage of this can be that it is higher performance than recomputing the normals. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
  • Meta=(EditCondition="CanDynamicallyUpdateMorphTargets()")
bInvertMaskChannel bool Enable this if you want to invert the mask channel values. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
  • Meta=(EditCondition="CanDynamicallyUpdateMorphTargets() && MaskChannel != EMLDeformerMaskChannel::Disabled")
CompressedMorphDataSizeInBytes uint64 The compressed memory usage of the morph targets. MLDeformerMorphModel.h  
MaskChannel EMLDeformerMaskChannel The channel data that represents the delta mask multipliers. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
  • Meta=(EditCondition="CanDynamicallyUpdateMorphTargets()")
MorphCompressionLevel float The morph target compression level. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
  • DisplayName="Compression Level"
  • Meta=(ClampMin="0.01", ClampMax="1000", EditCondition="CanDynamicallyUpdateMorphTargets()")
MorphDeltaZeroThreshold float Morph target delta values that are smaller than or equal to this threshold will be zeroed out. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
  • DisplayName="Delta Zero Threshold"
  • Meta=(ClampMin="0.0", ClampMax="1.0", ForceUnits="cm", EditCondition="CanDynamicallyUpdateMorphTargets()")
MorphTargetDeltas TArray< FVector3f > The entire set of uncompressed morph target deltas, 3 per vertex, for each morph target, as one flattened buffer. MLDeformerMorphModel.h
  • NonTransactional
MorphTargetErrorOrder TArray< int32 > An array of integers where the first element is the most important morph target and the last element is the least important one. MLDeformerMorphModel.h  
MorphTargetErrors TArray< float > An error value, for each morph target. MLDeformerMorphModel.h  
MorphTargetSets TArray< TSharedPtr< FExternalMorphSet > > A morph target set for each LOD. MLDeformerMorphModel.h  
MorphTargetsMinMaxWeights TArray< FFloatInterval > The minimum and maximum weight values that the morph targets weights have seen during training. MLDeformerMorphModel.h  
RenderCommandFence FRenderCommandFence The fence that let's us wait for all render commands to finish, before this instance is destroyed. MLDeformerMorphModel.h  
UncompressedMorphDataSizeInBytes uint64 The uncompressed memory usage of the morph targets. MLDeformerMorphModel.h  
VertexAttributeName FName The global vertex attribute attribute name. MLDeformerMorphModel.h
  • EditAnywhere
  • Category="Morph Targets"
  • Meta=(EditCondition="CanDynamicallyUpdateMorphTargets() && MaskChannel == EMLDeformerMaskChannel::VertexAttribute", GetOptions="GetVertexAttributeNames", NoResetToDefault)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMorphSets ( int32 NumToAdd
)

   MLDeformerMorphModel.h  

virtual void BeginDestroy()

   MLDeformerMorphModel.h  

bool CanDynamicallyUpdateMorphTargets()

   MLDeformerMorphModel.h
  • BlueprintPure
  • Category="MLDeformerMorphModel"

void ClampMorphTargetWeights ( TArrayView< float > WeightsArray
)

 Perform the actual weight clamping to the values as set inside the MorphTargetsMinMaxWeights member. MLDeformerMorphModel.h  

void ClearMorphTargetSets()

   MLDeformerMorphModel.h  

virtual UMLDeformerInputInfo * CreateInputInfo()

   MLDeformerMorphModel.h  

virtual UMLDeformerModelInstance * CreateModelInstance ( UMLDeformerComponent* Component
)

   MLDeformerMorphModel.h  

virtual bool DoesSupportLOD()

   MLDeformerMorphModel.h  

virtual void FinalizeMorphTargets()

   MLDeformerMorphModel.h  

uint64 GetCompressedMorphDataSizeInBytes()

   MLDeformerMorphModel.h  

FName GetGlobalMaskAttributeName()

 Get the name of the attribute used for the global mask. MLDeformerMorphModel.h  

bool GetHasOnlyEmptyMorphs()

   MLDeformerMorphModel.h  

bool GetIncludeMorphTargetNormals()

   MLDeformerMorphModel.h  

bool GetInvertMaskChannel()

   MLDeformerMorphModel.h  

EMLDeformerMaskChannel GetMaskChannel()

   MLDeformerMorphModel.h  

float GetMaxMorphTargetErrorInUnits()

   MLDeformerMorphModel.h  

float GetMorphCompressionLevel()

   MLDeformerMorphModel.h  

float GetMorphDeltaZeroThreshold()

   MLDeformerMorphModel.h  

const TArray< FVector3f > & GetMorphTargetDeltas ()

 Get the morph target delta vectors array. MLDeformerMorphModel.h  

TArray< FVector3f > & GetMorphTargetDeltas ()

   MLDeformerMorphModel.h  

int32 GetMorphTargetDeltaStartIndex ( int32 MorphTargetIndex
) const

 Get the start index into the array of deltas (vectors3's), for a given morph target. MLDeformerMorphModel.h  

float GetMorphTargetDeltaThreshold()

   MLDeformerMorphModel.h  

float GetMorphTargetError ( int32 MorphIndex
) const

 Get the estimated error that disabling a specific morph target would introduce. MLDeformerMorphModel.h  
Get the array of morph target indices, sorted by error value, from largest to smallest error. MLDeformerMorphModel.h  

float GetMorphTargetErrorTolerance()

   MLDeformerMorphModel.h  
Get the morph target error values. MLDeformerMorphModel.h  
Get the estimated maximum weight values that the morph targets will ever have. MLDeformerMorphModel.h  

TSharedPtr< FExternalMorphSet > GetMorphTargetSet ( int32 LOD
) const

   MLDeformerMorphModel.h  

TSharedPtr< FExternalMorphSet > GetMorphTargetSet ()

 Get the morph target set. MLDeformerMorphModel.h  
Get the min and max morph target weight values that we seen on the output of the training data set. MLDeformerMorphModel.h  

int32 GetNumActiveMorphs ( int32 QualityLevel
) const

   MLDeformerMorphModel.h  

int32 GetNumLODs()

 Get the number of LOD levels that we have deltas for. MLDeformerMorphModel.h  

int32 GetNumMorphTargets ( int32 LOD
) const

   MLDeformerMorphModel.h  
  MLDeformerMorphModel.h  

TArrayView< const FMLDeformerMorphModelQualityLevel > GetQualityLevels()

 Get the quality levels. MLDeformerMorphModel.h  

TArray< FMLDeformerMorphModelQualityLevel > & GetQualityLevelsArray()

 Get the quality levels, with access to modify the quality levels. MLDeformerMorphModel.h  

uint64 GetUncompressedMorphDataSizeInBytes()

   MLDeformerMorphModel.h  

bool HasRawMorph()

   MLDeformerMorphModel.h  
Check whether clamping of morph target weights is enabled. MLDeformerMorphModel.h  

virtual bool IsNeuralNetworkOnGPU()

   MLDeformerMorphModel.h  

virtual bool IsReadyForFinishDestroy()

   MLDeformerMorphModel.h  

virtual void Serialize ( FArchive& Archive
)

   MLDeformerMorphModel.h  

void SetClampMorphTargetsWeights ( bool bEnabled
)

   MLDeformerMorphModel.h  

void SetHasOnlyEmptyMorphs ( bool bOnlyEmpty
)

   MLDeformerMorphModel.h  

void SetIncludeMorphTargetNormals ( bool bInclude
)

   MLDeformerMorphModel.h  

void SetInvertMaskChannel ( bool bInvert
)

   MLDeformerMorphModel.h  

void SetMaskChannel ( EMLDeformerMaskChannel Channel
)

   MLDeformerMorphModel.h  

void SetMorphCompressionlevel ( float Tolerance
)

   MLDeformerMorphModel.h  

void SetMorphCompressionLevel ( float Tolerance
)

   MLDeformerMorphModel.h  

void SetMorphDeltaZeroThreshold ( float Threshold
)

   MLDeformerMorphModel.h  

void SetMorphTargetDeltaFloats ( const TArray< float >& Deltas
)

 Set the per vertex deltas, as a set of floats. MLDeformerMorphModel.h
  • BlueprintCallable
  • Category="MLDeformerMorphModel"

void SetMorphTargetDeltas ( const TArray< FVector3f >& Deltas
)

 Set the morph target model deltas as an array of 3D vectors. MLDeformerMorphModel.h
  • BlueprintCallable
  • Category="MLDeformerMorphModel"

void SetMorphTargetDeltaThreshold ( float Threshold
)

   MLDeformerMorphModel.h  

void SetMorphTargetError ( int32 MorphIndex,
float Error
)

 Set the estimated error that disabling a specific morph target would introduce. MLDeformerMorphModel.h  

void SetMorphTargetErrorTolerance ( float Tolerance
)

   MLDeformerMorphModel.h  

void SetMorphTargetsErrorOrder ( const TArray< int32 >& MorphTargetOrder,
const TArray< float >& ErrorValues
)

 Set the order of importance during LOD, for the morph targets. MLDeformerMorphModel.h
  • BlueprintCallable
  • Category="MLDeformerMorphModel"

void SetMorphTargetsMaxWeights ( const TArray< float >& MaxWeights
)

 Set the maximum weights for each morph target when we pass the training inputs into the trained neural network. MLDeformerMorphModel.h
  • BlueprintCallable
  • Category="MLDeformerMorphModel"

void SetMorphTargetsMinMaxWeights ( const TArray< FFloatInterval >& MinMaxValues
)

 Set the minimum and maximum values that the morph targets weights have seen during training. MLDeformerMorphModel.h  

void SetMorphTargetsMinMaxWeights ( const TArray< float >& MinValues,
const TArray< float >& MaxValues
)

 Set the minimum and maximum values that the morph targets weights have seen during training. MLDeformerMorphModel.h
  • BlueprintCallable
  • Category="MLDeformerMorphModel"

void SetWeightMask ( EMLDeformerMaskChannel Channel
)

   MLDeformerMorphModel.h  

virtual void UpdateMemoryUsage()

   MLDeformerMorphModel.h  

virtual void UpdateStatistics()

 Update the statistics properties of this model. MLDeformerMorphModel.h  

Overridden from UMLDeformerGeomCacheModel

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   MLDeformerMorphModel.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   MLDeformerMorphModel.h  

virtual void PostLoad()

   MLDeformerMorphModel.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetClampMorphTargetWeightsPropertyName()

   MLDeformerMorphModel.h  

static FName GetCompressedMorphDataSizeInBytesPropertyName()

   MLDeformerMorphModel.h  

static FName GetGlobalMaskAttributePropertyName()

   MLDeformerMorphModel.h  

static FName GetIncludeMorphTargetNormalsPropertyName()

   MLDeformerMorphModel.h  

static FName GetInvertMaskChannelPropertyName()

   MLDeformerMorphModel.h  

static FName GetMaskChannelPropertyName()

   MLDeformerMorphModel.h  

static FName GetMorphCompressionLevelPropertyName()

   MLDeformerMorphModel.h  

static FName GetMorphDeltaZeroThresholdPropertyName()

 Get property names. MLDeformerMorphModel.h  

static FName GetMorphTargetDeltaThresholdPropertyName()

   MLDeformerMorphModel.h  

static FName GetMorphTargetErrorTolerancePropertyName()

   MLDeformerMorphModel.h  

static FName GetNumMorphTargetsPropertyName()

   MLDeformerMorphModel.h  

static FName GetQualityLevelsPropertyName()

   MLDeformerMorphModel.h  

static FName GetUncompressedMorphDataSizeInBytesPropertyName()

   MLDeformerMorphModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page