1. Epic GamesDeveloper
  3. FMLDeformerSampler

FMLDeformerSampler

The input data sampler.

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

Inheritance Hierarchy

References

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

Syntax

class FMLDeformerSampler

Remarks

The input data sampler. This class can sample bone rotations, curve values and vertex deltas. It does this by creating two temp actors, one with skeletal mesh component and one with geom cache component.

Variables

  Type Name Description
Protected variable int32 AnimFrameIndex The animation frame we sampled the deltas for.
Protected variable TArray< FMatrix44f > BoneMatrices The sampled bone matrices.
Protected variable TArray< float > BoneRotations The bone rotation floats.
Protected variable TArray< float > CurveValues A float for each Skeleton animation curve.
Protected variable FMLDeformerEditorModel * EditorModel The vertex delta editor model used to sample.
Protected variable TObjectPtr< UMLDeformerModel > Model The vertex delta model associated with this sampler.
Protected variable int32 NumFloatsPerCurve The number of floats per curve value.
Protected variable int32 NumImportedVertices The number of imported vertices of the skeletal mesh and geometry cache. This will be 8 for a cube.
Protected variable float SampleTime The current sample time, in seconds.
Protected variable TObjectPtr< UDebugSkelMeshComponent > SkeletalMeshComponent The skeletal mesh component used to sample skinned positions.
Protected variable TObjectPtr< AActor > SkelMeshActor The skeletal mesh actor used to sample the skinned vertex positions.
Protected variable TArray< FVector3f > SkinnedVertexPositions The skinned vertex positions.
Protected variable TObjectPtr< AActor > TargetMeshActor The actor used for the target mesh.
Protected variable TArray< FVector3f > TempVertexPositions A temp array to store vertex positions in.
Protected variable TArray< FVector3f > UnskinnedVertexPositions The unskinned vertex positions.
Protected variable TArray< float > VertexDeltas The vertex deltas as float buffer.
Protected variable EVertexDeltaSpace VertexDeltaSpace The vertex delta space (pre or post skinning) used when calculating the deltas.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Const FMatrix44f

CalcInverseSkinningTransform ( int32 VertexIndex,
const FSkeletalMeshLODRenderData& SkelMeshLODData,
const FSkinWeightVertexBuffer& SkinWeightBuffer
)

 Calculate the inverse skinning transform, which is used to convert from post-skinning to pre-skinning space.
Public function Const SIZE_T Calculate the memory usage of the sampler.
Protected function Virtual void Create the actors used for sampling.
Protected function Const AActor *

CreateNewActor ( UWorld* InWorld,
const FName& Name
)

 Create a new actor with a specific name, in a specified world.
Protected function Const void

ExtractSkinnedPositions ( int32 LODIndex,
TArray< FMatrix44f >& InBoneMatrices,
TArray< FVector3f >& TempPositions,
TArray< FVector3f >& OutPositions
)

 Extract the skinned vertex positions, of the skeletal mesh.
Protected function Const void

ExtractUnskinnedPositions ( int32 LODIndex,
TArray< FVector3f >& OutPositions
)

 Extract the unskinned vertex positions, of the skeletal mesh.
Public function Const const TArray< float > & Get the current bone rotations that we can feed to a neural network.
Public function Const const TArray< float > & Get the float values for the curves. One float per curve.
Public function Const int32 Get the number of bones.
Public function Const int32 Get the number of floats per curve.
Public function Const int32 Get the number of imported vertices.
Public function UDebugSkelMeshComponent *  
Public function Const const TArray< FVector3f > & Get the skinned vertex positions of the skeletal mesh.
Public function Virtual Const float

GetTimeAtFrame ( int32 InAnimFrameIndex
)

 Get the time in seconds, at a given frame index.
Public function Const const TArray< FVector3f > & Get the unskinned vertex positions of the skeletal mesh.
Public function Const const TArray< float > & Get the calculated vertex deltas.
Public function Const EVertexDeltaSpace Get the space in which we will calculate the vertex deltas.
Public function Virtual void Call Init whenever assets or other relevant settings change.
Public function Const bool Have we already initialized this sampler? Is it ready for sampling?
Protected function Virtual void Register the target mesh components.
Public function Virtual void

Sample ( int32 AnimFrameIndex
)

 Call this every time the frame changes. This will update all buffer contents.
Public function void

SetNumFloatsPerCurve ( int32 NumFloats
)

 Set the number of floats used per curve.
Public function void Set the space in which we should calculate the vertex deltas.
Protected function void Update the bone rotation buffers.
Protected function void Update the curve value buffers.
Protected function void Update the skeletal mesh component's play position, and refresh its bone transforms internally.
Protected function void Update the skinned vertex positions.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page