Version: 1.10
LanguageEnglish
  • C#

AnimationStrideWarpingPlayable

struct in UnityEngine.Animations

/

Implemented in:UnityEngine.AnimationModule


Implements interfaces:IPlayable

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A Playable that warps character stride to match desired locomotion speed and direction, adjusting foot placement and hips position for natural movement.

This playable supports two modes: 1) Manual: provide stride direction and scale directly.

2) Graph: derive stride parameters from locomotion speed and other graph inputs.

The playable adjusts IK and FK foot bones to achieve proper foot placement while compensating for thigh rotation and respecting FK limits.

Hips position can be adjusted using spring physics for smooth vertical motion.

Static Properties

NullReturns a null AnimationStrideWarpingPlayable.

Public Methods

GetClampIKUsingFKLimitsReturns whether IK clamping using FK limits is enabled.
GetCompensateIKUsingFKThighRotationReturns whether IK compensation using FK thigh rotation is enabled.
GetFeetGets the configured foot configurations.
GetFloorNormalDirectionGets the current floor normal direction.
GetGravityDirectionGets the current gravity direction.
GetHipsBoneGets the configured hips bone name.
GetHipsDownErrorToleranceGets the current error tolerance.
GetHipsDownMaxIterationsGets the maximum iteration count.
GetHipsDownMaxOffsetGets the maximum hips down offset.
GetHipsDownSpringDampingGets the spring damping ratio.
GetHipsDownSpringMaxIterationsGets the maximum spring iteration count.
GetHipsDownSpringStiffnessGets the spring stiffness.
GetHipsDownSpringUpdateRateGets the spring update rate.
GetHipsDownWeightGets the current hips down weight.
GetInterpSpeedGets the interpolation speed.
GetLocomotionSpeedGets the current locomotion speed.
GetMaxChangeSpeedGets the maximum change speed.
GetMinRootMotionSpeedThresholdGets the minimum root motion speed threshold.
GetModeGets the current stride warping mode.
GetNodeWeightReturns the current node weight.
GetOrientStrideDirectionUsingFloorNormalReturns whether stride direction is oriented using floor normal.
GetSmoothTimeGets the smoothing time.
GetStrideDirectionGets the current stride direction.
GetStrideScaleGets the current stride scale.
GetUseSmoothDampingReturns whether smooth damp or exponential decay interpolation is used.
SetClampIKUsingFKLimitsIf enabled, clamps IK foot placement using FK joint limits.
SetCompensateIKUsingFKThighRotationIf enabled, compensates IK foot placement using FK thigh rotation.
SetFeetSets the foot configuration for stride warping.
SetFloorNormalDirectionSets the floor normal direction for orientation calculations.
SetGravityDirectionSets the gravity direction for stride scale calculations.
SetHipsBoneDefines the hips bone for vertical adjustment.
SetHipsDownErrorToleranceSets the error tolerance for hips vertical adjustment.
SetHipsDownMaxIterationsSets the maximum number of iterations for hips vertical adjustment.
SetHipsDownMaxOffsetSets the maximum vertical offset for hips adjustment.
SetHipsDownSpringDampingSets the damping ratio for the hips spring physics.
SetHipsDownSpringMaxIterationsSets the maximum number of iterations for the hips spring physics.
SetHipsDownSpringStiffnessSets the stiffness for the hips spring physics.
SetHipsDownSpringUpdateRateSets the update rate for the hips spring physics simulation.
SetHipsDownWeightSets the weight for hips vertical adjustment.
SetInterpSpeedSets the exponential decay interpolation speed.
SetLocomotionSpeedSets the locomotion speed for Graph mode.
SetMaxChangeSpeedSets the maximum speed of change for stride parameters.
SetMinRootMotionSpeedThresholdSets the minimum root motion speed threshold below which stride warping is disabled.
SetModeSets how stride parameters are provided (Manual or Graph).
SetNodeWeightSets the blend weight for mixing between the input animation and the warp result.
SetOrientStrideDirectionUsingFloorNormalIf enabled, orients the stride direction using the floor normal.
SetSmoothTimeSets the smooth time used by a SmoothDamp-style filter.
SetStrideDirectionSets the direction of the stride for Manual mode.
SetStrideScaleSets the scale factor for stride length.
SetUseSmoothDampingIf true, uses SmoothDamp for smoothing. If false, uses exponential decay interpolation.

Static Methods

CreateCreates an AnimationStrideWarpingPlayable in the PlayableGraph.