SColorGradingWheel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Input/Reply.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SLeafWidget.h"
#include "Framework/SlateDelegates.h"
 
class UMaterial;
 
namespace UE::ColorGrading
{
 
class SColorGradingWheel
    : public SLeafWidget, public FGCObject
{
    SLATE_DECLARE_WIDGET_API(SColorGradingWheel, SLeafWidget, ADVANCEDWIDGETS_API)
 
public:
 
    DECLARE_DELEGATE_OneParam(FOnColorGradingWheelMouseCapture, const FLinearColor&);
    DECLARE_DELEGATE_OneParam(FOnColorGradingWheelValueChanged, const FLinearColor&);
 
    SLATE_BEGIN_ARGS(SColorGradingWheel)
        : _SelectedColor()
        , _DesiredWheelSize()
        , _ExponentDisplacement()
        , _OnMouseCaptureBegin()
        , _OnMouseCaptureEnd()
        , _OnValueChanged()
        { }
 
        SLATE_ATTRIBUTE(FLinearColor, SelectedColor)
 
        SLATE_ATTRIBUTE(int32, DesiredWheelSize)
 
        SLATE_ATTRIBUTE(float, ExponentDisplacement)
 
        
        SLATE_EVENT(FOnColorGradingWheelMouseCapture, OnMouseCaptureBegin)
 
        
        SLATE_EVENT(FOnColorGradingWheelMouseCapture, OnMouseCaptureEnd)
 
        
        SLATE_EVENT(FOnColorGradingWheelValueChanged, OnValueChanged)
 
    SLATE_END_ARGS()
 
public:
    ADVANCEDWIDGETS_API SColorGradingWheel();
 
    ADVANCEDWIDGETS_API void Construct(const FArguments& InArgs);
 
public:
 
    // SWidget overrides
 
    ADVANCEDWIDGETS_API virtual FVector2D ComputeDesiredSize(float) const override;
    ADVANCEDWIDGETS_API virtual FReply OnMouseButtonDoubleClick(const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent) override;
    ADVANCEDWIDGETS_API virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) override;
    ADVANCEDWIDGETS_API virtual FReply OnMouseButtonUp(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) override;
    ADVANCEDWIDGETS_API virtual FReply OnMouseMove(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) override;
    ADVANCEDWIDGETS_API virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
 
protected:
 
    ADVANCEDWIDGETS_API UE::Slate::FDeprecateVector2DResult CalcRelativePositionFromCenter() const;
 
    ADVANCEDWIDGETS_API bool ProcessMouseAction(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bProcessWhenOutsideColorWheel);
 
    ADVANCEDWIDGETS_API void SetSelectedColorAttribute(TAttribute<FLinearColor> InSelectedColor);
 
    ADVANCEDWIDGETS_API void SetDesiredWheelSizeAttribute(TAttribute<int32> InDesiredWheelSize);
 
    ADVANCEDWIDGETS_API void SetExponentDisplacementAttribute(TAttribute<float> InExponentDisplacement);
 
    ADVANCEDWIDGETS_API FVector2f GetActualSize(const FGeometry& MyGeometry) const;
 
    TSlateAttributeRef<FLinearColor> GetSelectedColorAttribute() const { return TSlateAttributeRef<FLinearColor>(SharedThis(this), SelectedColorAttribute); }
 
    TSlateAttributeRef<int32> GetDesiredWheelSizeAttribute() const { return TSlateAttributeRef<int32>(SharedThis(this), DesiredWheelSizeAttribute); }
 
    TSlateAttributeRef<float> GetExponentDisplacementAttribute() const { return TSlateAttributeRef<float>(SharedThis(this), ExponentDisplacementAttribute); }
 
    TObjectPtr<UMaterial> BackgroundMaterial;
 
    TSharedPtr<FSlateBrush> BackgroundImage;
 
    const FSlateBrush* CrossImage;
 
    const FSlateBrush* SelectorImage;
 
    FOnColorGradingWheelMouseCapture OnMouseCaptureBegin;
 
    FOnColorGradingWheelMouseCapture OnMouseCaptureEnd;
 
    FOnColorGradingWheelValueChanged OnValueChanged;
 
private:
 
    //~ Begin FGCObject
    virtual FString GetReferencerName() const override;
    virtual void AddReferencedObjects(FReferenceCollector& InCollector) override;
    //~ End FGCObject
 
    static constexpr float HueAngleOffset = -120.f / 180.f * PI;
 
    TSlateAttribute<FLinearColor> SelectedColorAttribute;
 
    TSlateAttribute<int32> DesiredWheelSizeAttribute;
    TSlateAttribute<float> ExponentDisplacementAttribute;
 
    union
    {
        struct
        {
            uint8 bIsAttributeDesiredWheelSizeSet : 1;
            uint8 bIsAttributeExponentDisplacementSet : 1;
        };
        uint8 Union_IsAttributeSet;
    };
};
 
} //namespace