ComponentDecorator_Animation.h

Go to the documentation of this file.

// Copyright 2025 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "Containers/Ticker.h"
#include "ComponentDecorator_Animation.generated.h"
 
class SWidget;
class UComponentDecorator;
 
UENUM()
enum class EAnimationTriggerMode
{
    //Trigger once when component is pressed
    OnPress,
    
    //Trigger once when component is released
    OnRelease,
    
    //Trigger once when component is initialized
    AtBegin,
    
    //Trigger once before destruction
    //AtEnd,
    
    //It does nothing. It's up to the user to call the function to start, reverse or stop the animation
    OnDemand
};
 
//TODO: Dynamic not needed?
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FTickableObject, const float, DeltaTime);
 
//TODO: Animation modify value of property in decorator object. Then decorator object notify modification to widget

UCLASS(Abstract, Blueprintable, BlueprintType, EditInlineNew, HideCategories=("Default", "Internal", "InternalUse")/*, DefaultToInstanced*/)
class TOUCHINTERFACE_API UComponentDecorator_Animation : public UObject/*, public FTickableGameObject*/
{
    GENERATED_BODY()
 
public:
    UComponentDecorator_Animation();
    
    virtual void Initialize(const TSharedPtr<SWidget> Widget, const TObjectPtr<UComponentDecorator> Decorator);
 
    //virtual class UWorld* GetWorld() const override;
    
protected:
    virtual void BeginDestroy() override;
    
    bool Tick_Internal(const float DeltaTime);
 
public:
    UFUNCTION(Category="Tick", BlueprintCallable)
    virtual void SetTickEnabled(const bool bEnable);
 
    UFUNCTION(Category="Tick", BlueprintCallable, BlueprintNativeEvent)
    void PlayAnimation(const bool bFromStart);
 
    UFUNCTION(Category="Tick", BlueprintCallable, BlueprintNativeEvent)
    void PlayReverseAnimation(const bool bFromEnd);
 
    UFUNCTION(Category="Tick", BlueprintCallable, BlueprintNativeEvent)
    void StopAnimation();
 
protected:
    UFUNCTION(Category="Tick", BlueprintNativeEvent)
    void Tick(const float DeltaSeconds);
    
    //UPROPERTY(Category="Tick", BlueprintAssignable)
    //FTickableObject OnTick;
    
public:
    UPROPERTY(Category="Animation", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    EAnimationTriggerMode StartTriggerMode;
    
    //If enabled, animation is always playing from start except if StartTriggerMode is equal to OnDemand.
    UPROPERTY(Category="Animation", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bPlayFromStart:1;
    
    UPROPERTY(Category="Animation", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    EAnimationTriggerMode EndTriggerMode;
    
    //If enabled, animation is always playing reverse from end except if EndTriggerMode is equal to OnDemand.
    UPROPERTY(Category="Animation", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bReverseFromEnd:1;
    
    //If enabled, stop animation instead of playing reverse
    UPROPERTY(Category="Animation", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bStopAnimation:1;
    
    // If enabled, animation 
    //UPROPERTY(Category="Animation", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    //uint8 bPingPong:1;
    
    //TODO: Send event for start and finish
 
    //TODO: Blueprintable : create custom animation
 
    //TODO: Event that modify color, image properties
    
    //TODO: Use tick or timer?
 
private:
    // Define if this object tick at start or if it should be started manually
    UPROPERTY(Category="Tick", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bStartTickEnabled:1;
 
    // 0.0 means each frame
    UPROPERTY(Category="Tick", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    float TickRate;
 
protected:
    TSharedPtr<SWidget> DecoratorWidget;
 
    TWeakObjectPtr<UComponentDecorator> DecoratorObject;
    
private:
    FTSTicker::FDelegateHandle TickerHandle;
};