1. Epic GamesDeveloper
  3. FAnimNode_OrientationWarping

FAnimNode_OrientationWarping

Maintains a look at direction for the upper body (orientation), while rotating the lower body to match capsule velocity direction Does nothing if the root motion velocity direction matches the desired / current capsule velocity direction

API > API/Plugins > API/Plugins/AnimationWarpingRuntime > API/Plugins/AnimationWarpingRuntime/BoneControllers

Inheritance Hierarchy

  • FAnimNode_SkeletalControlBase
  • FAnimNode_OrientationWarping

References

   
Module AnimationWarpingRuntime
Header /Engine/Plugins/Animation/AnimationWarping/Source/Runtime/Public/BoneControllers/AnimNode_OrientationWarping.h
Include #include "BoneControllers/AnimNode_OrientationWarping.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_OrientationWarping : public FAnimNode_SkeletalControlBase

Remarks

Maintains a look at direction for the upper body (orientation), while rotating the lower body to match capsule velocity direction Does nothing if the root motion velocity direction matches the desired / current capsule velocity direction

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta bool bCounterCompenstateInterpolationByRootMotion Whether to counter compensate interpolation by the animated root motion angle change over time.
Public variable UProperty Category, EditAnywhere bool bEnableDebugDraw Enable/Disable orientation warping debug drawing.
Public variable UProperty Category, EditAnywhere, Meta bool bScaleByGlobalBlendWeight  
Public variable UProperty Category, EditAnywhere, Meta bool bUseManualRootMotionVelocity  
Public variable UProperty Category, EditAnywhere, Meta float CounterCompensateInterpSpeed Same as RotationInterpSpeed, but for CounterCompensate smoothing.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite Transient TObjectPtr< UAnimationAsset > CurrentAnimAsset Experimental.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite Transient float CurrentAnimAssetTime Experimental. Current playback time in seconds of the CurrentAnimAsset.
Public variable UProperty Category, EditAnywhere, Meta float DebugDrawScale Scale all debug drawing visualization by a factor.
Public variable UProperty Category, EditAnywhere, Meta float DistributedBoneOrientationAlpha Specifies how much rotation is applied to the character body versus IK feet.
Public variable UProperty Category, EditAnywhere, Meta TArray< FBoneReference > IKFootBones IK Foot definitions.
Public variable UProperty Category, EditAnywhere, Meta FBoneReference IKFootRootBone IK Foot Root Bone definition.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float LocomotionAngle The character locomotion angle (in degrees) relative to the specified RotationAxis This will be used in the following equation for computing the orientation angle: [Orientation = RotationBetween(RootMotionDirection, LocomotionDirection)] In most cases, this is the difference between the Velocity of the Movement Component and the actor rotation (obtained via CalculateDirection)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float LocomotionAngleDeltaThreshold Specifies an angle threshold to prevent erroneous over-rotation of the character, disabled with a value of 0
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FVector LocomotionDirection The character movement direction vector in world space When set, this vector is used to compute LocomotionAngle automatically.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FVector ManualRootMotionVelocity  
Public variable UProperty Category, EditAnywhere, Meta float MaxCorrectionDegrees Max correction we're allowed to do per-second when using interpolation.
Public variable UProperty Category, EditAnywhere, Meta float MaxRootMotionDeltaToCompensateDegrees Don't compensate our interpolator when the instantaneous root motion delta is higher than this. This is likely a pivot.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MinRootMotionSpeedThreshold Minimum root motion speed required to apply orientation warping This is useful to prevent unnatural re-orientation when the animation has a portion with no root motion (i.e starts/stops/idles) When this value is greater than 0, it's recommended to enable interpolation with RotationInterpSpeed > 0
Public variable UProperty Category, EditAnywhere EWarpingEvaluationMode Mode Orientation warping evaluation mode (Graph or Manual)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float OrientationAngle The desired orientation angle (in degrees) to warp by relative to the specified RotationAxis.
Public variable UProperty Category, EditAnywhere TEnumAsByte< EAxis::Type > RotationAxis Rotation axis used when rotating the character body.
Public variable UProperty Category, EditAnywhere, Meta float RotationInterpSpeed Specifies the interpolation speed (in Alpha per second) towards reaching the final warped rotation angle A value of 0 will cause instantaneous rotation, while a greater value will introduce smoothing
Public variable UProperty Category, EditAnywhere TArray< FBoneReference > SpineBones Spine bone definitions Used to counter rotate the body in order to keep the character facing forward The amount of counter rotation applied is driven by DistributedBoneOrientationAlpha
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float TargetTime Experimental.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EOrientationWarpingSpace WarpingSpace  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FTransform WarpingSpaceTransform  

Functions

  Type Name Description
Public function Virtual void

EvaluateSkeletalControl_AnyThread ( FComponentSpacePoseContext& Output,
TArray< FBoneTransform >& OutBoneTransforms
)

  
Public function Virtual void

GatherDebugData ( FNodeDebugData& DebugData
)

  
Public function Virtual void

Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

  
Public function Virtual bool

IsValidToEvaluate ( const USkeleton* Skeleton,
const FBoneContainer& RequiredBones
)

  
Public function Virtual void

UpdateInternal ( const FAnimationUpdateContext& Context
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page