AnimNode_Trail.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "BoneContainer.h"
#include "Curves/CurveFloat.h"
#include "BonePose.h"
#include "BoneControllers/AnimNode_SkeletalControlBase.h"
#include "BoneControllers/AnimNode_AnimDynamics.h"
#include "AnimNode_Trail.generated.h"
 
class USkeletalMeshComponent;
 
// in the future, we might use this for stretch set up as well
// for now this is unserializable, and transient only
struct FPerJointTrailSetup
{
    float   TrailRelaxationSpeedPerSecond;
};
 
USTRUCT()
struct FRotationLimit
{
    GENERATED_BODY()
 
    FRotationLimit()
        : LimitMin(-180, -180, -180)
        , LimitMax(+180, +180, +180)
    {}
 
    UPROPERTY(EditAnywhere, Category = Angular, meta = (UIMin = "-180", UIMax = "180", ClampMin = "-180", ClampMax = "180"))
    FVector LimitMin;
 
    UPROPERTY(EditAnywhere, Category = Angular, meta = (UIMin = "-180", UIMax = "180", ClampMin = "-180", ClampMax = "180"))
    FVector LimitMax;
};
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_Trail : public FAnimNode_SkeletalControlBase
{
    GENERATED_USTRUCT_BODY()
 
    
    FTransform      OldBaseTransform;
 
    UPROPERTY(EditAnywhere, Category=Trail)
    FBoneReference TrailBone;
 
    UPROPERTY(EditAnywhere, Category = Trail, meta = (ClampMin = "2", UIMin = "2"))
    int32   ChainLength;
 
    UPROPERTY(EditAnywhere, Category=Trail)
    TEnumAsByte<EAxis::Type>    ChainBoneAxis;
 
    UPROPERTY(EditAnywhere, Category=Trail)
    uint8 bInvertChainBoneAxis:1;
 
    UPROPERTY(EditAnywhere, Category=Limit)
    uint8 bLimitStretch:1;
 
    UPROPERTY(EditAnywhere, Category = Limit)
    uint8 bLimitRotation:1;
 
    UPROPERTY(EditAnywhere, Category=Limit)
    uint8 bUsePlanarLimit:1;
 
    UPROPERTY(EditAnywhere,  Category=Velocity)
    uint8 bActorSpaceFakeVel:1;
 
    UPROPERTY(EditAnywhere, Category = Rotation)
    uint8 bReorientParentToChild:1;
 
    uint8 bHadValidStrength:1;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category = Debug)
    uint8 bEnableDebug:1;
 
    UPROPERTY(EditAnywhere, Category = Debug)
    uint8 bShowBaseMotion:1;
 
    UPROPERTY(EditAnywhere, Category = Debug)
    uint8 bShowTrailLocation:1;
 
    UPROPERTY(EditAnywhere, Category = Debug)
    uint8 bShowLimit:1;
 
    uint8 bEditorDebugEnabled:1;
 
    UPROPERTY(EditAnywhere, Category = Debug)
    float DebugLifeTime;
 
    UPROPERTY()
    float TrailRelaxation_DEPRECATED;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Category = Limit)
    float MaxDeltaTime;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Trail, meta = (PinHiddenByDefault))
    float RelaxationSpeedScale;
 
    UPROPERTY(EditAnywhere, Category=Trail, meta=(CustomizeProperty))
    FRuntimeFloatCurve TrailRelaxationSpeed;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Trail)
    FInputScaleBiasClamp RelaxationSpeedScaleInputProcessor;
 
    UPROPERTY(EditAnywhere, EditFixedSize, Category = Limit, meta = (EditCondition =bLimitRotation))
    TArray<FRotationLimit> RotationLimits;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, EditFixedSize, Category = Limit, meta = (PinHiddenByDefault, EditCondition = bLimitRotation))
    TArray<FVector> RotationOffsets;
 
    UPROPERTY(EditAnywhere, Category=Limit, meta = (EditCondition = bUsePlanarLimit))
    TArray<FAnimPhysPlanarLimit> PlanarLimits;
 
    UPROPERTY(EditAnywhere, Category=Limit)
    float   StretchLimit;
 
    UPROPERTY(EditAnywhere, Category=Velocity, meta = (PinHiddenByDefault))
    FVector FakeVelocity;
 
    UPROPERTY(EditAnywhere, Category=Velocity)
    FBoneReference BaseJoint;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    float TrailBoneRotationBlendAlpha_DEPRECATED;
#endif // WITH_EDITORONLY_DATA
    /* How to set last bone rotation. It copies from previous joint if alpha is 0.f, or 1.f will use animated pose 
     * This alpha dictates the blend between parent joint and animated pose, and how much you'd like to use animated pose for
     */
    UPROPERTY(EditAnywhere, Category = Rotation, meta = (EditCondition = bReorientParentToChild))
    float LastBoneRotationAnimAlphaBlend;
 
    float   ThisTimstep;
 
    TArray<FVector> TrailBoneLocations;
 
    TArray<FPerJointTrailSetup> PerJointTrailData;
 
#if WITH_EDITORONLY_DATA
    TArray<FColor>  TrailDebugColors;
    TArray<FColor>  PlaneDebugColors;
#endif // WITH_EDITORONLY_DATA
 
    ANIMGRAPHRUNTIME_API FAnimNode_Trail();
 
    // FAnimNode_Base interface
    ANIMGRAPHRUNTIME_API virtual void Initialize_AnyThread(const FAnimationInitializeContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void UpdateInternal(const FAnimationUpdateContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void GatherDebugData(FNodeDebugData& DebugData) override;
    // End of FAnimNode_Base interface
 
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void EvaluateSkeletalControl_AnyThread(FComponentSpacePoseContext& Output, TArray<FBoneTransform>& OutBoneTransforms) override;
    ANIMGRAPHRUNTIME_API virtual bool IsValidToEvaluate(const USkeleton* Skeleton, const FBoneContainer& RequiredBones) override;
    // End of FAnimNode_SkeletalControlBase interface
 
    ANIMGRAPHRUNTIME_API void PostLoad();
 
#if WITH_EDITOR
    ANIMGRAPHRUNTIME_API void EnsureChainSize();
#endif // WITH_EDITOR
private:
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void InitializeBoneReferences(const FBoneContainer& RequiredBones) override;
    // End of FAnimNode_SkeletalControlBase interface
 
    FVector GetAlignVector(EAxis::Type AxisOption, bool bInvert);
 
    // skeleton index
    TArray<int32> ChainBoneIndices;
};