1. Epic GamesDeveloper
  3. UMLDeformerModelInstance

UMLDeformerModelInstance

An instance of the ML Deformer model.

API > API/Plugins > API/Plugins/MLDeformerFramework

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UMLDeformerModelInstance : public UObject

Remarks

An instance of the ML Deformer model. The ML Deformer model contains shared data, while this instance contains data unique to the actor it is being applied to. So if you have 1 ML Deformer model, applied to 100 enemy actors, you will get 100 ML Deformer Model Instance objects. The model instance is created and managed by the ML Deformer component. The main task of the model instance is to feed the neural network with the right input values and run the neural network inference at runtime, and possibly do something with the output.

Variables

  Type Name Description
Protected variable TArray< int32 > AssetBonesToSkelMeshMappings Maps the ML deformer asset bone index to a skeletal mesh component bone index.
Protected variable bool bHasPostInitialized Has this instance had a successful UMLDeformerModel::PostMLDeformerComponentInit call?
Protected variable bool bIsCompatible Are the deformer asset and the used skeletal mesh component compatible?
Protected variable TArray< FTransform > DebugBoneSpaceTransforms The debug bone space transforms.
Protected variable FString ErrorText The compatibility error text, in case bIsCompatible is false.
Protected variable UProperty Transient TObjectPtr< UMLDeformerModel > Model The ML Deformer model that this is an instance of.
Protected variable FRenderCommandFence RenderCommandFence The fence that let's us wait for all render commands to finish, before we continue.
Protected variable TObjectPtr< USkeletalMeshComponent > SkeletalMeshComponent The skeletal mesh component we work with. This is mainly used for compatibility checks.
Protected variable TArray< FTransform > TrainingBoneTransforms The cached current local space bone transforms for the current frame.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual FString

CheckCompatibility ( USkeletalMeshComponent* InSkelMeshComponent,
bool bLogIssues
)

 Check whether the deformer is compatible with a given skeletal mesh component.
Public function Virtual void Copy over data from the debug actor, if any is used.
Public function Virtual void

CopyDataFromDebugActor ( const AActor* DebugActor,
const UMLDeformerComponent* DebugMLDeformerComponent
)

 Copy data from a specific debug actor.
Protected function Virtual void

Execute ( float ModelWeight
)

 Execute the model instance, which can run the neural network inference in case the model uses a neural network.
Public function Const const FString & Get the compatibility error text.
Public function Const USkeletalMeshComponent * Get the skeletal mesh component to get transforms from etc.
Public function Const UMLDeformerComponent * Get the ML Deformer component that this instance is part of.
Public function Const UMLDeformerModel * Get the model that this is an instance of.
Public function Const int32 Get the neural network inference handle.
Public function Const USkeletalMeshComponent * Get the skeletal mesh component we're working with.
Protected function Virtual void Handle when the model weight is zero.
Public function Const bool Check whether we already called UMLDeformerModel::PostMLDeformerComponentInit.
Protected function Const bool Check whether we have valid transforms in the skeletal mesh component.
Public function Virtual void

Init ( USkeletalMeshComponent* SkelMeshComponent
)

 Initialize the model instance.
Public function Const bool Is the deformer asset used compatible with the skeletal mesh component used during the Init call?
Public function Virtual Const bool Check if we are in a valid state for the deformer graph's data provider.
Public function Virtual void Initialize this model, after the ML deformer component has been initialized.
Public function Virtual void

PostTick ( bool bExecuteCalled
)

 Executed at the end of the tick.
Public function Virtual void

Release ()

 Release all built lookup tables etc. Also call this base class method if you override this method.
Protected function Virtual int64

SetBoneTransforms ( float* OutputBuffer,
int64 OutputBufferSize,
int64 StartIndex
)

 Set the bone transformations inside a given output buffer, starting from a given StartIndex.
Protected function Virtual int64

SetCurveValues ( float* OutputBuffer,
int64 OutputBufferSize,
int64 StartIndex
)

 Set the animation curve values inside a given output buffer, starting from a given StartIndex.
Public function void

SetHasPostInitialized ( bool bHasInitialized
)

 Set whether we had a successful call to UMLDeformerModel::PostMLDeformerComponentInit.
Public function void

SetModel ( UMLDeformerModel* InModel
)

 Set the deformer model that this is an instance of.
Protected function Virtual int64

SetNeuralNetworkInputValues ( float* InputData,
int64 NumInputFloats
)

 Update the neural network input values directly inside its input tensor.
Protected function Virtual bool Setup the neural network for this frame.
Public function Virtual void

Tick ( float DeltaTime,
float ModelWeight
)

 Update the deformer instance.
Protected function void Updates the bone transforms array.
Public function void Update the compatibility status, as returned by IsCompatible() and GetCompatibilityErrorText().

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page