Navigation
API > API/Plugins > API/Plugins/AnimationWarpingRuntime > API/Plugins/AnimationWarpingRuntime/BoneControllers
Inheritance Hierarchy
- FAnimNode_Base
- FAnimNode_SkeletalControlBase
- FAnimNode_StrideWarping
References
| Module | AnimationWarpingRuntime |
| Header | /Engine/Plugins/Animation/AnimationWarping/Source/Runtime/Public/BoneControllers/AnimNode_StrideWarping.h |
| Include | #include "BoneControllers/AnimNode_StrideWarping.h" |
Syntax
USTRUCT&40;BlueprintInternalUseOnly&41;
struct FAnimNode_StrideWarping : public FAnimNode_SkeletalControlBase
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bClampIKUsingFKLimits | Clamps the IK foot warping to prevent over-extension relative to the overall FK leg. | |
| bool | bCompensateIKUsingFKThighRotation | 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 | |
| bool | bDebugDrawIKFootAdjustment | Enable/Disable IK foot location debug drawing following initial foot adjustment. | |
| bool | bDebugDrawIKFootFinal | Enable/Disable IK foot location debug drawing following all adsjustments (Final warped result) | |
| bool | bDebugDrawIKFootOrigin | Enable/Disable IK foot location debug drawing prior to warping. | |
| bool | bDebugDrawPelvisAdjustment | Enable/Disable pelvis debug drawing following adjustment. | |
| bool | bDebugDrawThighAdjustment | Enable/Disable thigh debug drawing following adjustment. | |
| bool | bEnableDebugDraw | Enable/Disable stride warping debug drawing. | |
| bool | bOrientStrideDirectionUsingFloorNormal | Orients the specified (Manual) or computed (Graph) stride direction by the floor normal. | |
| float | DebugDrawScale | Scale all debug drawing visualization by a factor. | |
| FWarpingVectorValue | FloorNormalDirection | 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> | |
| TArray< FStrideWarpingFootDefinition > | FootDefinitions | Foot definitions specifying the IK, FK, and Thigh bone. | |
| FWarpingVectorValue | GravityDirection | Gravity direction, this value will internally convert into a corresponding Component-space representation prior to warping Default: World Space, Down Vector: <0,0,-1> | |
| FBoneReference | IKFootRootBone | IK Foot Root Bone definition. | |
| float | LocomotionSpeed | 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 | |
| float | MinRootMotionSpeedThreshold | 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 | |
| EWarpingEvaluationMode | Mode | Stride warping evaluation mode (Graph or Manual) | |
| FBoneReference | PelvisBone | Pevlis Bone definition. | |
| FIKFootPelvisPullDownSolver | PelvisIKFootSolver | Solver for controlling how much the pelvis is "pulled down" towards the IK/FK foot definitions during leg limb extension. | |
| FVector | StrideDirection | Component-space stride direction Example: A value of <1,0,0> will warp the leg stride along the Forward Vector | |
| float | StrideScale | 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 | |
| FInputClampConstants | StrideScaleModifier | Modifies the final stride scale value by optionally clamping and/or interpolating. |
Overridden from FAnimNode_SkeletalControlBase
| Type | Name | Description | |
|---|---|---|---|
| void | EvaluateSkeletalControl_AnyThread
(
FComponentSpacePoseContext& Output, |
Evaluate the new component-space transforms for the affected bones. | |
| bool | IsValidToEvaluate
(
const USkeleton* Skeleton, |
Return true if it is valid to Evaluate | |
| void | UpdateInternal
(
const FAnimationUpdateContext& Context |
Interface for derived skeletal controls to implement use this function to update for skeletal control base |
Overridden from FAnimNode_Base
| Type | Name | Description | |
|---|---|---|---|
| void | GatherDebugData
(
FNodeDebugData& DebugData |
Called to gather on-screen debug data. This is called on the game thread. | |
| void | Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
Called when the node first runs. |