AnimNode_LookAt.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 "CommonAnimTypes.h"
#include "EngineDefines.h"
#include "AnimNode_LookAt.generated.h"
 
class FPrimitiveDrawInterface;
class USkeletalMeshComponent;
 
UENUM()
namespace EInterpolationBlend
{
    enum Type : int
    {
        Linear,
        Cubic,
        Sinusoidal,
        EaseInOutExponent2,
        EaseInOutExponent3,
        EaseInOutExponent4,
        EaseInOutExponent5,
        MAX
    };
}
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_LookAt : public FAnimNode_SkeletalControlBase
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=SkeletalControl) 
    FBoneReference BoneToModify;
 
    UPROPERTY(EditAnywhere, Category = Target)
    FBoneSocketTarget LookAtTarget;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Target, meta = (PinHiddenByDefault))
    FVector LookAtLocation;
 
    UPROPERTY(EditAnywhere, Category = SkeletalControl)
    FAxis LookAt_Axis;
 
    UPROPERTY(EditAnywhere, Category=SkeletalControl)
    bool bUseLookUpAxis;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=SkeletalControl, meta=(PinHiddenByDefault))
    TEnumAsByte<EInterpolationBlend::Type>  InterpolationType;
 
    UPROPERTY(EditAnywhere, Category = SkeletalControl)
    FAxis LookUp_Axis;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=SkeletalControl, meta=(PinHiddenByDefault))
    float LookAtClamp;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=SkeletalControl, meta=(PinHiddenByDefault))
    float   InterpolationTime;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=SkeletalControl, meta=(PinHiddenByDefault))
    float   InterpolationTriggerThreashold;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FBoneReference LookAtBone_DEPRECATED;
 
    UPROPERTY()
    FName LookAtSocket_DEPRECATED;
 
    UPROPERTY() 
    TEnumAsByte<EAxisOption::Type>  LookAtAxis_DEPRECATED;
 
    UPROPERTY()
    FVector CustomLookAtAxis_DEPRECATED;
 
    UPROPERTY()
    TEnumAsByte<EAxisOption::Type>  LookUpAxis_DEPRECATED;
 
    UPROPERTY()
    FVector CustomLookUpAxis_DEPRECATED;
#endif
 
    // in the future, it would be nice to have more options, -i.e. lag, interpolation speed
    ANIMGRAPHRUNTIME_API FAnimNode_LookAt();
 
    // FAnimNode_Base interface
    ANIMGRAPHRUNTIME_API virtual void GatherDebugData(FNodeDebugData& DebugData) override;
    ANIMGRAPHRUNTIME_API virtual void UpdateInternal(const FAnimationUpdateContext& Context) override;
    ANIMGRAPHRUNTIME_API virtual void Initialize_AnyThread(const FAnimationInitializeContext& Context) override;
    // End of FAnimNode_Base interface
 
    // FAnimNode_SkeletalControlBase interface
    ANIMGRAPHRUNTIME_API virtual void EvaluateComponentSpaceInternal(FComponentSpacePoseContext& Context) override;
    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
 
    FVector GetCachedTargetLocation() const {   return  CachedCurrentTargetLocation;    }
 
#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
 
    static ANIMGRAPHRUNTIME_API float AlphaToBlendType(float InAlpha, EInterpolationBlend::Type BlendType);
 
    FVector CurrentLookAtLocation;
 
    FVector CurrentTargetLocation;
    FVector PreviousTargetLocation;
 
    float AccumulatedInterpoolationTime;
 
 
#if UE_ENABLE_DEBUG_DRAWING
    FTransform CachedOriginalTransform;
    FTransform CachedLookAtTransform;
    FTransform CachedTargetCoordinate;
    FVector CachedPreviousTargetLocation;
    FVector CachedCurrentLookAtLocation;
#endif // UE_ENABLE_DEBUG_DRAWING
    FVector CachedCurrentTargetLocation;
 
protected:
    ANIMGRAPHRUNTIME_API virtual void ModifyPoseFromDeltaRotation(FComponentSpacePoseContext& Output, TArray<FBoneTransform>& OutBoneTransforms,    FTransform& InOutBoneToModifyTransform, const FQuat& DeltaRotation);
};