UMLDeformerAsset

The machine learning deformer asset.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMLDeformerAsset

References

Module	MLDeformer
Header	/Engine/Plugins/Experimental/MLDeformer/Source/MLDeformer/Public/MLDeformerAsset.h
Include	#include "MLDeformerAsset.h"

Syntax

UCLASS(BlueprintType, HideCategories=Object)
class UMLDeformerAsset :
public UObject,
public IBoneReferenceSkeletonProvider

Remarks

The machine learning deformer asset. At runtime this contains only the data needed to run the neural network inference. In the editor it contains the skeletal mesh and geometry cache that are required to calculate vertex position deltas.

Variables

	Name	Description
EActivationFunc...	ActivationFunction	The activation function to use in the neural network.
FTransform	AlignmentTransform	The transform that aligns the Geometry Cache to the SkeletalMesh.
TObjectPtr< UAn...	AnimSequence	The animation sequence to apply to the base mesh.
int32	BatchSize	The number of frames per batch when training the model.
TArray< FBoneRe...	BoneIncludeList	The bones to include during training.
int32	CacheSizeInMegabytes	The maximum allowed size of the training cache in memory, in megabytes.
TArray< FCurveR...	CurveIncludeList	The curves to include during training.
EDecayFunction	DecayFunction	The decay function to adapt the learning rate.
float	DecayRate	The decay rate to apply to the learning rate once non-decay epochs have been reached.
float	DeltaCutoffLength	Sometimes there can be some vertices that cause some issues that cause deltas to be very long.
EDeviceType	DeviceType	The loss function to use during model training.
int32	Epochs	The number of epochs to process without any decay.
int32	EpochsWithDecay	The number of epochs to process that include a decay.
TObjectPtr< UGe...	GeometryCache	The geometry cache that represents the complex mesh deformations.
FMLDeformerInpu...	InputInfo	The information about the neural network inputs.
float	LearningRate	The learning rate used during the model training.
ELossFunction	LossFunction	The loss function to use during model training.
int32	MaxTrainingFrames	The maximum numer of training frames (samples) to train on.
TObjectPtr< UNe...	NeuralNetwork	The neural network to use for inference.
float	NoiseAmount	The percentage of noise to add.
int32	NumGeomCacheVerts	Cached number of geom cache vertices.
int32	NumHiddenLayers	The number of hidden layers that the neural network model will have.
int32	NumNeuronsPerLayer	The number of units/neurons per hidden layer.
int32	NumSkeletalMeshVerts	Cached number of skeltal mesh vertices.
FRenderCommandF...	RenderResourceDestroyFence	Fence used in render thread cleanup on destruction.
float	ShrinkageSpeed	Shrinkage speed. Only if the shrinkage loss is used.
float	ShrinkageThreshold	Shrinkage threshold. Only if the shrinkage loss is used.
TObjectPtr< USk...	SkeletalMesh	The skeletal mesh that represents the linear skinned mesh.
ETrainingInputs	TempTrainingInputs
ETrainingInputs	TrainingInputs	Describes what inputs we should train the neural network on.
FVector3f	VertexDeltaMean	The vertex delta mean.
FVector3f	VertexDeltaScale	The vertex delta scale. This is passed to the deformer shader to rescale the output deltas.
TArray< int32 >	VertexMap	This is an index per vertex in the mesh, indicating the imported vertex number from the source asset.
FVertexMapBuffe...	VertexMapBuffer	GPU buffers for Vertex Map.
TObjectPtr< UML...	VizSettings	The visualization settings.

Constructors

	Name	Description
	UMLDeformerAsset ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	FMLDeformerI...	CreateInputInfo()
	int32	ExtractNumImportedGeomCacheVertices ( UGeometryCache* GeomCache )
	int32	ExtractNumImportedSkinnedVertices ( USkeletalMesh* SkeletalMesh )
	void	GenerateMeshMappings ( UMLDeformerAsset* DeformerAsse..., TArray< FMLDeformerMeshMapping >& ..., TArray< FString >& OutFailedImport... )
	const FTrans...	GetAlignmentTransform()
	UAnimSequenc...	GetAnimSequence()
	const UAnimS...	GetAnimSequence()
	FText	GetAnimSequenceErrorText ( UGeometryCache* InGeomCache, UAnimSequence* InAnimSequence )
	FText	GetBaseAssetChangedErrorText()
	const TArray...	GetBoneIncludeList()
	TArray< FBon...	GetBoneIncludeList()
	int32	GetCacheSizeInMegabytes()
	const TArray...	GetCurveIncludeList()
	TArray< FCur...	GetCurveIncludeList()
	float	GetDeltaCutoffLength()
	FText	GetGeomCacheErrorText ( UGeometryCache* InGeomCache )
	UGeometryCac...	GetGeometryCache()
	const UGeome...	GetGeometryCache()
	FText	GetIncompatibleSkeletonErrorText ( USkeletalMesh* InSkelMesh, UAnimSequence* InAnimSeq )
	UNeuralNetwo...	GetInferenceNeuralNetwork()
	const FMLDef...	GetInputInfo()
	FMLDeformerI...	GetInputInfo()
	FText	GetInputsErrorText()
	FText	GetMeshMappingErrorText()
	int32	GetNumFrames()
	int32	GetNumFramesForTraining()
	USkeletalMes...	GetSkeletalMesh()
	const USkele...	GetSkeletalMesh()
	FText	GetSkeletalMeshNeedsReimportErrorText()
	FText	GetTargetAssetChangedErrorText()
	ETrainingInp...	GetTempTrainingInputs()
	int32	GetTrainingFrameLimit()
	ETrainingInp...	GetTrainingInputs()
	const FVecto...	GetVertexDeltaMean()
	const FVecto...	GetVertexDeltaScale()
	FText	GetVertexErrorText ( USkeletalMesh* InSkelMesh, UGeometryCache* InGeomCache, const FText& SkelName, const FText& GeomCacheName )
	const TArray...	GetVertexMap()
	const FVerte...	GetVertexMapBuffer()
	const UMLDef...	GetVizSettings()
	UMLDeformerV...	GetVizSettings()
	void	InitBoneIncludeListToAnimatedBonesOnly()
	void	InitCurveIncludeListToAnimatedCurvesOnly()
	void	InitGPUData()
	void	InitVertexMap()
	bool	IsCompatibleWithNeuralNet()
	void	SetInputInfo ( const FMLDeformerInputInfo& Input )
	void	SetTempTrainingInputs ( ETrainingInputs Inputs )
	void	UpdateCachedNumVertices()

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IBoneReferenceSkeletonProvider

		Name	Description
	USkeleton &#...	GetSkeleton ( bool& bInvalidSkeletonIsError )	Called to get the skeleton that FBoneReference's details customization will use to populate bone names.