FMLDeformerTrainingInputAnim | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MLDeformerFramework

An animation that is input to the training process. This is a base struct that only contains the animation sequence. For example a geometry cache based model should inherit from this struct and add a geom cache member property.


Name	FMLDeformerTrainingInputAnim
Type	struct
Header File	/Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFramework/Public/MLDeformerTrainingInputAnim.h
Include Path	#include "MLDeformerTrainingInputAnim.h"

Syntax

USTRUCT ()  
struct FMLDeformerTrainingInputAnim

Derived Classes

FMLDeformerGeomCacheTrainingInputAnim

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FMLDeformerTrainingInputAnim()		MLDeformerTrainingInputAnim.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
AnimSequence	TSoftObjectPtr< UAnimSequence >	The animation sequence.	MLDeformerTrainingInputAnim.h	EditAnywhere Category="Settings" Meta=(DisplayPriority=0)
bEnabled	bool	Is this animation enabled? If not, it is excluded from the training process.	MLDeformerTrainingInputAnim.h	EditAnywhere Category="Settings" Meta=(DisplayPriority=MAX_int32)
bUseCustomRange	bool	On default all frames are included, unless we specify a custom frame include range.	MLDeformerTrainingInputAnim.h	EditAnywhere Category="Frame Settings"
EndFrame	int32	The end frame number of the range of included frames. Only used when not all frames are included.	MLDeformerTrainingInputAnim.h	EditAnywhere Category="Frame Settings" Meta=(ClampMin="0", EditCondition="bUseCustomRange")
StartFrame	int32	The start frame number of the range of included frames. Only used when not all frames are included.	MLDeformerTrainingInputAnim.h	EditAnywhere Category="Frame Settings" Meta=(ClampMin="0", EditCondition="bUseCustomRange")
VertexMask	FName	The optional vertex attribute mask to use for this training data.	MLDeformerTrainingInputAnim.h	EditAnywhere Category="Settings"

Functions

Public

Name	Remarks	Include Path
virtual int32 ExtractNumAnimFrames()	How many frames does this input animation have? This is the maximum number of frames we can sample.	MLDeformerTrainingInputAnim.h
UAnimSequence * GetAnimSequence ()		MLDeformerTrainingInputAnim.h
const UAnimSequence * GetAnimSequence ()		MLDeformerTrainingInputAnim.h
const TSoftObjectPtr< UAnimSequence > & GetAnimSequenceSoftObjectPtr ()		MLDeformerTrainingInputAnim.h
TSoftObjectPtr< UAnimSequence > & GetAnimSequenceSoftObjectPtr ()		MLDeformerTrainingInputAnim.h
int32 GetEndFrame()		MLDeformerTrainingInputAnim.h
virtual int32 GetNumFramesToSample ()	Get the number of frames that we are sampling inside this animation.	MLDeformerTrainingInputAnim.h
int32 GetStartFrame()		MLDeformerTrainingInputAnim.h
bool GetUseCustomRange()		MLDeformerTrainingInputAnim.h
FName GetVertexMask()		MLDeformerTrainingInputAnim.h
bool IsEnabled()		MLDeformerTrainingInputAnim.h
virtual bool IsValid ()	Is this input animation valid? Returns true if we can sample from it.	MLDeformerTrainingInputAnim.h
void SetAnimSequence ( TSoftObjectPtr< UAnimSequence > Seq )		MLDeformerTrainingInputAnim.h
void SetEnabled ( bool bEnable )		MLDeformerTrainingInputAnim.h
void SetEndFrame ( int32 FrameIndex )		MLDeformerTrainingInputAnim.h
void SetStartFrame ( int32 FrameIndex )		MLDeformerTrainingInputAnim.h
void SetUseCustomRange ( bool bCustomRange )		MLDeformerTrainingInputAnim.h
void SetVertexMask ( FName MaskName )		MLDeformerTrainingInputAnim.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FName GetAnimSequencePropertyName()		MLDeformerTrainingInputAnim.h
static FName GetEnabledPropertyName()		MLDeformerTrainingInputAnim.h
static FName GetEndFramePropertyName()		MLDeformerTrainingInputAnim.h
static FName GetStartFramePropertyName()		MLDeformerTrainingInputAnim.h
static FName GetUseCustomRangePropertyName()		MLDeformerTrainingInputAnim.h
static FName GetVertexMaskPropertyName()		MLDeformerTrainingInputAnim.h

Navigation