ComponentDecorator.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "Rendering/DrawElements.h"
#include "Styling/WidgetStyle.h"
#include "Styling/SlateBrush.h"
#include "Widgets/SNullWidget.h"
#include "Types/SlateEnums.h"
#include "ComponentDecorator.generated.h"
 
class UComponentDecoratorGroup;
class ULayoutComponent;
class UComponentDecorator_Animation;
 
UENUM(BlueprintType)
enum class EDrawType : uint8
{
    //Draw only when component is pressed
    Pressed,
 
    //Draw only when component is not pressed
    Released,
 
    //Always draw
    Both
};
 
//TODO: Make widget for all layer. Keep a reference to generated widget to allow modification. In editor, widget is reconstructed each time?
 
//Simple image decorator
UCLASS(BlueprintType)
class TOUCHINTERFACE_API UComponentDecorator : public UObject
{
    GENERATED_BODY()
 
public:
    UComponentDecorator();
 
    virtual void BeginDestroy() override;
 
    virtual void Initialize(TObjectPtr<ULayoutComponent> Component);
 
#if WITH_EDITOR
    virtual void EditorInitialize() {}
    virtual FName GetStyleSetName() { return FName(""); }
    virtual TSharedRef<SWidget> GetEditorWidget();
    virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
 
    virtual void SynchronizeProperties();
#endif
 
    virtual bool CanAcceptChildren() { return false; }
 
    bool IsInGroup() const;
 
    //TODO: Bool to false by default
    TSharedRef<SWidget> GetWidget(const bool bForceReconstruct = true);

    virtual TSharedRef<SWidget> CreateWidgetInstance();

    //virtual TSharedRef<SWidget> GetWidget(EHorizontalAlignment& HAlign, EVerticalAlignment& VAlign);
 
    const TObjectPtr<ULayoutComponent>& GetOwner() const { return Owner; }
 
    TObjectPtr<UComponentDecoratorGroup> GetGroup() const;
    
    //Can be decorator group or layout component
    bool EjectFromParent();
 
    // Returns the size of decorator in percent
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    FVector2D GetSize() const { return Size; }
 
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    FVector2D GetAbsoluteSize() const;
    
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    virtual float GetMaxHorizontalSize(bool bRecursive = false) const;
    
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    virtual float GetMaxVerticalSize(bool bRecursive = false) const;
    
    // Returns offset value from geometry center
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    FVector2D GetOffset() const { return  Offset; }
 
    // Returns rotation value
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    float GetRotation() const { return Rotation; }
 
    // Returns slate brush used by this decorator. Warning! Can be null
    UFUNCTION(Category="Decorator", BlueprintCallable, BlueprintPure)
    FSlateBrush GetBrush() const { return Brush; }
    
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetBrushResource(UObject* Resource);
 
    // Set the slate brush used by this decorator
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetBrush(const FSlateBrush InBrush);
 
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetBrushOpacity(const float Value);
 
    // Set the size of decorator
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetSize(const FVector2D Value);
 
    // Set the new offset value of decorator (offset from component geometry center)
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetOffset(FVector2D NewOffset);
 
    // Set the new rotation value of decorator
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetRotation(float Angle);
 
    // Set the new draw type of this decorator
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void SetDrawType(const EDrawType NewType);
 
    // Add delta to current rotation of decorator. Returns new rotation value.
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual float AddRotationDelta(float Delta);

    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual UMaterialInstanceDynamic* GetDynamicMaterialInstance();
 
    // Display decorator
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void ShowDecorator();
 
    // Hide decorator
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual void HideDecorator();
 
    // Returns true if decorator is visible
    UFUNCTION(Category="Decorator", BlueprintCallable)
    virtual bool IsVisible() const;
    
protected:
    virtual void HandleOnPressEvent(const FGeometry& ComponentGeometry, const FGeometry& LayoutGeometry, const FPointerEvent& PointerEvent);
    virtual void HandleOnReleaseEvent(const FGeometry& ComponentGeometry, const FGeometry& LayoutGeometry, const FPointerEvent& PointerEvent);
    
 
private:
    void UpdateRenderTransform() const;
    
 
public:
    // Is enabled, this decorator appear hidden at startup
    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly)
    uint8 bStartHidden:1;
    
    //Resource object (texture, material, render target, etc)
    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly)
    FSlateBrush Brush;

    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f))
    FVector2D Size;
 
    //Offset from component geometry center
    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly)
    FVector2D Offset;
 
    //Rotation value of this decorator
    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly)
    float Rotation;
 
    //Select when decorator is drawn
    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly)
    EDrawType DrawType;

    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly)
    int32 ZOrder;
 
    
    UPROPERTY(Category="Decorator|Widget", EditAnywhere, BlueprintReadOnly)
    TEnumAsByte<EHorizontalAlignment> HorizontalAlignment;
    
    UPROPERTY(Category="Decorator|Widget", EditAnywhere, BlueprintReadOnly)
    TEnumAsByte<EVerticalAlignment> VerticalAlignment;
    
    
    UPROPERTY(Category="Decorator", EditAnywhere, BlueprintReadOnly, Instanced)
    TArray<TObjectPtr<UComponentDecorator_Animation>> Animations;
 
protected:
    uint8 bIsVisible:1;
 
    //This decorator cannot be modified, as it has been generated by the logic of the layout component, which is responsible for defining its appearance.
    uint8 bGeneratedByLayoutComponentLogic:1;
 
    UPROPERTY()
    TObjectPtr<ULayoutComponent> Owner;
 
    TSharedPtr<SWidget> DecoratorWidget;
    
private:
    friend class FTouchInterfaceLayoutEditor;
    friend class FTouchInterfaceDesignerEditorMenuExtender;
};