SColorGradingPicker.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"
#include "Widgets/SCompoundWidget.h"
#include "Widgets/Input/SNumericEntryBox.h"
 
UE_DEPRECATED(5.5, "Color grading widgets and associated types have moved to the AdvancedWidgets module.")
DECLARE_DELEGATE_RetVal_OneParam(bool, FOnGetCurrentVector4Value, FVector4&)
 
enum class UE_DEPRECATED(5.5, "Color grading widgets and associated types have moved to the AdvancedWidgets module.") EColorGradingModes
{
    Saturation,
    Contrast,
    Gamma,
    Gain,
    Offset,
    Invalid
};
 
 
class UE_DEPRECATED(5.5, "Color grading widgets and associated types have moved to the AdvancedWidgets module.") SColorGradingPicker
    : public SCompoundWidget
{
public:
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnNumericEntryBoxDynamicSliderMinMaxValueChanged, float, TWeakPtr<SWidget>, bool, bool);
 
    // Delegate called when the widget Color Data changed
    DECLARE_DELEGATE_TwoParams(FOnColorGradingPickerValueChanged, FVector4&, bool);
 
 
    SLATE_BEGIN_ARGS(SColorGradingPicker)
        : _AllowSpin(true)
        , _SupportDynamicSliderMaxValue(false)
        , _SupportDynamicSliderMinValue(false)
        , _MainDelta(0.01f)
        , _MainShiftMultiplier(10.f)
        , _MainCtrlMultiplier(0.1f)
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        , _ColorGradingModes(EColorGradingModes::Saturation)
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
        , _OnColorCommitted()
        , _OnQueryCurrentColor()
    { }
        
        SLATE_ARGUMENT(TOptional<float>, ValueMin )
        SLATE_ARGUMENT(TOptional<float>, ValueMax )
        SLATE_ARGUMENT(TOptional<float>, SliderValueMin)
        SLATE_ARGUMENT(TOptional<float>, SliderValueMax)
        SLATE_ATTRIBUTE(bool, AllowSpin)
 
        
        SLATE_ATTRIBUTE(bool, SupportDynamicSliderMaxValue)
        SLATE_ATTRIBUTE(bool, SupportDynamicSliderMinValue)
 
        SLATE_ARGUMENT( float, MainDelta )
 
        
        SLATE_ARGUMENT(float, MainShiftMultiplier)
        SLATE_ARGUMENT(float, MainCtrlMultiplier)
 
        SLATE_ARGUMENT_DEPRECATED( int32, MainShiftMouseMovePixelPerDelta, 5.4, "Shift Mouse Move Pixel Per Delta is deprecated and incrementing by a fixed delta per pixel is no longer supported. Please use ShiftMultiplier and CtrlMultiplier which will multiply the step per mouse move")
 
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        SLATE_ARGUMENT( EColorGradingModes, ColorGradingModes)
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        SLATE_EVENT(FOnColorGradingPickerValueChanged, OnColorCommitted )
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
        PRAGMA_DISABLE_DEPRECATION_WARNINGS
        SLATE_EVENT(FOnGetCurrentVector4Value, OnQueryCurrentColor)
        PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
        SLATE_EVENT(FSimpleDelegate, OnBeginSliderMovement)
 
        SLATE_EVENT(FSimpleDelegate, OnEndSliderMovement)
 
        SLATE_EVENT(FSimpleDelegate, OnBeginMouseCapture)
 
        SLATE_EVENT(FSimpleDelegate, OnEndMouseCapture)
 
    SLATE_END_ARGS()
 
    APPFRAMEWORK_API ~SColorGradingPicker();
 
public:
 
    APPFRAMEWORK_API void Construct(const FArguments& InArgs );
 
    FOnNumericEntryBoxDynamicSliderMinMaxValueChanged& GetOnNumericEntryBoxDynamicSliderMaxValueChangedDelegate() { return OnNumericEntryBoxDynamicSliderMaxValueChanged; }
    FOnNumericEntryBoxDynamicSliderMinMaxValueChanged& GetOnNumericEntryBoxDynamicSliderMinValueChangedDelegate() { return OnNumericEntryBoxDynamicSliderMinValueChanged; }
 
    APPFRAMEWORK_API void OnDynamicSliderMaxValueChanged(float NewMaxSliderValue, TWeakPtr<SWidget> InValueChangedSourceWidget, bool IsOriginator, bool UpdateOnlyIfHigher);
    APPFRAMEWORK_API void OnDynamicSliderMinValueChanged(float NewMinSliderValue, TWeakPtr<SWidget> InValueChangedSourceWidget, bool IsOriginator, bool UpdateOnlyIfLower);
 
protected:
 
    APPFRAMEWORK_API void TransformLinearColorRangeToColorGradingRange(FVector4 &VectorValue) const;
    APPFRAMEWORK_API void TransformColorGradingRangeToLinearColorRange(FVector4 &VectorValue) const;
    APPFRAMEWORK_API void TransformColorGradingRangeToLinearColorRange(float &FloatValue);
 
    APPFRAMEWORK_API TOptional<float> OnGetMainValue() const;
    APPFRAMEWORK_API void OnMainValueChanged(float InValue, bool ShouldCommitValueChanges);
    APPFRAMEWORK_API void OnMainValueCommitted(float InValue, ETextCommit::Type CommitType);
 
    APPFRAMEWORK_API FLinearColor GetCurrentLinearColor();
 
    APPFRAMEWORK_API bool IsEntryBoxEnabled() const;
 
    // Callback for value changes in the color spectrum picker.
    APPFRAMEWORK_API void HandleCurrentColorValueChanged(const FLinearColor& NewValue, bool ShouldCommitValueChanges);
 
    APPFRAMEWORK_API void HandleColorWheelMouseCaptureBegin(const FLinearColor& InValue);
    APPFRAMEWORK_API void HandleColorWheelMouseCaptureEnd(const FLinearColor& InValue);
 
    APPFRAMEWORK_API void OnBeginSliderMovement();
    APPFRAMEWORK_API void OnEndSliderMovement(float NewValue);
    APPFRAMEWORK_API void AdjustRatioValue(FVector4 &NewValue);
 
    bool bIsMouseDragging;
    FVector4 StartDragRatio;
 
    float SliderValueMin;
    float SliderValueMax;
    float MainDelta;
    float MainShiftMultiplier;
    float MainCtrlMultiplier;
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    EColorGradingModes ColorGradingModes;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    TSharedPtr<SNumericEntryBox<float>> NumericEntryBoxWidget;
 
    FOnColorGradingPickerValueChanged OnColorCommitted;
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FOnGetCurrentVector4Value OnQueryCurrentColor;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
    FOnNumericEntryBoxDynamicSliderMinMaxValueChanged OnNumericEntryBoxDynamicSliderMaxValueChanged;
    FOnNumericEntryBoxDynamicSliderMinMaxValueChanged OnNumericEntryBoxDynamicSliderMinValueChanged;
 
    FSimpleDelegate ExternalBeginSliderMovementDelegate;
    FSimpleDelegate ExternalEndSliderMovementDelegate;
    FSimpleDelegate ExternalBeginMouseCaptureDelegate;
    FSimpleDelegate ExternalEndMouseCaptureDelegate;
};