FlipbookLayer.h

Go to the documentation of this file.

// Copyright 2025 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "ComponentDecorator.h"
#include "Engine/Texture2DArray.h"
#include "FlipbookLayer.generated.h"
 
class SFlipbookLayer;
class UMaterialInterface;
class UMaterialInstanceDynamic;
 
UCLASS()
class TOUCHINTERFACE_API UFlipbookLayer : public UComponentDecorator
{
    GENERATED_BODY()
 
public:
    UFlipbookLayer();
 
    virtual TSharedRef<SWidget> CreateWidgetInstance() override;
 
    virtual void BeginDestroy() override;
    
    virtual void Initialize(TObjectPtr<ULayoutComponent> Component) override;
 
#if WITH_EDITOR
    virtual void EditorInitialize() override;
#endif
 
#if WITH_EDITOR
    virtual void PostLoad() override;
    
    virtual void SynchronizeProperties() override;
#endif
 
    //GETTERS
    
    // Returns the current value of animation phase
    UFUNCTION(Category="Flipbook", BlueprintCallable, BlueprintPure)
    virtual float GetAnimationPhase() const { return AnimationPhase; }
 
    // Returns the current value of flipbook opacity
    UFUNCTION(Category="Flipbook", BlueprintCallable, BlueprintPure)
    virtual float GetFlipbookOpacity() const;
 
    //SETTERS
    
    virtual void SetBrush(const FSlateBrush InBrush) override;
    
    // Set the current value of animation phase
    UFUNCTION(Category="Flipbook", BlueprintCallable)
    virtual void SetAnimationPhase(const float Value);
    
    // Set the current value of opacity
    UFUNCTION(Category="Flipbook", BlueprintCallable)
    virtual void SetFlipbookOpacity(const float InOpacity);
 
    UFUNCTION(Category="Flipbook", BlueprintCallable)
    virtual void SetFlipbookTexture(UTexture2D* InTexture);
 
    UFUNCTION(Category="Flipbook", BlueprintCallable)
    virtual void SetGridSize(const FVector2D Value);
 
    UFUNCTION(Category="Flipbook", BlueprintCallable)
    virtual void SetFlipbookSpeed(const float Value);
 
    UFUNCTION(Category="Flipbook", BlueprintCallable)
    virtual void SetAutoAnimation(const bool bEnable);
 
public:
    // Use texture array for flipbook
    UPROPERTY(Category="Flipbook Layer", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bUseTextureArray:1;
    
    UPROPERTY(Category="Flipbook Layer", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="bUseTextureArray", EditConditionHides))
    UTexture2DArray* FlipbookArray;
    
    // Grid parameter for flipbook texture
    UPROPERTY(Category="Flipbook Layer", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    FVector2D Grid;
 
    // Speed of flipbook animation (1 means 1 per seconds, 60 means 60 per seconds)
    UPROPERTY(Category="Flipbook Layer", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    float Speed;
 
    // Animation progress. Should be between 0 to 1.
    UPROPERTY(Category="Flipbook Layer", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(ClampMin=0.0f, ClampMax=1.0f))
    float AnimationPhase;
 
    // Auto animate flipbook
    UPROPERTY(Category="Flipbook Layer", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bAutoAnimate:1;
 
private:
    int32 MaxIndex;
 
    TSharedPtr<SFlipbookLayer> FlipbookWidget;
};