AnimSingleNodeInstance.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 "Misc/Optional.h"
#include "Animation/AnimInstance.h"
#include "Animation/AnimTypes.h"
#include "AnimSingleNodeInstance.generated.h"
 
struct FAnimInstanceProxy;
 
DECLARE_DYNAMIC_DELEGATE(FPostEvaluateAnimEvent);
 
UCLASS(transient, NotBlueprintable, MinimalAPI)
class UAnimSingleNodeInstance : public UAnimInstance
{
    GENERATED_UCLASS_BODY()
 
    // Disable compiler-generated deprecation warnings by implementing our own destructor
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    ~UAnimSingleNodeInstance() {}
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UPROPERTY(Transient)
    TObjectPtr<class UAnimationAsset> CurrentAsset;
     
    UPROPERTY(Transient)
    FPostEvaluateAnimEvent PostEvaluateAnimEvent;
 
    //~ Begin UAnimInstance Interface
    ENGINE_API virtual void NativeInitializeAnimation() override;
    ENGINE_API virtual void NativePostEvaluateAnimation() override;
    ENGINE_API virtual void OnMontageInstanceStopped(FAnimMontageInstance& StoppedMontageInstance) override;
 
protected:
    ENGINE_API virtual void Montage_Advance(float DeltaTime) override;
    //~ End UAnimInstance Interface
public:
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetMirrorDataTable(const UMirrorDataTable* MirrorDataTable);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API const UMirrorDataTable* GetMirrorDataTable();
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetLooping(bool bIsLooping);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetPlayRate(float InPlayRate);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetReverse(bool bInReverse);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetPosition(float InPosition, bool bFireNotifies=true);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetPositionWithPreviousTime(float InPosition, float InPreviousTime, bool bFireNotifies=true);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetBlendSpacePosition(const FVector& InPosition);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void SetPlaying(bool bIsPlaying);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API float GetLength();
    /* For AnimSequence specific **/
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void PlayAnim(bool bIsLooping=false, float InPlayRate=1.f, float InStartPosition=0.f);
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API void StopAnim();
    UFUNCTION(BlueprintCallable, Category="Animation")
    ENGINE_API virtual void SetAnimationAsset(UAnimationAsset* NewAsset, bool bIsLooping=true, float InPlayRate=1.f);
    UFUNCTION(BlueprintCallable, Category = "Animation")
    ENGINE_API virtual UAnimationAsset* GetAnimationAsset() const;
    UFUNCTION(BlueprintCallable, Category = "Animation")
    ENGINE_API void SetPreviewCurveOverride(const FName& PoseName, float Value, bool bRemoveIfZero);
 
public:
    ENGINE_API void GetBlendSpaceState(FVector& OutPosition, FVector& OutFilteredPosition) const;
 
    ENGINE_API void StepForward();
    ENGINE_API void StepBackward();
 
    ENGINE_API virtual void RestartMontage(UAnimMontage * Montage, FName FromSection = FName());
    ENGINE_API void SetMontageLoop(UAnimMontage* Montage, bool bIsLooping, FName StartingSection = FName());
 
    ENGINE_API void SetMontagePreviewSlot(FName PreviewSlot);
 
    ENGINE_API void UpdateMontageWeightForTimeSkip(float TimeDifference);
 
    ENGINE_API void UpdateBlendspaceSamples(FVector InBlendInput);
 
    ENGINE_API bool IsPlaying() const;
 
    ENGINE_API bool IsReverse() const;
 
    ENGINE_API bool IsLooping() const;
 
    ENGINE_API float GetCurrentTime() const;
 
    ENGINE_API float GetPlayRate() const;
 
    ENGINE_API UAnimationAsset* GetCurrentAsset();
 
    ENGINE_API FVector GetFilterLastOutput();
 
    ENGINE_API void SetInterpolationOverride(TOptional<EAnimInterpolationType> InterpolationType);
 
    ENGINE_API TOptional<EAnimInterpolationType> GetInterpolationOverride() const;
 
 
protected:
    ENGINE_API virtual FAnimInstanceProxy* CreateAnimInstanceProxy() override;
};