AnimNode_Fabrik.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 "BoneIndices.h"
#include "BoneContainer.h"
#include "BonePose.h"
#include "BoneControllers/AnimNode_SkeletalControlBase.h"
#include "AnimNode_Fabrik.generated.h"
 
class FPrimitiveDrawInterface;
class USkeletalMeshComponent;
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_Fabrik : public FAnimNode_SkeletalControlBase
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = EndEffector, meta = (PinShownByDefault))
    FTransform EffectorTransform;
 
    UPROPERTY(EditAnywhere, Category = EndEffector)
    FBoneSocketTarget EffectorTarget;
 
    UPROPERTY(EditAnywhere, Category = Solver)
    FBoneReference TipBone;
 
    UPROPERTY(EditAnywhere, Category = Solver)
    FBoneReference RootBone;
 
    UPROPERTY(EditAnywhere, Category = Solver)
    float Precision;
 
    UPROPERTY(EditAnywhere, Category = Solver)
    int32 MaxIterations;
 
    UPROPERTY(EditAnywhere, Category = EndEffector)
    TEnumAsByte<enum EBoneControlSpace> EffectorTransformSpace;
 
    UPROPERTY(EditAnywhere, Category = EndEffector)
    TEnumAsByte<enum EBoneRotationSource> EffectorRotationSource;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category = Solver)
    bool bEnableDebugDraw;
 
    UPROPERTY()
    FBoneReference EffectorTransformBone_DEPRECATED;
#endif
 
public:
    ANIMGRAPHRUNTIME_API FAnimNode_Fabrik();
 
    // FAnimNode_Base interface
    ANIMGRAPHRUNTIME_API virtual void GatherDebugData(FNodeDebugData& DebugData) override;
    ANIMGRAPHRUNTIME_API virtual void Initialize_AnyThread(const FAnimationInitializeContext& Context) 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 virtual void ConditionalDebugDraw(FPrimitiveDrawInterface* PDI, USkeletalMeshComponent* PreviewSkelMeshComp) const;
 
private:
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void InitializeBoneReferences(const FBoneContainer& RequiredBones) override;
    // End of FAnimNode_SkeletalControlBase interface
 
    // Convenience function to get current (pre-translation iteration) component space location of bone by bone index
    FVector GetCurrentLocation(FCSPose<FCompactPose>& MeshBases, const FCompactPoseBoneIndex& BoneIndex);
    static FTransform GetTargetTransform(const FTransform& InComponentTransform, FCSPose<FCompactPose>& MeshBases, FBoneSocketTarget& InTarget, EBoneControlSpace Space, const FTransform& InOffset);
#if WITH_EDITORONLY_DATA
    // Cached CS location when in editor for debug drawing
    FTransform CachedEffectorCSTransform;
#endif
};