AnimNode_Constraint.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "BoneControllers/AnimNode_SkeletalControlBase.h"
#include "Constraint.h"
#include "EngineDefines.h"
#include "AnimNode_Constraint.generated.h"
 
UENUM()
enum class EConstraintOffsetOption : uint8
{
    None, // no offset
    Offset_RefPose // offset is based on reference pose
};
 
 
USTRUCT()
struct FConstraint
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = FConstraint)
    FBoneReference TargetBone;
 
    UPROPERTY(EditAnywhere, Category = FConstraint)
    EConstraintOffsetOption OffsetOption;
 
    UPROPERTY(EditAnywhere, Category = FConstraint)
    ETransformConstraintType TransformType;
 
    UPROPERTY(EditAnywhere, Category = FConstraint)
    FFilterOptionPerAxis PerAxis;
    
    int32 ConstraintDataIndex;
 
    void Initialize(const FBoneContainer& RequiredBones)
    {
        TargetBone.Initialize(RequiredBones);
    }
 
    bool IsValidToEvaluate(const FBoneContainer& RequiredBones) const
    {
        return TargetBone.IsValidToEvaluate(RequiredBones) && PerAxis.IsValid();
    }
 
    FConstraint()
        : OffsetOption(EConstraintOffsetOption::Offset_RefPose)
        , TransformType(ETransformConstraintType::Translation)
        , ConstraintDataIndex(INDEX_NONE)
    {}
};
USTRUCT()
struct FAnimNode_Constraint : public FAnimNode_SkeletalControlBase
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = SkeletalControl) 
    FBoneReference BoneToModify;
 
    UPROPERTY(EditAnywhere, Category = Constraints)
    TArray<FConstraint> ConstraintSetup;
 
    UPROPERTY(EditAnywhere, editfixedsize, Category = Runtime, meta = (PinShownByDefault))
    TArray<float> ConstraintWeights;
 
    ANIMGRAPHRUNTIME_API FAnimNode_Constraint();
 
    // FAnimNode_Base interface
    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
 
#if WITH_EDITOR
    ANIMGRAPHRUNTIME_API void ConditionalDebugDraw(FPrimitiveDrawInterface* PDI, USkeletalMeshComponent* MeshComp) const;
#endif // WITH_EDITOR
 
private:
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void InitializeBoneReferences(const FBoneContainer& RequiredBones) override;
    // End of FAnimNode_SkeletalControlBase interface
 
    TArray<FConstraintData> ConstraintData;
 
#if UE_ENABLE_DEBUG_DRAWING
    FTransform CachedOriginalTransform;
    FTransform CachedConstrainedTransform;
    TArray<FTransform> CachedTargetTransforms;
#endif // UE_BUILD_SHIPPING
};