1. Epic GamesDeveloper
  3. FAnimNode_Trail

FAnimNode_Trail

Trail Controller

API > API/Runtime > API/Runtime/AnimGraphRuntime

Trail Controller

   
Name FAnimNode_Trail
Type struct
Header File /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_Trail.h
Include Path #include "BoneControllers/AnimNode_Trail.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_Trail : public FAnimNode_SkeletalControlBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAnimNode_Trail()

   BoneControllers/AnimNode_Trail.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bActorSpaceFakeVel uint8 Whether 'fake' velocity should be applied in actor or world space. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Velocity
BaseJoint FBoneReference Base Joint to calculate velocity from. If none, it will use Component's World Transform. . BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Velocity
bEditorDebugEnabled uint8 This is used by selection node. Use this transient flag. BoneControllers/AnimNode_Trail.h  
bEnableDebug uint8 Enable Debug in the PIE. This doesn't work in game BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Debug
bHadValidStrength uint8 Did we have a non-zero ControlStrength last frame. BoneControllers/AnimNode_Trail.h  
bInvertChainBoneAxis uint8 Invert the direction specified in ChainBoneAxis. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Trail
bLimitRotation uint8 Limit the amount that a bone can stretch from its ref-pose length. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Limit
bLimitStretch uint8 Limit the amount that a bone can stretch from its ref-pose length. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Limit
bReorientParentToChild uint8 Fix up rotation to face child for the parent BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Rotation
bShowBaseMotion uint8 Show Base Motion BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Debug
bShowLimit uint8 Show Planar Limits BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Debug
bShowTrailLocation uint8 Show Trail Location BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Debug
bUsePlanarLimit uint8 Whether to evaluate planar limits BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Limit
ChainBoneAxis TEnumAsByte< EAxis::Type > Axis of the bones to point along trail. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Trail
ChainLength int32 Number of bones above the active one in the hierarchy to modify. ChainLength should be at least 2. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Trail
  • Meta=(ClampMin="2", UIMin="2")
DebugLifeTime float Debug Life Time BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Debug
FakeVelocity FVector 'Fake' velocity applied to bones. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Velocity
  • Meta=(PinHiddenByDefault)
LastBoneRotationAnimAlphaBlend float How to set last bone rotation. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Rotation
  • Meta=(EditCondition=bReorientParentToChild)
MaxDeltaTime float To avoid hitches causing stretch of trail, you can use MaxDeltaTime to clamp the long delta time. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Limit
OldBaseTransform FTransform LocalToWorld used last frame, used for building transform between frames. BoneControllers/AnimNode_Trail.h  
PerJointTrailData TArray< FPerJointTrailSetup > Per Joint Trail Set up BoneControllers/AnimNode_Trail.h  
PlanarLimits TArray< FAnimPhysPlanarLimit > List of available planar limits for this node BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Limit
  • Meta=(EditCondition=bUsePlanarLimit)
PlaneDebugColors TArray< FColor >   BoneControllers/AnimNode_Trail.h  
RelaxationSpeedScale float   BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Trail
  • Meta=(PinHiddenByDefault)
RelaxationSpeedScaleInputProcessor FInputScaleBiasClamp   BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Trail
RotationLimits TArray< FRotationLimit >   BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • EditFixedSize
  • Category=Limit
  • Meta=(EditCondition=bLimitRotation)
RotationOffsets TArray< FVector >   BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • BlueprintReadWrite
  • EditFixedSize
  • Category=Limit
  • Meta=(PinHiddenByDefault, EditCondition=bLimitRotation)
StretchLimit float If bLimitStretch is true, this indicates how long a bone can stretch beyond its length in the ref-pose. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Limit
ThisTimstep float Internal use - we need the timestep to do the relaxation in CalculateNewBoneTransforms. BoneControllers/AnimNode_Trail.h  
TrailBone FBoneReference Reference to the active bone in the hierarchy to modify. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Trail
TrailBoneLocations TArray< FVector > Component-space locations of the bones from last frame. BoneControllers/AnimNode_Trail.h  
TrailDebugColors TArray< FColor > Debug transient data to draw debug better BoneControllers/AnimNode_Trail.h  
TrailRelaxationSpeed FRuntimeFloatCurve How quickly we 'relax' the bones to their animated positions. BoneControllers/AnimNode_Trail.h
  • EditAnywhere
  • Category=Trail
  • Meta=(CustomizeProperty)

Protected

Name Type Remarks Include Path Unreal Specifiers
ChainBoneIndices TArray< int32 > Skeleton index BoneControllers/AnimNode_Trail.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void EnsureChainSize()

   BoneControllers/AnimNode_Trail.h  

void PostLoad()

   BoneControllers/AnimNode_Trail.h  

Overridden from FAnimNode_SkeletalControlBase

Name Remarks Include Path Unreal Specifiers

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

 Evaluate the new component-space transforms for the affected bones. BoneControllers/AnimNode_Trail.h  

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

 Return true if it is valid to Evaluate BoneControllers/AnimNode_Trail.h  

virtual void UpdateInternal ( const FAnimationUpdateContext& Context
)

 Interface for derived skeletal controls to implement use this function to update for skeletal control base BoneControllers/AnimNode_Trail.h  

Overridden from FAnimNode_Base

Name Remarks Include Path Unreal Specifiers

virtual void GatherDebugData ( FNodeDebugData& DebugData
)

   BoneControllers/AnimNode_Trail.h  

virtual void Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

   BoneControllers/AnimNode_Trail.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
TrailBoneRotationBlendAlpha_DEPRECATED float   BoneControllers/AnimNode_Trail.h  
TrailRelaxation_DEPRECATED float How quickly we 'relax' the bones to their animated positions. BoneControllers/AnimNode_Trail.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page