1. Epic GamesDeveloper
  3. FAnimNode_OffsetRootBone

FAnimNode_OffsetRootBone

API > API/Plugins > API/Plugins/AnimationWarpingRuntime

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

Syntax

USTRUCT (BlueprintInternalUseOnly, Experimental)  
struct FAnimNode_OffsetRootBone : public FAnimNode_Base

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bClampToRotationVelocity bool Whether to limit the offset's rotation interpolation speed to the velocity on the incoming motion Enabling this prevents the offset sliding when there's little to no rotation speed BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
bClampToTranslationVelocity bool Whether to limit the offset's translation interpolation speed to the velocity on the incoming motion Enabling this prevents the offset sliding when there's little to no translation speed BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
bOnGround bool When OnGround is true, root motion velicities will be projected onto the ground surface. BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
bResetEveryFrame bool   BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
CollisionTestingMode EOffsetRootBone_CollisionTestingMode   BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=CollisionTesting
  • Meta=(FoldProperty, PinHiddenByDefault)
CollisionTestShapeOffset FVector   BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=CollisionTesting
  • Meta=(EditCondition="CollisionTestingMode != ECollisionTestingMode::Disabled", DisplayAfter="CollisionTestingMode", FoldProperty, PinHiddenByDefault)
CollisionTestShapeRadius float   BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=CollisionTesting
  • Meta=(EditCondition="CollisionTestingMode != ECollisionTestingMode::Disabled", DisplayAfter="CollisionTestingMode", FoldProperty, PinHiddenByDefault)
EvaluationMode EWarpingEvaluationMode   BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Evaluation
  • Meta=(FoldProperty)
GroundNormal FVector Surface normal of the ground. BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
MaxRotationError float How much the offset can deviate from the mesh component's rotation in degrees Values lower than 0 disable this limit BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
MaxTranslationError float How much the offset can deviate from the mesh component's translation in units Values lower than 0 disable this limit BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
RotationDelta FRotator Delta applied to the rotation offset this frame. BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Evaluation
  • Meta=(FoldProperty, PinHiddenByDefault)
RotationHalfLife float Controls how fast the rotation offset is blended out Values closer to 0 make it faster BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
RotationMode EOffsetRootBoneMode The rotation offset behavior mode. BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
RotationSpeedRatio float How much the offset can blend out, relative to the incoming rotation speed i.e. If root motion is rotating at 90 degrees/s, at 0.5, the offset can blend out at 45 degree/s BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition=bClampToRotationVelocity, FoldProperty, PinHiddenByDefault)
Source FPoseLink   BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Links
  • Meta=(DisplayPriority=0)
TranslationDelta FVector Delta applied to the translation offset this frame. BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Evaluation
  • Meta=(FoldProperty, PinHiddenByDefault)
TranslationHalflife float Controls how fast the translation offset is blended out Values closer to 0 make it faster BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
TranslationMode EOffsetRootBoneMode The translation offset behavior mode. BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(FoldProperty, PinHiddenByDefault)
TranslationSpeedRatio float How much the offset can blend out, relative to the incoming translation speed i.e. If root motion is moving at 400cm/s, at 0.5, the offset can blend out at 200cm/s BoneControllers/AnimNode_OffsetRootBone.h
  • EditAnywhere
  • Category=Settings
  • Meta=(EditCondition=bClampToTranslationVelocity, FoldProperty, PinHiddenByDefault)

Protected

Name Type Remarks Include Path Unreal Specifiers
AnimInstanceProxy FAnimInstanceProxy * Internal cached anim instance proxy. BoneControllers/AnimNode_OffsetRootBone.h  
bIsFirstUpdate bool   BoneControllers/AnimNode_OffsetRootBone.h  
CachedDeltaTime float Internal cached delta time used for interpolators. BoneControllers/AnimNode_OffsetRootBone.h  
ComponentTransform FTransform   BoneControllers/AnimNode_OffsetRootBone.h  
LastNonZeroRootMotionDirection FVector   BoneControllers/AnimNode_OffsetRootBone.h  
SimulatedRotation FQuat   BoneControllers/AnimNode_OffsetRootBone.h  
SimulatedTranslation FVector The simulated world-space transforms for the root bone with offset Offset = ComponentTransform - SimulatedTransform BoneControllers/AnimNode_OffsetRootBone.h  
UpdateCounter FGraphTraversalCounter   BoneControllers/AnimNode_OffsetRootBone.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetClampToRotationVelocity()

   BoneControllers/AnimNode_OffsetRootBone.h  

bool GetClampToTranslationVelocity()

   BoneControllers/AnimNode_OffsetRootBone.h  

EOffsetRootBone_CollisionTestingMode GetCollisionTestingMode()

   BoneControllers/AnimNode_OffsetRootBone.h  

const FVector & GetCollisionTestShapeOffset()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetCollisionTestShapeRadius()

   BoneControllers/AnimNode_OffsetRootBone.h  

EWarpingEvaluationMode GetEvaluationMode()

 Folded property accesors. BoneControllers/AnimNode_OffsetRootBone.h  

const FVector & GetGroundNormal()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetMaxRotationError()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetMaxTranslationError()

   BoneControllers/AnimNode_OffsetRootBone.h  

void GetOffsetRootTransform ( FTransform& OutTransform
)

 Get the current simulated root transform BoneControllers/AnimNode_OffsetRootBone.h  

bool GetOnGround()

   BoneControllers/AnimNode_OffsetRootBone.h  

bool GetResetEveryFrame()

   BoneControllers/AnimNode_OffsetRootBone.h  

const FRotator & GetRotationDelta()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetRotationHalfLife()

   BoneControllers/AnimNode_OffsetRootBone.h  

EOffsetRootBoneMode GetRotationMode()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetRotationSpeedRatio()

   BoneControllers/AnimNode_OffsetRootBone.h  

const FVector & GetTranslationDelta()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetTranslationHalflife()

   BoneControllers/AnimNode_OffsetRootBone.h  

EOffsetRootBoneMode GetTranslationMode()

   BoneControllers/AnimNode_OffsetRootBone.h  

float GetTranslationSpeedRatio()

   BoneControllers/AnimNode_OffsetRootBone.h  

Overridden from FAnimNode_Base

Name Remarks Include Path Unreal Specifiers

virtual void CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context
)

   BoneControllers/AnimNode_OffsetRootBone.h  

virtual void Evaluate_AnyThread ( FPoseContext& Output
)

   BoneControllers/AnimNode_OffsetRootBone.h  

virtual void GatherDebugData ( FNodeDebugData& DebugData
)

   BoneControllers/AnimNode_OffsetRootBone.h  

virtual void Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

   BoneControllers/AnimNode_OffsetRootBone.h  

virtual void Update_AnyThread ( const FAnimationUpdateContext& Context
)

   BoneControllers/AnimNode_OffsetRootBone.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page