1. Epic GamesDeveloper
  3. UMLDeformerComponent

UMLDeformerComponent

The ML mesh deformer component.

API > API/Plugins > API/Plugins/MLDeformerFramework

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable, ClassGroup&61;Component, BlueprintType, Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class UMLDeformerComponent : public UActorComponent

Remarks

The ML mesh deformer component. This works in combination with a MLDeformerAsset and SkeletalMeshComponent. The component will perform runtime inference of the deformer model setup inside the asset. When you have multiple skeletal mesh components on your actor, this component will try to use the skeletal mesh component that uses the same skeletal mesh as the applied deformer was trained on. If it cannot find that, it will use the first skeletal mesh component it finds.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere displayname bool bSuppressMeshDeformerLogWarnings Suppress mesh deformer logging warnings? This is used by the ML Deformer editor, as we don't want to show some warnings when using that.
Protected variable UProperty Category, EditAnywhere, Meta TObjectPtr< UMLDeformerAsset > DeformerAsset The deformer asset to use.
Protected variable TObjectPtr< UMLDeformerModelInstance > ModelInstance The deformation model instance. This is used to perform the runtime updates and run the inference.
Protected variable UProperty Transient int32 QualityLevel The quality level of the deformer.
Protected variable FDelegateHandle ReinitModelInstanceDelegateHandle The delegate handle used to bind to the reinit model instance delegate handle.
Protected variable FRenderCommandFence RenderCommandFence Render command fence that let's us wait for all other commands to finish.
Protected variable TObjectPtr< USkeletalMeshComponent > SkelMeshComponent The skeletal mesh component we want to grab the bone transforms etc from.
Protected variable UE::MLDeformer::FMLDeformerPerfCounter TickPerfCounter The performance counter that measures timing of the Tick function.
Protected variable UProperty Category, EditAnywhere, Meta float Weight How active is this deformer? Can be used to blend it in and out.

Constructors

  Type Name Description
Public function  

UMLDeformerComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function Const USkeletalMeshComponent * Find the skeletal mesh component to apply the deformer on.
Public function Const UFunction BlueprintCallable, Category UMLDeformerAsset * Get the ML Deformer asset that is used by this component.
Public function Static FName Get property names.
Public function Const UFunction BlueprintCallable, Category UMLDeformerModelInstance * Get the ML Deformer model instance that this component currently uses.
Public function Const UFunction BlueprintCallable, Category int32 The quality level of the deformer.
Public function Static FName  
Public function Const UFunction BlueprintCallable, Category USkeletalMeshComponent * Get the skeletal mesh component that the ML Deformer will work on.
Public function Const const UE::MLDeformer::FMLDeformerPerfCounter & Get the performance counter that measures how much time is spent inside the Tick function.
Public function Const UFunction BlueprintCallable, Category float Get the current ML Deformer weight.
Public function Static FName  
Protected function void

Init ()

 Initialize the component.
Protected function void  
Protected function void Reset the tick cycle counters.
Public function UFunction BlueprintCallable, Category void

SetDeformerAsset ( UMLDeformerAsset* InDeformerAsset
)

 Set the deformer asset that is used by this component.
Protected function Virtual void

SetDeformerAssetInternal ( UMLDeformerAsset*const InDeformerAsset
)

 Set the ML Deformer asset.
Public function UFunction BlueprintCallable, Category void

SetQualityLevel ( int32 InQualityLevel
)

 The quality level of the deformer.
Public function void Suppress logging warnings about mesh deformers not being set.
Public function UFunction BlueprintCallable, Category void

SetupComponent ( UMLDeformerAsset* InDeformerAsset,
USkeletalMeshComponent* InSkelMeshComponent
)

 Setup the ML Deformer, by picking the deformer asset and skeletal mesh component.
Public function UFunction BlueprintCallable, Category void

SetWeight ( float NormalizedWeightValue
)

 Set the ML Deformer weight.
Protected function Virtual void

SetWeightInternal ( const float NormalizedWeightValue
)

 Set the ML Deformer weight.
Protected function void  
Public function void Find the skeletal mesh component that this deformer should work on, and set it as our target component.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes.
Public function Virtual void Deactivates the SceneComponent.
Protected function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Deprecated Variables

  Type Name Description
Protected variable FDelegateHandle NeuralNetworkModifyDelegateHandle_DEPRECATED This member has been deprecated.

Deprecated Functions

  Type Name Description
Protected function void This method will be removed.
Protected function void This method will be removed.
Protected function void This method will be removed.
Protected function void This method will be removed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page