AnimNode_PoseDriver.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 "Animation/AnimNodeBase.h"
#include "AnimNodes/AnimNode_PoseHandler.h"
#include "RBF/RBFSolver.h"
#include "AnimNode_PoseDriver.generated.h"
 
// Deprecated
UENUM()
enum class EPoseDriverType : uint8
{
    SwingAndTwist,
    SwingOnly,
    Translation
};
 
UENUM(BlueprintType)
enum class EPoseDriverSource : uint8
{
    Rotation,
 
    Translation
};
 
UENUM(BlueprintType)
enum class EPoseDriverOutput : uint8
{
    DrivePoses,
 
    DriveCurves
};
 
USTRUCT()
struct FPoseDriverTransform
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    FVector TargetTranslation;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    FRotator TargetRotation;
 
    FPoseDriverTransform()
    : TargetTranslation(FVector::ZeroVector)
    , TargetRotation(FRotator::ZeroRotator)
    {}
};
 
USTRUCT()
struct FPoseDriverTarget
{
    GENERATED_BODY()
        
    
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    TArray<FPoseDriverTransform> BoneTransforms;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    FRotator TargetRotation;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    float TargetScale;
 
    UPROPERTY(EditAnywhere, Category = RBFData)
    ERBFDistanceMethod DistanceMethod;
 
    UPROPERTY(EditAnywhere, Category = RBFData)
    ERBFFunctionType FunctionType;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    bool bApplyCustomCurve;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    FRichCurve CustomCurve;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    FName DrivenName;
 
    int32 PoseCurveIndex;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    bool bIsHidden;
 
    // removing deprecation for default copy operator/constructor to avoid deprecation warnings
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FPoseDriverTarget(const FPoseDriverTarget&) = default;
    FPoseDriverTarget& operator=(const FPoseDriverTarget&) = default;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    FPoseDriverTarget()
        : TargetRotation(ForceInitToZero)
        , TargetScale(1.f)
        , DistanceMethod(ERBFDistanceMethod::DefaultMethod)
        , FunctionType(ERBFFunctionType::DefaultFunction)
        , bApplyCustomCurve(false)
        , DrivenName(NAME_None)
        , PoseCurveIndex(INDEX_NONE)
        , bIsHidden(false)
    {}
};
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_PoseDriver : public FAnimNode_PoseHandler
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, EditFixedSize, BlueprintReadWrite, Category = PoseDriver)
    FPoseLink SourcePose;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    TArray<FBoneReference> SourceBones;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    FBoneReference EvalSpaceBone;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    bool bEvalFromRefPose = false;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver, meta = (EditCondition = "DriveOutput == EPoseDriverOutput::DrivePoses"))
    TArray<FBoneReference> OnlyDriveBones;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    TArray<FPoseDriverTarget> PoseTargets;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver, meta = (ShowOnlyInnerProperties))
    FRBFParams RBFParams;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    EPoseDriverSource DriveSource;
 
    UPROPERTY(EditAnywhere, Category = PoseDriver)
    EPoseDriverOutput DriveOutput;
 
    TArray<FRBFOutputWeight> OutputWeights;
 
    TArray<FTransform> SourceBoneTMs;
    
    bool bHasOnlyDriveBones = false;
 
    TArray<FCompactPoseBoneIndex> BonesToFilter;
 
#if WITH_EDITORONLY_DATA
    // Deprecated
    UPROPERTY()
    FBoneReference SourceBone_DEPRECATED;
    UPROPERTY()
    TEnumAsByte<EBoneAxis> TwistAxis_DEPRECATED;
    UPROPERTY()
    EPoseDriverType Type_DEPRECATED;
    UPROPERTY()
    float RadialScaling_DEPRECATED;
    //
#endif
 
    uint8 bCachedDrivenIDsAreDirty : 1;
 
#if WITH_EDITORONLY_DATA
    int32 SoloTargetIndex;
 
    UPROPERTY()
    bool bSoloDrivenOnly;
#endif
 
    /*
     * Max LOD that this node is allowed to run
     * For example if you have LODThreshold to be 2, it will run until LOD 2 (based on 0 index)
     * when the component LOD becomes 3, it will stop update/evaluate
     * currently transition would be issue and that has to be re-visited
     */
    UPROPERTY(EditAnywhere, Category = Performance, meta = (PinHiddenByDefault, DisplayName = "LOD Threshold"))
    int32 LODThreshold;
 
    // 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 UpdateAssetPlayer(const FAnimationUpdateContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void Evaluate_AnyThread(FPoseContext& Output) override;
    ANIMGRAPHRUNTIME_API virtual void GatherDebugData(FNodeDebugData& DebugData) override;
    virtual int32 GetLODThreshold() const override { return LODThreshold; }
    // End of FAnimNode_Base interface
 
    ANIMGRAPHRUNTIME_API FAnimNode_PoseDriver();
 
    ANIMGRAPHRUNTIME_API float GetRadiusForTarget(const FRBFTarget& Target) const;
 
    ANIMGRAPHRUNTIME_API bool IsBoneDriven(FName BoneName) const;
 
    ANIMGRAPHRUNTIME_API void GetRBFTargets(TArray<FRBFTarget>& OutTargets, const FBoneContainer* BoneContainer) const;
 
    /* Rebuild Pose List*/
    ANIMGRAPHRUNTIME_API virtual void RebuildPoseList(const FBoneContainer& InBoneContainer, const UPoseAsset* InPoseAsset) override;
 
private:
    TSharedPtr<const FRBFSolverData> SolverData;
    FRBFEntry RBFInput;
    TArray<FRBFTarget> RBFTargets;
};