dialog_color_picker.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef DIALOG_COLOR_PICKER_H
#define DIALOG_COLOR_PICKER_H


#include <gal/color4d.h>
#include "../../common/dialogs/dialog_color_picker_base.h"

class COLOR_SWATCH;


struct CUSTOM_COLOR_ITEM
{
    KIGFX::COLOR4D m_Color;
    wxString m_ColorName;

    CUSTOM_COLOR_ITEM( double red, double green, double blue, const wxString& aName )
    {
        m_Color.r = red;
        m_Color.g = green;
        m_Color.b = blue;
        m_ColorName = aName;
    }

    CUSTOM_COLOR_ITEM( double red, double green, double blue, double alpha, const wxString& aName )
    {
        m_Color.r = red;
        m_Color.g = green;
        m_Color.b = blue;
        m_Color.a = alpha;
        m_ColorName = aName;
    }

    CUSTOM_COLOR_ITEM( const KIGFX::COLOR4D& aColor, const wxString& aName )
        : m_Color( aColor ), m_ColorName( aName)
    {}
};


typedef std::vector<CUSTOM_COLOR_ITEM> CUSTOM_COLORS_LIST;


enum CHANGED_COLOR
{
    ALL_CHANGED,
    RED_CHANGED,
    BLUE_CHANGED,
    GREEN_CHANGED,
    ALPHA_CHANGED,
    HUE_CHANGED,
    SAT_CHANGED,
    VAL_CHANGED,
    HEX_CHANGED
};

class DIALOG_COLOR_PICKER : public DIALOG_COLOR_PICKER_BASE
{
public:
    DIALOG_COLOR_PICKER( wxWindow* aParent, const KIGFX::COLOR4D& aCurrentColor,
                         bool aAllowOpacityControl, CUSTOM_COLORS_LIST* aUserColors = nullptr,
                         const KIGFX::COLOR4D& aDefaultColor = KIGFX::COLOR4D::UNSPECIFIED );
    ~DIALOG_COLOR_PICKER();

    KIGFX::COLOR4D GetColor() { return m_newColor4D; };

private:
    /* When the dialog is created, the mouse cursor can be on the RGB or HSV palette selector
     * Because this dialog is created by clicking double clicking on a widget, the left mouse
     * button is down, thus creating a not wanted mouse event inside this dialog
     * m_allowMouseEvents is first set to false, and then set to true on the first left mouse
     * clicking inside this dialog to prevent not wanted mouse drag event
     */
    bool m_allowMouseEvents;
    bool m_allowOpacityCtrl;            
    KIGFX::COLOR4D m_previousColor4D;   
    KIGFX::COLOR4D m_newColor4D;        
    KIGFX::COLOR4D m_defaultColor;      

    std::vector<KIGFX::COLOR4D> m_Color4DList;
    int m_cursorsSize;

    wxPoint m_cursorBitmapRed;          
    wxPoint m_cursorBitmapGreen;        
    wxPoint m_cursorBitmapBlue;         
    wxPoint m_cursorBitmapHSV;          
    wxPoint* m_selectedCursor;          

    double m_hue;                       
    double m_sat;                       
    double m_val;                       

    wxBitmap* m_bitmapRGB;              
    wxBitmap* m_bitmapHSV;              

    std::vector<wxStaticBitmap*> m_colorSwatches;    

    void SetEditVals( CHANGED_COLOR aChanged, bool aCheckTransparency );
    void drawAll();

    void createHSVBitmap();             
    void drawHSVPalette();              
    void createRGBBitmap();             
    void drawRGBPalette();              

    void updatePreview( wxStaticBitmap* aStaticBitmap, KIGFX::COLOR4D& aColor4D );

    void OnChangeBrightness( wxScrollEvent& event ) override;

    void OnChangeAlpha( wxScrollEvent& event ) override;

    void OnChangeEditRed( wxSpinEvent& event ) override;
    void OnChangeEditGreen( wxSpinEvent& event ) override;
    void OnChangeEditBlue( wxSpinEvent& event ) override;
    void OnChangeEditHue( wxSpinEvent& event ) override;
    void OnChangeEditSat( wxSpinEvent& event ) override;

    void onRGBMouseClick( wxMouseEvent& event ) override;
    void onRGBMouseDrag( wxMouseEvent& event ) override;
    void onHSVMouseClick( wxMouseEvent& event ) override;
    void onHSVMouseDrag( wxMouseEvent& event ) override;

    void OnColorValueText( wxCommandEvent& event ) override;

    void OnResetButton( wxCommandEvent& aEvent ) override;

    bool setHSvaluesFromCursor( const wxPoint& aMouseCursor );

    void buttColorClick( wxMouseEvent& event );

    void colorDClick( wxMouseEvent& event );

    bool TransferDataToWindow() override;

    void initDefinedColors( CUSTOM_COLORS_LIST* aPredefinedColors );

    // convert double value 0 ... 1 to int 0 ... aValMax
    int normalizeToInt( double aValue, int aValMax = 255 )
    {
        return ( aValue * aValMax ) + 0.5;
    }

};

#endif  // #define DIALOG_COLOR_PICKER_H