Navigation
API > API/Plugins > API/Plugins/AnimationWarpingRuntime
| Name | FAnimNode_StrideWarping |
| Type | struct |
| Header File | /Engine/Plugins/Animation/AnimationWarping/Source/Runtime/Public/BoneControllers/AnimNode_StrideWarping.h |
| Include Path | #include "BoneControllers/AnimNode_StrideWarping.h" |
Syntax
USTRUCT (BlueprintInternalUseOnly)
struct FAnimNode_StrideWarping : public FAnimNode_SkeletalControlBase
Inheritance Hierarchy
- FAnimNode_Base → FAnimNode_SkeletalControlBase → FAnimNode_StrideWarping
Structs
| Name | Remarks |
|---|---|
| FStrideWarpingFootData |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bClampIKUsingFKLimits | bool | Clamps the IK foot warping to prevent over-extension relative to the overall FK leg. | BoneControllers/AnimNode_StrideWarping.h |
|
| bCompensateIKUsingFKThighRotation | bool | Include warping adjustment to the FK thigh bones alongside the IK/FK foot definitions This is used to help preserve the original overall leg shape | BoneControllers/AnimNode_StrideWarping.h |
|
| bDebugDrawIKFootAdjustment | bool | Enable/Disable IK foot location debug drawing following initial foot adjustment. | BoneControllers/AnimNode_StrideWarping.h |
|
| bDebugDrawIKFootFinal | bool | Enable/Disable IK foot location debug drawing following all adsjustments (Final warped result) | BoneControllers/AnimNode_StrideWarping.h |
|
| bDebugDrawIKFootOrigin | bool | Enable/Disable IK foot location debug drawing prior to warping. | BoneControllers/AnimNode_StrideWarping.h |
|
| bDebugDrawPelvisAdjustment | bool | Enable/Disable pelvis debug drawing following adjustment. | BoneControllers/AnimNode_StrideWarping.h |
|
| bDebugDrawThighAdjustment | bool | Enable/Disable thigh debug drawing following adjustment. | BoneControllers/AnimNode_StrideWarping.h |
|
| bDisableIfMissingRootMotion | bool | Do not execute stride warping if animation data has no root motion. | BoneControllers/AnimNode_StrideWarping.h |
|
| bEnableDebugDraw | bool | Enable/Disable stride warping debug drawing. | BoneControllers/AnimNode_StrideWarping.h |
|
| bOrientStrideDirectionUsingFloorNormal | bool | Orients the specified (Manual) or computed (Graph) stride direction by the floor normal. | BoneControllers/AnimNode_StrideWarping.h |
|
| DebugDrawScale | float | Scale all debug drawing visualization by a factor. | BoneControllers/AnimNode_StrideWarping.h |
|
| FloorNormalDirection | FWarpingVectorValue | Floor normal direction, this value will internally convert into a corresponding Component-space representation prior to warping Default: World Space, Up Vector: <0,0,1> | BoneControllers/AnimNode_StrideWarping.h |
|
| FootDefinitions | TArray< FStrideWarpingFootDefinition > | Foot definitions specifying the IK, FK, and Thigh bone. | BoneControllers/AnimNode_StrideWarping.h |
|
| GravityDirection | FWarpingVectorValue | Gravity direction, this value will internally convert into a corresponding Component-space representation prior to warping Default: World Space, Down Vector: <0,0,-1> | BoneControllers/AnimNode_StrideWarping.h |
|
| IKFootRootBone | FBoneReference | IK Foot Root Bone definition. | BoneControllers/AnimNode_StrideWarping.h |
|
| LocomotionSpeed | float | Locomotion speed, specifying the current speed of the character This will be used in the following equation for computing the stride scale: [StrideScale = (LocomotionSpeed / RootMotionSpeed)] Note: This speed should be relative to the delta time of the animation graph | BoneControllers/AnimNode_StrideWarping.h |
|
| MinRootMotionSpeedThreshold | float | Minimum root motion speed required to apply stride warping This is useful to prevent unnatural strides when the animation has a portion with no root motion (i.e starts/stops) When this value is greater than 0, it's recommended to enable interpolation in StrideScaleModifier | BoneControllers/AnimNode_StrideWarping.h |
|
| Mode | EWarpingEvaluationMode | Stride warping evaluation mode (Graph or Manual) | BoneControllers/AnimNode_StrideWarping.h |
|
| PelvisBone | FBoneReference | Pevlis Bone definition. | BoneControllers/AnimNode_StrideWarping.h |
|
| PelvisIKFootSolver | FIKFootPelvisPullDownSolver | Solver for controlling how much the pelvis is "pulled down" towards the IK/FK foot definitions during leg limb extension. | BoneControllers/AnimNode_StrideWarping.h |
|
| StrideDirection | FVector | Component-space stride direction Example: A value of <1,0,0> will warp the leg stride along the Forward Vector | BoneControllers/AnimNode_StrideWarping.h |
|
| StrideScale | float | Stride scale, specifying the amount of warping applied to the foot definitions Example: A value of 0.5 will decrease the effective leg stride by half, while a value of 2.0 will double it | BoneControllers/AnimNode_StrideWarping.h |
|
| StrideScaleModifier | FInputClampConstants | Modifies the final stride scale value by optionally clamping and/or interpolating. | BoneControllers/AnimNode_StrideWarping.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActualStrideDirection | FVector | Internal stride direction. | BoneControllers/AnimNode_StrideWarping.h | |
| ActualStrideScale | float | Internal stride scale. | BoneControllers/AnimNode_StrideWarping.h | |
| AnimInstanceProxy | FAnimInstanceProxy * | Internal cached anim instance proxy. | BoneControllers/AnimNode_StrideWarping.h | |
| bFoundRootMotionAttribute | bool | Whether we found a root motion delta attribute in the attribute stream on graph driven mode. | BoneControllers/AnimNode_StrideWarping.h | |
| CachedDeltaTime | float | Internal cached delta time used for interpolators. | BoneControllers/AnimNode_StrideWarping.h | |
| CachedRootMotionDeltaSpeed | float | Internal cached debug root motion speed. | BoneControllers/AnimNode_StrideWarping.h | |
| CachedRootMotionDeltaTranslation | FVector | Internal cached debug root motion delta translation. | BoneControllers/AnimNode_StrideWarping.h | |
| FootData | TArray< FStrideWarpingFootData > | Computed IK, FK, Thigh bone indices for the specified foot definitions. | BoneControllers/AnimNode_StrideWarping.h | |
| StrideScaleModifierState | FInputClampState | Internal cached stride scale modifier state. | BoneControllers/AnimNode_StrideWarping.h |
Functions
Public
Overridden from FAnimNode_SkeletalControlBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void EvaluateSkeletalControl_AnyThread
(
FComponentSpacePoseContext& Output, |
BoneControllers/AnimNode_StrideWarping.h | ||
virtual bool IsValidToEvaluate
(
const USkeleton* Skeleton, |
BoneControllers/AnimNode_StrideWarping.h | ||
virtual void UpdateInternal
(
const FAnimationUpdateContext& Context |
BoneControllers/AnimNode_StrideWarping.h |
Overridden from FAnimNode_Base
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GatherDebugData
(
FNodeDebugData& DebugData |
BoneControllers/AnimNode_StrideWarping.h | ||
virtual void Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
BoneControllers/AnimNode_StrideWarping.h |