AnimNode_TwoBoneIK.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 "CommonAnimTypes.h"
#include "AnimNode_TwoBoneIK.generated.h"
 
class USkeletalMeshComponent;
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_TwoBoneIK : public FAnimNode_SkeletalControlBase
{
    GENERATED_USTRUCT_BODY()
    
    
    UPROPERTY(EditAnywhere, Category=IK)
    FBoneReference IKBone;
 
    UPROPERTY(EditAnywhere, Category=IK, meta = (editcondition = "bAllowStretching", ClampMin = "0.0", UIMin = "0.0"))
    double StartStretchRatio;
 
    UPROPERTY(EditAnywhere, Category= IK, meta = (editcondition = "bAllowStretching", ClampMin = "0.0", UIMin = "0.0"))
    double MaxStretchScale;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FVector2D StretchLimits_DEPRECATED;
 
    UPROPERTY()
    bool bNoTwist_DEPRECATED;
 
    UPROPERTY()
    FName JointTargetSpaceBoneName_DEPRECATED;
 
    UPROPERTY()
    FName EffectorSpaceBoneName_DEPRECATED;
#endif
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Effector, meta = (PinShownByDefault))
    FVector EffectorLocation;
 
    // cached limb index for upper
    FCompactPoseBoneIndex CachedUpperLimbIndex;
 
    UPROPERTY(EditAnywhere, Category=Effector)
    FBoneSocketTarget EffectorTarget;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=JointTarget, meta=(PinShownByDefault))
    FVector JointTargetLocation;
 
    // cached limb index for lower
    FCompactPoseBoneIndex CachedLowerLimbIndex;
 
    UPROPERTY(EditAnywhere, Category = JointTarget)
    FBoneSocketTarget JointTarget;
 
    UPROPERTY(EditAnywhere, Category = IK, meta = (editcondition = "!bAllowTwist"))
    FAxis TwistAxis;
 
    UPROPERTY(EditAnywhere, Category=Effector)
    TEnumAsByte<enum EBoneControlSpace> EffectorLocationSpace;
 
    UPROPERTY(EditAnywhere, Category=JointTarget)
    TEnumAsByte<enum EBoneControlSpace> JointTargetLocationSpace;
 
    UPROPERTY(EditAnywhere, Category=IK)
    uint8 bAllowStretching:1;
 
    UPROPERTY(EditAnywhere, Category=IK)
    uint8 bTakeRotationFromEffectorSpace : 1;
 
    UPROPERTY(EditAnywhere, Category = IK)
    uint8 bMaintainEffectorRelRot : 1;
 
    UPROPERTY(EditAnywhere, Category = IK)
    uint8 bAllowTwist : 1;
 
    ANIMGRAPHRUNTIME_API FAnimNode_TwoBoneIK();
 
    // 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;
#if WITH_EDITOR
    ANIMGRAPHRUNTIME_API void ConditionalDebugDraw(FPrimitiveDrawInterface* PDI, USkeletalMeshComponent* MeshComp) const;
#endif // WITH_EDITOR
    // End of FAnimNode_SkeletalControlBase interface
    static ANIMGRAPHRUNTIME_API FTransform GetTargetTransform(const FTransform& InComponentTransform, FCSPose<FCompactPose>& MeshBases, FBoneSocketTarget& InTarget, EBoneControlSpace Space, const FVector& InOffset);
private:
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void InitializeBoneReferences(const FBoneContainer& RequiredBones) override;
    // End of FAnimNode_SkeletalControlBase interface
 
#if WITH_EDITOR
    FVector CachedJoints[3];
    FVector CachedJointTargetPos;
#endif // WITH_EDITOR
};