Navigation
API > API/Plugins > API/Plugins/AnimationLocomotionLibraryEditor
Extracts traveling distance information from root motion and bakes it to a curve. A negative value indicates distance remaining to a stop or pivot point. A positive value indicates distance traveled from a start point or from the beginning of the clip.
| Name | UDistanceCurveModifier |
| Type | class |
| Header File | /Engine/Plugins/Animation/AnimationLocomotionLibrary/Source/Editor/Public/DistanceCurveModifier.h |
| Include Path | #include "DistanceCurveModifier.h" |
Syntax
UCLASS ()
class UDistanceCurveModifier : public UAnimationModifier
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAnimationModifier → UDistanceCurveModifier
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Axis | EDistanceCurve_Axis | Axes to calculate the distance value from. | DistanceCurveModifier.h |
|
| bStopAtEnd | bool | Root motion is considered to be stopped at the clip's end | DistanceCurveModifier.h |
|
| CurveName | FName | Name for the generated curve. | DistanceCurveModifier.h |
|
| SampleRate | int32 | Rate used to sample the animation. | DistanceCurveModifier.h |
|
| StopSpeedThreshold | float | Root motion speed must be below this threshold to be considered stopped. | DistanceCurveModifier.h |
|
Functions
Public
Overridden from UAnimationModifier
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnApply_Implementation
(
UAnimSequence* Animation |
DistanceCurveModifier.h | ||
virtual void OnRevert_Implementation
(
UAnimSequence* Animation |
DistanceCurveModifier.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float CalculateMagnitude
(
const FVector& Vector, |
Helper functions to calculate the magnitude of a vector only considering a specific axis or axes | DistanceCurveModifier.h | |
static float CalculateMagnitudeSq
(
const FVector& Vector, |
DistanceCurveModifier.h |