1. Epic GamesDeveloper
  3. FAnimNode_Trail

FAnimNode_Trail

Trail Controller

API > API/Runtime > API/Runtime/AnimGraphRuntime > API/Runtime/AnimGraphRuntime/BoneControllers

Inheritance Hierarchy

References

   
Module AnimGraphRuntime
Header /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_Trail.h
Include #include "BoneControllers/AnimNode_Trail.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_Trail : public FAnimNode_SkeletalControlBase

Remarks

Trail Controller

Variables

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Virtual void

GatherDebugData ( FNodeDebugData& DebugData
)

  
Public function void  

Overridden from FAnimNode_SkeletalControlBase

  Type Name Description
Public function Virtual void

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

 Evaluate the new component-space transforms for the affected bones.
Public function Virtual void

Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

  
Public function Virtual bool

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

 Return true if it is valid to Evaluate
Public function Virtual void

UpdateInternal ( const FAnimationUpdateContext& Context
)

 Interface for derived skeletal controls to implement use this function to update for skeletal control base

Deprecated Variables

  Type Name Description
Public variable UProperty float TrailBoneRotationBlendAlpha_DEPRECATED  
Public variable UProperty float TrailRelaxation_DEPRECATED How quickly we 'relax' the bones to their animated positions.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page