KisColorSelectorComponent Class Reference

#include <kis_color_selector_component.h>

Inheritance diagram for KisColorSelectorComponent:

Public Types
typedef KisColorSelectorConfiguration::Parameters	Parameter
typedef KisColorSelectorConfiguration::Type	Type

Public Slots
void	setParam (qreal hue, qreal hsvSaturation, qreal value, qreal hslSaturation, qreal lightness, qreal hsiSaturation, qreal intensity, qreal hsySaturation, qreal luma)

Signals
void	paramChanged (qreal hue, qreal hsvSaturation, qreal value, qreal hslSaturation, qreal lightness, qreal hsiSaturation, qreal intensity, qreal hsySaturation, qreal luma)
	-1, if unaffected
void	update ()
	request for repaint, for instance, if the hue changes.

Public Member Functions
KoColor	currentColor ()
	return the color, that was selected by calling mouseEvent
int	height () const
	KisColorSelectorComponent (KisColorSelector *parent)
virtual void	mouseEvent (int x, int y)
	saves the mouse position, so that a blip can be created.
void	paintEvent (QPainter *)
virtual void	setColor (const KoColor &color)
	set the color, blibs etc
void	setConfiguration (Parameter param, Type type)
	setConfiguration can be ignored (for instance ring and triangle, as they can have only one config)
void	setDirty ()
	force subsequent redraw of the component
void	setGamutMask (KoGamutMaskSP gamutMask)
void	setGeometry (int x, int y, int width, int height)
void	toggleGamutMask (bool state)
void	unsetGamutMask ()
void	updateGamutMaskPreview ()
bool	wantsGrab (int x, int y)
	returns true, if this component wants to grab the mouse (normally true, if containsPoint returns true)
int	width () const

Protected Member Functions
virtual bool	allowsColorSelectionAtPoint (const QPoint &) const
const KoColorSpace *	colorSpace () const
virtual bool	containsPointInComponentCoords (int x, int y) const
bool	isDirty () const
	returns true, if ether the color space, the size or the parameters have changed since the last paint event
virtual void	paint (QPainter *)=0
virtual KoColor	selectColor (int x, int y)=0
	this method must be overloaded to return the color at position x/y and draw a marker on that position
void	setLastMousePosition (int x, int y)

Protected Attributes
KoGamutMaskSP	m_currentGamutMask
bool	m_gamutMaskOn {false}
qreal	m_hsiSaturation {0.0}
qreal	m_hslSaturation {0.0}
qreal	m_hsvSaturation {0.0}
qreal	m_hsySaturation {0.0}
qreal	m_hue {0.0}
qreal	m_intensity {0.0}
qreal	m_lastX {0.0}
qreal	m_lastY {0.0}
qreal	m_lightness {0.0}
qreal	m_luma {0.0}
bool	m_maskPreviewActive {false}
Parameter	m_parameter
KisColorSelector *	m_parent {0}
Type	m_type
qreal	m_value {0.0}
int	m_x {0}
int	m_y {0}

Private Attributes
bool	m_dirty {false}
int	m_height {0}
const KoColorSpace *	m_lastColorSpace {0}
KoColor	m_lastSelectedColor
int	m_width {0}

Detailed Description

Definition at line 22 of file kis_color_selector_component.h.

Member Typedef Documentation

Parameter

typedef KisColorSelectorConfiguration::Parameters KisColorSelectorComponent::Parameter

Definition at line 26 of file kis_color_selector_component.h.

Type

typedef KisColorSelectorConfiguration::Type KisColorSelectorComponent::Type

Definition at line 27 of file kis_color_selector_component.h.

Constructor & Destructor Documentation

KisColorSelectorComponent()

KisColorSelectorComponent::KisColorSelectorComponent ( KisColorSelector * parent )

explicit

Definition at line 17 of file kis_color_selector_component.cpp.

                                                                             :
    QObject(parent),
    m_hue(0),
    m_hsvSaturation(1),
    m_value(1),
    m_hslSaturation(1),
    m_lightness(0.5),
    m_hsiSaturation(1),
    m_intensity(0.333),
    m_hsySaturation(1),
    m_luma(0.299),
    m_parent(parent),
    m_gamutMaskOn(false),
    m_currentGamutMask(nullptr),
    m_maskPreviewActive(true),
    m_lastX(0),
    m_lastY(0),
    m_x(0),
    m_y(0),
    m_width(0),
    m_height(0),
    m_dirty(true),
    m_lastColorSpace(0)
{
    Q_ASSERT(parent);
}

Member Function Documentation

allowsColorSelectionAtPoint()

bool KisColorSelectorComponent::allowsColorSelectionAtPoint ( const QPoint & ) const

protectedvirtual

a subclass can implement this method to note that the point, although it is in containsPointInComponentCoords area, still cannot be selected as a color (e.g. it is masked out). Default implementation always returns true.

Reimplemented in KisColorSelectorWheel.

Definition at line 128 of file kis_color_selector_component.cpp.

{
    return true;
}

colorSpace()

const KoColorSpace * KisColorSelectorComponent::colorSpace ( ) const

protected

Definition at line 76 of file kis_color_selector_component.cpp.

{
    const KoColorSpace* cs = m_parent->colorSpace();
    Q_ASSERT(cs);
    return cs;
}

References KisColorSelectorBase::colorSpace(), and m_parent.

containsPointInComponentCoords()

bool KisColorSelectorComponent::containsPointInComponentCoords ( int x, int y ) const

protectedvirtual

a subclass can implement this method, the default returns true if the coordinates are in the component rect values for the subclasses are provided in component coordinates, eg (0,0) is top left of component

Reimplemented in KisColorSelectorRing, and KisColorSelectorTriangle.

Definition at line 120 of file kis_color_selector_component.cpp.

{
    if(x>=0 && y>=0 && x<=width() && y<=height())
        return true;
    else
        return false;
}

References height(), and width().

currentColor()

KoColor KisColorSelectorComponent::currentColor

(

)

return the color, that was selected by calling mouseEvent

Definition at line 133 of file kis_color_selector_component.cpp.

{
    return selectColor(m_lastX, m_lastY);
}

References m_lastX, m_lastY, and selectColor().

height()

int KisColorSelectorComponent::height

(

)

const

Definition at line 220 of file kis_color_selector_component.cpp.

{
    return m_height;
}

References m_height.

isDirty()

bool KisColorSelectorComponent::isDirty ( ) const

protected

returns true, if ether the color space, the size or the parameters have changed since the last paint event

Definition at line 115 of file kis_color_selector_component.cpp.

{
    return m_dirty || m_lastColorSpace!=colorSpace();
}

References colorSpace(), m_dirty, and m_lastColorSpace.

mouseEvent()

void KisColorSelectorComponent::mouseEvent ( int x, int y )

virtual

saves the mouse position, so that a blip can be created.

Definition at line 64 of file kis_color_selector_component.cpp.

{
    int newX=qBound(0, (x-m_x), width());
    int newY=qBound(0, (y-m_y), height());
 
    if (allowsColorSelectionAtPoint(QPoint(newX, newY))) {
        m_lastSelectedColor = selectColor(newX, newY);
        m_lastX=newX;
        m_lastY=newY;
    }
}

References allowsColorSelectionAtPoint(), height(), m_lastSelectedColor, m_lastX, m_lastY, m_x, m_y, selectColor(), and width().

paint()

virtual void KisColorSelectorComponent::paint ( QPainter * )

protectedpure virtual

paint component using given painter the component should respect width() and height() (eg. scale to width and height), but doesn't have to care about x/y coordinates (top left corner)

Implemented in KisColorSelectorRing, KisColorSelectorSimple, KisColorSelectorTriangle, and KisColorSelectorWheel.

paintEvent()

void KisColorSelectorComponent::paintEvent

(

QPainter *

painter

)

Definition at line 53 of file kis_color_selector_component.cpp.

{
    painter->save();
    painter->translate(m_x, m_y);
    paint(painter);
    painter->restore();
 
    m_dirty=false;
    m_lastColorSpace=colorSpace();
}

References colorSpace(), m_dirty, m_lastColorSpace, m_x, m_y, and paint().

paramChanged

void KisColorSelectorComponent::paramChanged ( qreal hue, qreal hsvSaturation, qreal value, qreal hslSaturation, qreal lightness, qreal hsiSaturation, qreal intensity, qreal hsySaturation, qreal luma )

signal

-1, if unaffected

selectColor()

virtual KoColor KisColorSelectorComponent::selectColor ( int x, int y )

protectedpure virtual

this method must be overloaded to return the color at position x/y and draw a marker on that position

Implemented in KisColorSelectorRing, KisColorSelectorSimple, KisColorSelectorTriangle, and KisColorSelectorWheel.

setColor()

void KisColorSelectorComponent::setColor ( const KoColor & color )

virtual

set the color, blibs etc

Reimplemented in KisColorSelectorRing, KisColorSelectorSimple, KisColorSelectorTriangle, and KisColorSelectorWheel.

Definition at line 231 of file kis_color_selector_component.cpp.

{
    m_lastSelectedColor = color;
}

References m_lastSelectedColor.

setConfiguration()

void KisColorSelectorComponent::setConfiguration	(	Parameter	param,
		Type	type )

setConfiguration can be ignored (for instance ring and triangle, as they can have only one config)

Definition at line 225 of file kis_color_selector_component.cpp.

{
    m_parameter = param;
    m_type = type;
}

References m_parameter, and m_type.

setDirty()

void KisColorSelectorComponent::setDirty

(

)

force subsequent redraw of the component

Definition at line 83 of file kis_color_selector_component.cpp.

{
    m_dirty = true;
    setColor(m_lastSelectedColor);
}

References m_dirty, m_lastSelectedColor, and setColor().

setGamutMask()

void KisColorSelectorComponent::setGamutMask

(

KoGamutMaskSP

gamutMask

)

Definition at line 89 of file kis_color_selector_component.cpp.

{
    m_currentGamutMask = gamutMask;
    m_gamutMaskOn = true;
}

References m_currentGamutMask, and m_gamutMaskOn.

setGeometry()

void KisColorSelectorComponent::setGeometry	(	int	x,
		int	y,
		int	width,
		int	height )

Definition at line 44 of file kis_color_selector_component.cpp.

{
    m_x=x;
    m_y=y;
    m_width=width;
    m_height=height;
    m_dirty=true;
}

References height(), m_dirty, m_height, m_width, m_x, m_y, and width().

setLastMousePosition()

void KisColorSelectorComponent::setLastMousePosition ( int x, int y )

protected

Definition at line 236 of file kis_color_selector_component.cpp.

{
    // prevent movement due to rounding errors
    if (abs((int)m_lastX - x) > 1 || abs((int)m_lastY - y) > 1) {
        m_lastX = x;
        m_lastY = y;
    }
}

References m_lastX, and m_lastY.

setParam

void KisColorSelectorComponent::setParam ( qreal hue, qreal hsvSaturation, qreal value, qreal hslSaturation, qreal lightness, qreal hsiSaturation, qreal intensity, qreal hsySaturation, qreal luma )

slot

set hue, saturation, value or/and lightness unused parameters should be set to -1

Definition at line 138 of file kis_color_selector_component.cpp.

{
    if(qFuzzyCompare(m_hue, hue) &&
       qFuzzyCompare(m_hsvSaturation, hsvSaturation) &&
       qFuzzyCompare(m_value, value) &&
       qFuzzyCompare(m_hslSaturation, hslSaturation) &&
       qFuzzyCompare(m_lightness, lightness) &&
       qFuzzyCompare(m_hsiSaturation, hsiSaturation) &&
       qFuzzyCompare(m_intensity, intensity) &&
       qFuzzyCompare(m_hsySaturation, hsySaturation) &&
       qFuzzyCompare(m_luma, luma))
        return;
 
    if (hue >= 0) {
        m_hue = qMin(hue, qreal(1));
    }
 
    if (hsvSaturation >= 0) {
        m_hsvSaturation = qMin(hsvSaturation, qreal(1));
        m_hslSaturation = -1;
        m_hsiSaturation = -1;
        m_hsySaturation = -1;
    }
 
    if (value >= 0) {
        m_value = qMin(value, qreal(1));
        m_intensity = -1;
        m_luma = -1;
        m_lightness = -1;
    }
 
    if (hslSaturation >= 0) {
        m_hslSaturation = qMin(hslSaturation, qreal(1));
        m_hsvSaturation = -1;
        m_hsiSaturation = -1;
        m_hsySaturation = -1;
    }
 
    if (lightness >= 0) {
        m_lightness = qMin(lightness, qreal(1));
        m_value = -1;
        m_luma = -1;
        m_intensity = -1;
    }
 
    if (hsiSaturation >= 0) {
        m_hsiSaturation = qMin(hsiSaturation, qreal(1));
        m_hsvSaturation = -1;
        m_hslSaturation = -1;
        m_hsySaturation = -1;
    }
 
    if (intensity >= 0) {
        m_intensity = qMin(intensity, qreal(1));
        m_value = -1;
        m_luma = -1;
        m_lightness = -1;
    }
 
    if (hsySaturation >= 0) {
        m_hsySaturation = qMin(hsySaturation, qreal(1));
        m_hsvSaturation = -1;
        m_hsiSaturation = -1;
        m_hslSaturation = -1;
    }
 
    if (luma >= 0) {
        m_luma = qMin(luma, qreal(1));
        m_intensity = -1;
        m_value = -1;
        m_lightness = -1;
    }
 
    m_dirty=true;
    Q_EMIT update();
}

References m_dirty, m_hsiSaturation, m_hslSaturation, m_hsvSaturation, m_hsySaturation, m_hue, m_intensity, m_lightness, m_luma, m_value, qFuzzyCompare(), update(), and value().

toggleGamutMask()

void KisColorSelectorComponent::toggleGamutMask

(

bool

state

)

Definition at line 107 of file kis_color_selector_component.cpp.

{
    m_gamutMaskOn = state;
    setDirty();
    update();
}

References m_gamutMaskOn, setDirty(), and update().

unsetGamutMask()

void KisColorSelectorComponent::unsetGamutMask

(

)

Definition at line 95 of file kis_color_selector_component.cpp.

{
    m_gamutMaskOn = false;
    m_currentGamutMask = nullptr;
}

References m_currentGamutMask, and m_gamutMaskOn.

update

void KisColorSelectorComponent::update ( )

signal

request for repaint, for instance, if the hue changes.

updateGamutMaskPreview()

void KisColorSelectorComponent::updateGamutMaskPreview

(

)

Definition at line 101 of file kis_color_selector_component.cpp.

{
    setDirty();
    update();
}

References setDirty(), and update().

wantsGrab()

bool KisColorSelectorComponent::wantsGrab ( int x, int y )

inline

returns true, if this component wants to grab the mouse (normally true, if containsPoint returns true)

Definition at line 52 of file kis_color_selector_component.h.

{return containsPointInComponentCoords(x-m_x, y-m_y);}

References containsPointInComponentCoords(), m_x, and m_y.

width()

int KisColorSelectorComponent::width

(

)

const

Definition at line 215 of file kis_color_selector_component.cpp.

{
    return m_width;
}

References m_width.

Member Data Documentation

m_currentGamutMask

KoGamutMaskSP KisColorSelectorComponent::m_currentGamutMask

protected

Definition at line 106 of file kis_color_selector_component.h.

m_dirty

bool KisColorSelectorComponent::m_dirty {false}

private

Definition at line 115 of file kis_color_selector_component.h.

{false};

m_gamutMaskOn

bool KisColorSelectorComponent::m_gamutMaskOn {false}

protected

Definition at line 105 of file kis_color_selector_component.h.

{false};

m_height

int KisColorSelectorComponent::m_height {0}

private

Definition at line 114 of file kis_color_selector_component.h.

{0};

m_hsiSaturation

qreal KisColorSelectorComponent::m_hsiSaturation {0.0}

protected

Definition at line 98 of file kis_color_selector_component.h.

{0.0};

m_hslSaturation

qreal KisColorSelectorComponent::m_hslSaturation {0.0}

protected

Definition at line 96 of file kis_color_selector_component.h.

{0.0};

m_hsvSaturation

qreal KisColorSelectorComponent::m_hsvSaturation {0.0}

protected

Definition at line 94 of file kis_color_selector_component.h.

{0.0};

m_hsySaturation

qreal KisColorSelectorComponent::m_hsySaturation {0.0}

protected

Definition at line 100 of file kis_color_selector_component.h.

{0.0};

m_hue

qreal KisColorSelectorComponent::m_hue {0.0}

protected

Definition at line 93 of file kis_color_selector_component.h.

{0.0};

m_intensity

qreal KisColorSelectorComponent::m_intensity {0.0}

protected

Definition at line 99 of file kis_color_selector_component.h.

{0.0};

m_lastColorSpace

const KoColorSpace* KisColorSelectorComponent::m_lastColorSpace {0}

private

Definition at line 116 of file kis_color_selector_component.h.

{0};

m_lastSelectedColor

KoColor KisColorSelectorComponent::m_lastSelectedColor

private

Definition at line 117 of file kis_color_selector_component.h.

m_lastX

qreal KisColorSelectorComponent::m_lastX {0.0}

protected

Definition at line 108 of file kis_color_selector_component.h.

{0.0};

m_lastY

qreal KisColorSelectorComponent::m_lastY {0.0}

protected

Definition at line 109 of file kis_color_selector_component.h.

{0.0};

m_lightness

qreal KisColorSelectorComponent::m_lightness {0.0}

protected

Definition at line 97 of file kis_color_selector_component.h.

{0.0};

m_luma

qreal KisColorSelectorComponent::m_luma {0.0}

protected

Definition at line 101 of file kis_color_selector_component.h.

{0.0};

m_maskPreviewActive

bool KisColorSelectorComponent::m_maskPreviewActive {false}

protected

Definition at line 107 of file kis_color_selector_component.h.

{false};

m_parameter

Parameter KisColorSelectorComponent::m_parameter

protected

Definition at line 102 of file kis_color_selector_component.h.

m_parent

KisColorSelector* KisColorSelectorComponent::m_parent {0}

protected

Definition at line 104 of file kis_color_selector_component.h.

{0};

m_type

Type KisColorSelectorComponent::m_type

protected

Definition at line 103 of file kis_color_selector_component.h.

m_value

qreal KisColorSelectorComponent::m_value {0.0}

protected

Definition at line 95 of file kis_color_selector_component.h.

{0.0};

m_width

int KisColorSelectorComponent::m_width {0}

private

Definition at line 113 of file kis_color_selector_component.h.

{0};

m_x

int KisColorSelectorComponent::m_x {0}

protected

Definition at line 110 of file kis_color_selector_component.h.

{0};

m_y

int KisColorSelectorComponent::m_y {0}

protected

Definition at line 111 of file kis_color_selector_component.h.

{0};

---

The documentation for this class was generated from the following files:

• plugins/dockers/advancedcolorselector/kis_color_selector_component.h
• plugins/dockers/advancedcolorselector/kis_color_selector_component.cpp