1. Epic GamesDeveloper
  3. FAnimNode_Steering

FAnimNode_Steering

Add procedural delta to the root motion attribute This is done via 2 techniques: 1) Scaling the root motion on an animation 2) Adding additional correction to root motion after accounting for the anticipated (potentially scaled) root motion The effects of 1) and 2) combine

API > API/Plugins > API/Plugins/AnimationWarpingRuntime

Add procedural delta to the root motion attribute This is done via 2 techniques: 1) Scaling the root motion on an animation 2) Adding additional correction to root motion after accounting for the anticipated (potentially scaled) root motion The effects of 1) and 2) combine

   
Name FAnimNode_Steering
Type struct
Header File /Engine/Plugins/Animation/AnimationWarping/Source/Runtime/Public/BoneControllers/AnimNode_Steering.h
Include Path #include "BoneControllers/AnimNode_Steering.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_Steering : public FAnimNode_SkeletalControlBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FAnimNode_Steering ()

 Note: We need to explicitly disable warnings on these constructors/operators for clang to be happy with deprecated variables. BoneControllers/AnimNode_Steering.h  
  BoneControllers/AnimNode_Steering.h  
  BoneControllers/AnimNode_Steering.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAnimNode_Steering()

   BoneControllers/AnimNode_Steering.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimatedTargetTime float The number of seconds in the future to sample the root motion to know how much this animation is expected to turn. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Evaluation
  • Meta=(PinShownByDefault)
bMirrored bool True if input animation is mirrored. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Filtering
  • Meta=(PinShownByDefault)
CurrentAnimAsset TObjectPtr< UAnimationAsset > Animation Asset for incorporating root motion data. If CurrentAnimAsset is set, and the animation has root motion rotation within the TargetTime, then those rotations will be scaled to reach the TargetOrientation. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Transient
  • BlueprintReadWrite
  • Category=Evaluation
  • Meta=(PinShownByDefault)
CurrentAnimAssetTime float Current playback time in seconds of the CurrentAnimAsset. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Transient
  • BlueprintReadWrite
  • Category=Evaluation
  • Meta=(PinShownByDefault)
DisableAdditiveBelowSpeed float Below this movement speed (based on the root motion in the animation) disable steering coming from the additive spring based correction BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Category=Evaluation
DisableSteeringBelowSpeed float Below this movement speed (based on the root motion in the animation) disable steering completely (both scaling and additive) BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Category=Evaluation
MaxScaleRatio float Will clamp the scaling ratio applied to below this threshold. Any error remaining will be compensated for linearly (using ProceduralTargetTime) BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Category=Evaluation
MinScaleRatio float Will clamp the scaling ratio applied to above this threshold. Any error remaining will be compensated for linearly (using ProceduralTargetTime) BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Category=Evaluation
MirrorDataTable TObjectPtr< UMirrorDataTable > If bMirrored is set, MirrorDataTable will be used for mirroring the CurrentAnimAsset during prediction. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • Transient
  • BlueprintReadWrite
  • Category=Evaluation
  • Meta=(PinShownByDefault)
ProceduralTargetTime float The number of seconds in the future before we should roughly attempt reach the TargetOrientation via additive correction. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Evaluation
  • Meta=(PinShownByDefault)
RootMotionThreshold float The minimum amount of root motion required to enable root motion scaling. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • DisplayName=RootMotionAngleThreshold
  • Category=Evaluation
TargetOrientation FQuat The Orientation to steer towards. BoneControllers/AnimNode_Steering.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Evaluation
  • Meta=(PinShownByDefault)

Protected

Name Type Remarks Include Path Unreal Specifiers
AngularVelocity FVector   BoneControllers/AnimNode_Steering.h  
RootBoneTransform FTransform   BoneControllers/AnimNode_Steering.h  

Functions

Public

Overridden from FAnimNode_SkeletalControlBase

Name Remarks Include Path Unreal Specifiers

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

   BoneControllers/AnimNode_Steering.h  

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

   BoneControllers/AnimNode_Steering.h  

virtual void UpdateInternal ( const FAnimationUpdateContext& Context
)

   BoneControllers/AnimNode_Steering.h  

Overridden from FAnimNode_Base

Name Remarks Include Path Unreal Specifiers

virtual void GatherDebugData ( FNodeDebugData& DebugData
)

   BoneControllers/AnimNode_Steering.h  

virtual void Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

   BoneControllers/AnimNode_Steering.h  

Operators

Name Remarks Include Path Unreal Specifiers
  BoneControllers/AnimNode_Steering.h  
  BoneControllers/AnimNode_Steering.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
TargetTime_DEPRECATED float Deprected old/unused parameter, to avoid breaking data BoneControllers/AnimNode_Steering.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use Procedural target time for the correction time scale and AnimatedTargetTime for the look ahead time on the animation")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page