AnimNode_SpringBone.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 "BonePose.h"
#include "BoneControllers/AnimNode_SkeletalControlBase.h"
#include "AnimNode_SpringBone.generated.h"
 
class UAnimInstance;
class USkeletalMeshComponent;
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_SpringBone : public FAnimNode_SkeletalControlBase
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Spring) 
    FBoneReference SpringBone;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Spring, meta=(EditCondition="bLimitDisplacement"))
    double MaxDisplacement;
 
    UPROPERTY(EditAnywhere, Category=Spring, meta = (PinHiddenByDefault))
    double SpringStiffness;
 
    UPROPERTY(EditAnywhere, Category=Spring, meta = (PinHiddenByDefault))
    double SpringDamping;
 
    UPROPERTY(EditAnywhere, Category=Spring)
    double ErrorResetThresh;
 
    FVector BoneLocation;
 
    FVector BoneVelocity;
 
    FVector OwnerVelocity;
 
    FVector LocalBoneTransform;
 
    float RemainingTime;
 
    float FixedTimeStep;
 
    float TimeDilation;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    bool bNoZSpring_DEPRECATED;
#endif
 
    UPROPERTY(EditAnywhere, Category=Spring)
    uint8 bLimitDisplacement : 1;
 
    UPROPERTY(EditAnywhere, Category=FilterChannels)
    uint8 bTranslateX : 1;
 
    UPROPERTY(EditAnywhere, Category=FilterChannels)
    uint8 bTranslateY : 1;
 
    UPROPERTY(EditAnywhere, Category=FilterChannels)
    uint8 bTranslateZ : 1;
 
    UPROPERTY(EditAnywhere, Category=FilterChannels)
    uint8 bRotateX : 1;
 
    UPROPERTY(EditAnywhere, Category=FilterChannels)
    uint8 bRotateY : 1;
 
    UPROPERTY(EditAnywhere, Category=FilterChannels)
    uint8 bRotateZ : 1;
 
    uint8 bHadValidStrength : 1;
 
    UPROPERTY(EditAnywhere, Category = OwnerVelocity, Meta = (PinHiddenByDefault))
    uint8 bOverrideOwnerVelocity : 1;
 
    UPROPERTY(EditAnywhere, Category = OwnerVelocity, Meta = (EditCondition = "bOverrideOwnerVelocity", PinHiddenByDefault))
    FVector OwnerVelocityOverride;
 
public:
    ANIMGRAPHRUNTIME_API FAnimNode_SpringBone();
 
    // FAnimNode_Base interface
    ANIMGRAPHRUNTIME_API virtual void Initialize_AnyThread(const FAnimationInitializeContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void CacheBones_AnyThread(const FAnimationCacheBonesContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void UpdateInternal(const FAnimationUpdateContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void GatherDebugData(FNodeDebugData& DebugData) override;
    virtual bool HasPreUpdate() const override { return true; }
    ANIMGRAPHRUNTIME_API virtual void PreUpdate(const UAnimInstance* InAnimInstance) 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
 
private:
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void InitializeBoneReferences(const FBoneContainer& RequiredBones) override;
    // End of FAnimNode_SkeletalControlBase interface
};