UMotionExtractorModifier | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/AnimationModifierLibrary

Extracts motion from a bone in the animation and bakes it into a curve


Name	UMotionExtractorModifier
Type	class
Header File	/Engine/Plugins/Animation/AnimationModifierLibrary/Source/AnimationModifierLibrary/Public/MotionExtractorModifier.h
Include Path	#include "MotionExtractorModifier.h"

Syntax

UCLASS ()  
class UMotionExtractorModifier : public UAnimationModifier

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UAnimationModifier → UMotionExtractorModifier

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UMotionExtractorModifier()		MotionExtractorModifier.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Axis	EMotionExtractor_Axis	Axis to get the value from	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
bAbsoluteValue	bool	Whether to convert the final value to absolute (positive)	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
bNormalize	bool	Whether we want a normalized value (0 - 1)	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
BoneName	FName	Bone we are going to generate the curve from	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
bRelativeToFirstFrame	bool	Whether to extract the bone transforms relative to the first frame in the animation	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
bRemoveCurveOnRevert	bool	Whether we want to remove the curve when we revert or re-apply modifier Disabling this allows you to modify settings and create a new curve each time you re-apply the modifier Enabling this is the preferred setting when using a modifier that's applied in bulk and you may want to remove/rename curves	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
bUseCustomCurveName	bool	Whether we want to specify a custom name for the curve.	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
CustomCurveName	FName	Custom name for the curve we are going to generate.	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="bUseCustomCurveName")
MathOperation	EMotionExtractor_MathOperation	Optional math operation to apply on the extracted value before add it to the generated curve	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
Modifier	float	Right operand for the math operation selected	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="MathOperation != EMotionExtractor_MathOperation::None")
MotionType	EMotionExtractor_MotionType	Type of motion to extract	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings
RelativeToBoneName	FName	Bone which we'll use as the reference frame to generate this curve from.	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(EditCondition="Space == EMotionExtractor_Space::RelativeToBone")
SampleRate	int32	Rate used to sample the animation	MotionExtractorModifier.h	EditAnywhere Category=Settings Meta=(ClampMin="1")
Space	EMotionExtractor_Space	Reference frame/space to use when extracting the bone pose.	MotionExtractorModifier.h	EditAnywhere BlueprintReadWrite Category=Settings

Functions

Public

Name	Remarks	Include Path
FName GetCurveName ()	Returns the name for the curve.	MotionExtractorModifier.h
float GetDesiredValue ( const FTransform& BoneTransform, const FTransform& LastBoneTransform, float DeltaTime ) const	Returns the desired value from the extracted poses	MotionExtractorModifier.h
virtual void OnApply_Implementation ( UAnimSequence* Animation )		MotionExtractorModifier.h
virtual void OnRevert_Implementation ( UAnimSequence* Animation )		MotionExtractorModifier.h
virtual void PostLoad()		MotionExtractorModifier.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
bComponentSpace_DEPRECATED	bool	Whether to extract the bone pose in component space or local space.	MotionExtractorModifier.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Deprecated Variables