AnimNotifyState.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 "UObject/Object.h"
#include "UObject/ScriptMacros.h"
#include "Animation/AnimNotifyQueue.h"
#include "AnimNotifyState.generated.h"
 
class UAnimSequenceBase;
class USkeletalMeshComponent;
struct FAnimNotifyEvent;
struct FBranchingPointNotifyPayload;
#if WITH_EDITORONLY_DATA
class FPrimitiveDrawInterface;
class FCanvas;
class FSceneView;
#endif
 
UCLASS(abstract, editinlinenew, Blueprintable, const, hidecategories=Object, collapsecategories, meta=(ShowWorldContextPin), MinimalAPI)
class UAnimNotifyState : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UFUNCTION(BlueprintNativeEvent)
    ENGINE_API FString GetNotifyName() const;
 
    UFUNCTION(BlueprintImplementableEvent, meta=(AutoCreateRefTerm="EventReference"))
    ENGINE_API bool Received_NotifyBegin(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, float TotalDuration, const FAnimNotifyEventReference& EventReference) const;
    
    UFUNCTION(BlueprintImplementableEvent, meta=(AutoCreateRefTerm="EventReference"))
    ENGINE_API bool Received_NotifyTick(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, float FrameDeltaTime, const FAnimNotifyEventReference& EventReference) const;
 
    UFUNCTION(BlueprintImplementableEvent, meta=(AutoCreateRefTerm="EventReference"))
    ENGINE_API bool Received_NotifyEnd(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, const FAnimNotifyEventReference& EventReference) const;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=AnimNotify)
    FColor NotifyColor;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, AdvancedDisplay, Category=AnimNotify)
    bool bShouldFireInEditor;
#endif // WITH_EDITORONLY_DATA
 
#if WITH_EDITOR
    virtual void OnAnimNotifyCreatedInEditor(FAnimNotifyEvent& ContainingAnimNotifyEvent) {};
    virtual bool CanBePlaced(UAnimSequenceBase* Animation) const { return true; }
    virtual void ValidateAssociatedAssets() {}
    virtual void DrawInEditor(FPrimitiveDrawInterface* PDI, USkeletalMeshComponent* MeshComp, const UAnimSequenceBase* Animation, const FAnimNotifyEvent& NotifyEvent) const {}
    virtual void DrawCanvasInEditor(FCanvas& Canvas, FSceneView& View, USkeletalMeshComponent* MeshComp, const UAnimSequenceBase* Animation, const FAnimNotifyEvent& NotifyEvent) const {}
 
    virtual bool ShouldFireInEditor() { return bShouldFireInEditor; }
#endif
 
    UE_DEPRECATED(5.0, "This function is deprecated. Use the other NotifyBegin instead.")
    ENGINE_API virtual void NotifyBegin(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, float TotalDuration);
    UE_DEPRECATED(5.0, "This function is deprecated. Use the other NotifyTick instead.")
    ENGINE_API virtual void NotifyTick(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, float FrameDeltaTime);
    UE_DEPRECATED(5.0, "This function is deprecated. Use the other NotifyEnd instead.")
    ENGINE_API virtual void NotifyEnd(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation);
 
    ENGINE_API virtual void NotifyBegin(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, float TotalDuration, const FAnimNotifyEventReference& EventReference);
    ENGINE_API virtual void NotifyTick(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, float FrameDeltaTime, const FAnimNotifyEventReference& EventReference);
    ENGINE_API virtual void NotifyEnd(USkeletalMeshComponent * MeshComp, UAnimSequenceBase * Animation, const FAnimNotifyEventReference& EventReference);
    
    ENGINE_API virtual void BranchingPointNotifyBegin(FBranchingPointNotifyPayload& BranchingPointPayload);
    ENGINE_API virtual void BranchingPointNotifyTick(FBranchingPointNotifyPayload& BranchingPointPayload, float FrameDeltaTime);
    ENGINE_API virtual void BranchingPointNotifyEnd(FBranchingPointNotifyPayload& BranchingPointPayload);
 
    // @todo document 
    virtual FString GetEditorComment() 
    { 
        return TEXT(""); 
    }
 
    UFUNCTION(BlueprintNativeEvent)
    ENGINE_API float GetDefaultTriggerWeightThreshold() const;
 
    // @todo document 
    virtual FLinearColor GetEditorColor() 
    { 
#if WITH_EDITORONLY_DATA
        return FLinearColor(NotifyColor); 
#else
        return FLinearColor::Black;
#endif // WITH_EDITORONLY_DATA
    }
 
    ENGINE_API virtual void PostLoad() override;
    ENGINE_API virtual void PreSave(FObjectPreSaveContext ObjectSaveContext) override;
    bool bIsNativeBranchingPoint;
 
protected:
    ENGINE_API UObject* GetContainingAsset() const;
};