SColorPicker.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 "Layout/Visibility.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/SWidget.h"
#include "Widgets/SCompoundWidget.h"
#include "Widgets/SWindow.h"
#include "Framework/SlateDelegates.h"
 
class FColorTheme;
class SBorder;
class SColorThemesViewer;
class SComboButton;
class SThemeColorBlocksBar;
enum class EColorBlockAlphaDisplayMode : uint8;
class SColorWheel;
 
DECLARE_DELEGATE_OneParam(FOnColorPickerCancelled, FLinearColor);
 
 
enum class EColorPickerChannels
{
    Red,
    Green,
    Blue,
    Alpha,
    Hue,
    Saturation,
    Value
};
 
 
enum class EColorPickerModes
{
    Spectrum,
    Wheel
};
 
 
enum class EColorPickerHexMode
{
    SRGB,
    Linear
};
 
 
struct FColorChannels
{
    FColorChannels()
    {
        Red = Green = Blue = Alpha = nullptr;
    }
 
    float* Red;
    float* Green;
    float* Blue;
    float* Alpha;
};
 
class SColorPicker
    : public SCompoundWidget
{
public:
 
    SLATE_BEGIN_ARGS(SColorPicker)
        : _TargetColorAttribute(FLinearColor(ForceInit))
        , _ColorWheelBrush(FCoreStyle::Get().GetBrush("ColorWheel.HueValueCircle"))
        , _UseAlpha(true)
        , _OnlyRefreshOnMouseUp(false)
        , _OnlyRefreshOnOk(false)
        , _OnColorCommitted()
        , _PreColorCommitted()
        , _OnColorPickerCancelled()
        , _OnColorPickerWindowClosed()
        , _OnInteractivePickBegin()
        , _OnInteractivePickEnd()
        , _ParentWindow()
        , _DisplayGamma(2.2f)
        , _sRGBOverride()
        , _DisplayInlineVersion(false)
        , _OverrideColorPickerCreation(false)
        , _ExpandAdvancedSection(false)
        , _ClampValue(false)
        , _OptionalOwningDetailsView(nullptr)
    { }
 
        SLATE_ATTRIBUTE(FLinearColor, TargetColorAttribute)
 
        
        SLATE_ATTRIBUTE(const FSlateBrush*, ColorWheelBrush)
 
        
        SLATE_ARGUMENT_DEPRECATED(TArray<FColor*>, TargetFColors, 5.2, "TargetFColors is deprecated. Use OnColorCommitted to get the selected color.")
        
        
        SLATE_ARGUMENT_DEPRECATED(TArray<FLinearColor*>, TargetLinearColors, 5.2, "TargetLinearColors is deprecated. Use OnColorCommitted to get the selected color.")
 
        SLATE_ARGUMENT_DEPRECATED(TArray<FColorChannels>, TargetColorChannels, 5.2, "TargetColorChannels is deprecated. Use OnColorCommitted to get the selected color.")
 
        SLATE_ATTRIBUTE(bool, UseAlpha)
 
        SLATE_ATTRIBUTE(bool, OnlyRefreshOnMouseUp)
 
        SLATE_ATTRIBUTE(bool, OnlyRefreshOnOk)
 
        SLATE_EVENT(FOnLinearColorValueChanged, OnColorCommitted)
 
        UE_DEPRECATED(5.2, "PreColorCommitted is deprecated. Use OnColorCommitted to update your values.")
        SLATE_EVENT(FOnLinearColorValueChanged, PreColorCommitted)
 
        SLATE_EVENT(FOnColorPickerCancelled, OnColorPickerCancelled)
 
        SLATE_EVENT(FOnWindowClosed, OnColorPickerWindowClosed)
 
        SLATE_EVENT(FSimpleDelegate, OnInteractivePickBegin)
 
        SLATE_EVENT(FSimpleDelegate, OnInteractivePickEnd)
 
        SLATE_ATTRIBUTE(TSharedPtr<SWindow>, ParentWindow)
 
        SLATE_ATTRIBUTE(float, DisplayGamma)
 
        SLATE_ARGUMENT(TOptional<bool>, sRGBOverride)
 
        SLATE_ARGUMENT(bool, DisplayInlineVersion)
 
        SLATE_ARGUMENT(bool, OverrideColorPickerCreation)
 
        SLATE_ARGUMENT(bool, ExpandAdvancedSection)
 
        SLATE_ARGUMENT(bool, ClampValue)
 
        SLATE_ATTRIBUTE(TSharedPtr<SWidget>, OptionalOwningDetailsView)
 
    SLATE_END_ARGS()
    
    static APPFRAMEWORK_API const FVector2D DEFAULT_WINDOW_SIZE;
 
    APPFRAMEWORK_API ~SColorPicker();
 
public:
 
    APPFRAMEWORK_API void Construct(const FArguments& InArgs);
 
    TSharedPtr<SWidget> GetOptionalOwningDetailsView()
    {
        if (OptionalOwningDetailsView.IsValid())
        {
            return OptionalOwningDetailsView.Pin();
        }
        else
        {
            return nullptr;
        }
    }
 
    DECLARE_DELEGATE_OneParam(FOnColorPickerCreationOverride, const TSharedRef<SColorPicker>&);
    static APPFRAMEWORK_API FOnColorPickerCreationOverride OnColorPickerNonModalCreateOverride;
 
    DECLARE_DELEGATE(FOnColorPickerDestructionOverride);
    static APPFRAMEWORK_API FOnColorPickerDestructionOverride OnColorPickerDestroyOverride;
 
protected:
 
    APPFRAMEWORK_API void BackupColors();
 
    APPFRAMEWORK_API bool ApplyNewTargetColor(bool bForceUpdate = false);
 
    APPFRAMEWORK_API void GenerateDefaultColorPickerContent(bool bAdvancedSectionExpanded);
    APPFRAMEWORK_API void GenerateInlineColorPickerContent();
 
    FLinearColor GetCurrentColor() const
    {
        return CurrentColorHSV;
    }
 
    APPFRAMEWORK_API void DiscardColor();
 
    APPFRAMEWORK_API bool SetNewTargetColorRGB(const FLinearColor& NewValue, bool bForceUpdate = false);
    APPFRAMEWORK_API bool SetNewTargetColorHSV(const FLinearColor& NewValue, bool bForceUpdate = false);
 
    APPFRAMEWORK_API void UpdateColorPick();
    APPFRAMEWORK_API void UpdateColorPickMouseUp();
 
    APPFRAMEWORK_API void BeginAnimation(FLinearColor Start, FLinearColor End);
 
    UE_DEPRECATED(5.6, "HideSmallTrash is deprecated. The delete button for theme colors is managed by the SThemeColorBlocksBar widget.")
    APPFRAMEWORK_API void HideSmallTrash();
 
    UE_DEPRECATED(5.6, "ShowSmallTrash is deprecated. The delete button for theme colors is managed by the SThemeColorBlocksBar widget.")
    APPFRAMEWORK_API void ShowSmallTrash();
 
    APPFRAMEWORK_API void CycleMode();
 
    APPFRAMEWORK_API TSharedRef<SWidget> MakeColorSlider(EColorPickerChannels Channel) const;
 
    APPFRAMEWORK_API TSharedRef<SWidget> MakeColorSpinBox(EColorPickerChannels Channel) const;
 
    APPFRAMEWORK_API TSharedRef<SWidget> MakeColorPreviewBox() const;
 
private:
 
    // Callback for the active timer to animate the color post-construct
    APPFRAMEWORK_API EActiveTimerReturnType AnimatePostConstruct(double InCurrentTime, float InDeltaTime);
 
    // Callback for getting the end color of a color spin box gradient.
    APPFRAMEWORK_API FLinearColor GetGradientEndColor(EColorPickerChannels Channel) const;
 
    // Callback for getting the start color of a color spin box gradient.
    APPFRAMEWORK_API FLinearColor GetGradientStartColor(EColorPickerChannels Channel) const;
 
    // Callback for getting the array of colors for a color spin box gradient.
    APPFRAMEWORK_API TArray<FLinearColor> GetGradientColors(EColorPickerChannels Channel) const;
 
    // Callback for getting the alpha display mode of the color preview swatches.
    APPFRAMEWORK_API EColorBlockAlphaDisplayMode HandleColorPreviewAlphaMode() const;
 
    // Callback for clicking the Cancel button.
    APPFRAMEWORK_API FReply HandleCancelButtonClicked();
 
    // Callback for pressing a mouse button in the color area.
    APPFRAMEWORK_API FReply HandleColorAreaMouseDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent);
 
    // Callback for clicking the color picker mode button.
    APPFRAMEWORK_API FReply HandleColorPickerModeButtonClicked();
 
    // Callback for getting the visibility of the given color picker mode.
    APPFRAMEWORK_API EVisibility HandleColorPickerModeVisibility(EColorPickerModes Mode) const;
 
    // Callback for setting the visibility of the themes panel.
    APPFRAMEWORK_API FReply ToggleThemePanelVisibility();
 
    // Callback for getting the icon to display on the Show/Hide themes panel button.
    APPFRAMEWORK_API const FSlateBrush* HandleThemePanelButtonImageBrush() const;
 
    // Callback for getting the visibility of the themes panel.
    APPFRAMEWORK_API EVisibility HandleThemesPanelVisibility() const;
 
    // Callback for getting the tooltip for the color theme panel
    APPFRAMEWORK_API FText GetColorThemePanelToolTipText() const;
 
    // Callback for getting the end color of a color slider.
    APPFRAMEWORK_API FLinearColor HandleColorSliderEndColor(EColorPickerChannels Channel) const;
 
    // Callback for getting the start color of a color slider.
    APPFRAMEWORK_API FLinearColor HandleColorSliderStartColor(EColorPickerChannels Channel) const;
 
    // Callback for value changes in the color wheel picker.
    APPFRAMEWORK_API void HandleColorWheelValueChanged(FLinearColor NewValue);
 
    // Callback for value changes in the color spectrum picker.
    APPFRAMEWORK_API void HandleColorSpectrumValueChanged(FLinearColor NewValue);
 
    // Callback for getting the value of a color spin box.
    APPFRAMEWORK_API float HandleColorSpinBoxValue(EColorPickerChannels Channel) const;
 
    // Callback for value changes in a color spin box.
    APPFRAMEWORK_API void HandleColorSpinBoxValueChanged(float NewValue, EColorPickerChannels Channel);
 
    // Callback for start of eye dropper interactions.
    APPFRAMEWORK_API void HandleEyeDropperButtonBegin();
 
    // Callback for completed eye dropper interactions.
    APPFRAMEWORK_API void HandleEyeDropperButtonComplete(bool bCancelled);
 
    // Callback for getting the text in the hex linear box.
    APPFRAMEWORK_API FText HandleHexBoxText() const;
 
    // Callback for committed text in the hex input box (sRGB gamma).
    APPFRAMEWORK_API void HandleHexInputTextCommitted(const FText& Text, ETextCommit::Type CommitType);
 
    // Callback for changing the HSV value of the current color.
    APPFRAMEWORK_API void HandleHSVColorChanged(FLinearColor NewValue);
 
    // Callback for when interactive user input begins.
    APPFRAMEWORK_API void HandleInteractiveChangeBegin();
 
    // Callback for when interactive user input ends.
    APPFRAMEWORK_API void HandleInteractiveChangeEnd();
 
    // Callback for when interactive user input ends.
    APPFRAMEWORK_API void HandleInteractiveChangeEnd(float NewValue);
 
    // Callback for clicking the new color preview block.
    APPFRAMEWORK_API FReply HandleNewColorPreviewClicked();
 
    // Callback for clicking the old color preview block.
    APPFRAMEWORK_API FReply HandleOldColorPreviewClicked();
 
    // Callback for getting the visibility of the old/new color buttons
    APPFRAMEWORK_API EVisibility HandleColorPreviewButtonVisibility() const;
 
    // Callback for setting the visibility of the new color preview button image
    APPFRAMEWORK_API void SetNewColorPreviewImageVisibility(EVisibility InButtonVisibility);
 
    // Callback for setting the visibility of the old color preview button image
    APPFRAMEWORK_API void SetOldColorPreviewImageVisibility(EVisibility InButtonVisibility);
 
    // Callback for getting the visibility of the new color preview button image
    APPFRAMEWORK_API EVisibility GetNewColorPreviewImageVisibility() const;
 
    // Callback for getting the visibility of the old color preview button image
    APPFRAMEWORK_API EVisibility GetOldColorPreviewImageVisibility() const;
 
    // Callback for clicking the OK button.
    APPFRAMEWORK_API FReply HandleOkButtonClicked();
 
    // Callback for checking whether sRGB colors should be rendered.
    APPFRAMEWORK_API bool HandleColorPickerUseSRGB() const;
 
    // Callback for when the parent window has been closed.
    APPFRAMEWORK_API void HandleParentWindowClosed(const TSharedRef<SWindow>& Window);
 
    // Callback for changing the RGB value of the current color.
    APPFRAMEWORK_API void HandleRGBColorChanged(FLinearColor NewValue);
 
    // Callback for changing the checked state of the sRGB check box.
    APPFRAMEWORK_API void HandleSRGBCheckBoxCheckStateChanged(ECheckBoxState InIsChecked);
 
    // Callback for determining whether the sRGB check box should be checked.
    APPFRAMEWORK_API ECheckBoxState HandleSRGBCheckBoxIsChecked() const;
 
    // Callback for selecting a color in the color theme bar.
    APPFRAMEWORK_API void HandleThemeBarColorSelected(FLinearColor NewValue);
 
    // Build the menu widget for selecting the hexadecimal text mode
    APPFRAMEWORK_API TSharedRef<SWidget> MakeHexModeMenu();
 
    // Get the text to display on the hexadecimal text mode button
    APPFRAMEWORK_API FText HandleHexModeButtonText() const;
 
    // Callback for when the hexadecimal text mode changes
    APPFRAMEWORK_API void OnHexModeSelected(EColorPickerHexMode InHexMode);
 
private:
    
    TAttribute<FLinearColor> TargetColorAttribute;
 
    TAttribute<const FSlateBrush*> ColorWheelBrush;
 
    FLinearColor CurrentColorHSV;
 
    FLinearColor CurrentColorRGB;
    
    FLinearColor OldColor;
    
    FLinearColor ColorEnd;
 
    FLinearColor ColorBegin;
 
    EColorPickerModes CurrentMode;
 
    EColorPickerHexMode HexMode;
 
    float CurrentTime;
 
    static APPFRAMEWORK_API const double MAX_ALLOWED_UPDATE_TIME;
 
    bool bPerfIsTooSlowToUpdate;
 
    TAttribute<bool> bUseAlpha;
 
    bool bUseSRGB = false;
 
    bool bOnlyRefreshOnMouseUp;
 
    bool bOnlyRefreshOnOk;
 
    bool bClosedViaOkOrCancel;
 
    TWeakPtr<SWindow> ParentWindowPtr;
 
    TSharedPtr<SThemeColorBlocksBar> CurrentThemeBar;
 
    EVisibility NewColorPreviewImageVisibility;
 
    EVisibility OldColorPreviewImageVisibility;
 
    TAttribute<float> DisplayGamma;
 
    bool bColorPickerIsInlineVersion;
 
    bool bColorPickerCreationIsOverridden;
 
    bool bIsInteractive;
 
    bool bValidCreationOverrideExists;
    
    bool bClampValue;
 
    bool bIsThemePanelVisible;
 
private:
 
    FOnLinearColorValueChanged OnColorCommitted;
 
    FOnColorPickerCancelled OnColorPickerCancelled;
 
    FSimpleDelegate OnInteractivePickBegin;
 
    FSimpleDelegate OnInteractivePickEnd;
 
    FOnWindowClosed OnColorPickerWindowClosed;
 
    TWeakPtr<SWidget> OptionalOwningDetailsView;
 
    TSharedPtr<SColorWheel> ColorWheel;
};
 
 
struct FColorPickerArgs
{
    bool bIsModal = false;
 
    TSharedPtr<SWidget> ParentWidget;
 
    bool bUseAlpha = false;
 
    bool bOnlyRefreshOnMouseUp = false;
 
    bool bOnlyRefreshOnOk = false;
 
    bool bExpandAdvancedSection = true;
    
    bool bOpenAsMenu = false;
 
    bool bClampValue = false;
 
    TAttribute<float> DisplayGamma = 2.2f;
 
    TOptional<bool> sRGBOverride = TOptional<bool>();
 
    UE_DEPRECATED(5.2, "ColorArray is deprecated. Use OnColorCommitted to update your values.")
    const TArray<FColor*>* ColorArray = nullptr;
 
    UE_DEPRECATED(5.2, "LinearColorArray is deprecated. Use OnColorCommitted to update your values.")
    const TArray<FLinearColor*>* LinearColorArray = nullptr;
 
    UE_DEPRECATED(5.2, "ColorChannelsArray is deprecated. Use OnColorCommitted to update your values.")
    const TArray<FColorChannels>* ColorChannelsArray = nullptr;
 
    FOnLinearColorValueChanged OnColorCommitted;
 
    UE_DEPRECATED(5.2, "PreColorCommitted is deprecated. Use OnColorCommitted to update your values.")
    FOnLinearColorValueChanged PreColorCommitted;
 
    FOnWindowClosed OnColorPickerWindowClosed;
 
    FOnColorPickerCancelled OnColorPickerCancelled;
 
    FSimpleDelegate OnInteractivePickBegin;
 
    FSimpleDelegate OnInteractivePickEnd;
 
    UE_DEPRECATED(5.2, "InitialColorOverride is deprecated. Use InitialColor to set the initial color.")
    FLinearColor InitialColorOverride = FLinearColor::White;
 
    FLinearColor InitialColor = FLinearColor::White;
 
    TSharedPtr<SWidget> OptionalOwningDetailsView;
 
    FColorPickerArgs() = default;
 
    FColorPickerArgs(FLinearColor InInitialColor, FOnLinearColorValueChanged InOnColorCommitted)
        : OnColorCommitted(MoveTemp(InOnColorCommitted))
        , InitialColor(InInitialColor)
    {}
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    FColorPickerArgs(const FColorPickerArgs&) = default;
    FColorPickerArgs(FColorPickerArgs&&) = default;
PRAGMA_ENABLE_DEPRECATION_WARNINGS
};
 
APPFRAMEWORK_API TSharedPtr<SColorPicker> GetColorPicker();
 
APPFRAMEWORK_API bool OpenColorPicker(const FColorPickerArgs& Args);
 
APPFRAMEWORK_API void DestroyColorPicker();