Write API docs here. More...

#include <KoSegmentGradient.h>

Classes
class	ColorInterpolationStrategy

class	CurvedInterpolationStrategy

class	HSVCCWColorInterpolationStrategy

class	HSVCWColorInterpolationStrategy

class	InterpolationStrategy

class	LinearInterpolationStrategy

class	RGBColorInterpolationStrategy

class	SineInterpolationStrategy

class	SphereDecreasingInterpolationStrategy

class	SphereIncreasingInterpolationStrategy

Public Member Functions
void	colorAt (KoColor &, qreal t) const

int	colorInterpolation () const

const KoColor &	endColor () const

qreal	endOffset () const

KoGradientSegmentEndpointType	endType () const

bool	hasVariableColors ()

int	interpolation () const

bool	isValid () const

	KoGradientSegment (int interpolationType, int colorInterpolationType, KoGradientSegmentEndpoint start, KoGradientSegmentEndpoint end, qreal middleOffset)

qreal	length ()

qreal	middleOffset () const

void	mirrorSegment ()

void	setColorInterpolation (int colorInterpolationType)

void	setEndColor (const KoColor &color)

void	setEndOffset (qreal t)

void	setEndType (KoGradientSegmentEndpointType type)

void	setInterpolation (int interpolationType)

void	setMiddleOffset (qreal t)

void	setStartColor (const KoColor &color)

void	setStartOffset (qreal t)

void	setStartType (KoGradientSegmentEndpointType type)

void	setVariableColors (const KoColor &foreground, const KoColor &background)

const KoColor &	startColor () const

qreal	startOffset () const

KoGradientSegmentEndpointType	startType () const

Private Attributes
ColorInterpolationStrategy *	m_colorInterpolator

KoGradientSegmentEndpoint	m_end

bool	m_hasVariableColors = false

InterpolationStrategy *	m_interpolator

qreal	m_length

qreal	m_middleOffset

qreal	m_middleT

KoGradientSegmentEndpoint	m_start

Detailed Description

Write API docs here.

Definition at line 62 of file KoSegmentGradient.h.

Constructor & Destructor Documentation

◆ KoGradientSegment()

KoGradientSegment::KoGradientSegment	(	int	interpolationType,
		int	colorInterpolationType,
		KoGradientSegmentEndpoint	start,
		KoGradientSegmentEndpoint	end,
		qreal	middleOffset )

Definition at line 316 of file KoSegmentGradient.cpp.

    : m_start(start), m_end(end)
{
    m_interpolator = 0;
 
    switch (interpolationType) {
    case INTERP_LINEAR:
        m_interpolator = LinearInterpolationStrategy::instance();
        break;
    case INTERP_CURVED:
        m_interpolator = CurvedInterpolationStrategy::instance();
        break;
    case INTERP_SINE:
        m_interpolator = SineInterpolationStrategy::instance();
        break;
    case INTERP_SPHERE_INCREASING:
        m_interpolator = SphereIncreasingInterpolationStrategy::instance();
        break;
    case INTERP_SPHERE_DECREASING:
        m_interpolator = SphereDecreasingInterpolationStrategy::instance();
        break;
    }
 
    m_colorInterpolator = 0;
 
    switch (colorInterpolationType) {
    case COLOR_INTERP_RGB:
        m_colorInterpolator = RGBColorInterpolationStrategy::instance();
        break;
    case COLOR_INTERP_HSV_CCW:
        m_colorInterpolator = HSVCCWColorInterpolationStrategy::instance();
        break;
    case COLOR_INTERP_HSV_CW:
        m_colorInterpolator = HSVCWColorInterpolationStrategy::instance();
        break;
    }
 
 
 
    if (m_start.offset < DBL_EPSILON) {
        m_start.offset = 0;
    } else if (m_start.offset > 1 - DBL_EPSILON) {
        m_start.offset = 1;
    }
 
    if (middleOffset < m_start.offset + DBL_EPSILON) {
        m_middleOffset = m_start.offset;
    } else if (middleOffset > 1 - DBL_EPSILON) {
        m_middleOffset = 1;
    } else {
        m_middleOffset = middleOffset;
    }
 
    if (m_end.offset < m_middleOffset + DBL_EPSILON) {
        m_end.offset = m_middleOffset;
    } else if (m_end.offset > 1 - DBL_EPSILON) {
        m_end.offset = 1;
    }
 
    m_length = m_end.offset - m_start.offset;
 
    if (m_length < DBL_EPSILON) {
        m_middleT = 0.5;
    } else {
        m_middleT = (m_middleOffset - m_start.offset) / m_length;
    }
 
    m_hasVariableColors = m_start.type != COLOR_ENDPOINT || m_end.type != COLOR_ENDPOINT;
 
}

Member Function Documentation

◆ colorAt()

void KoGradientSegment::colorAt	(	KoColor &	dst,
		qreal	t ) const

Definition at line 566 of file KoSegmentGradient.cpp.

{
    Q_ASSERT(t > m_start.offset - DBL_EPSILON && t < m_end.offset + DBL_EPSILON);
 
    qreal segmentT;
 
    if (m_length < DBL_EPSILON) {
        segmentT = 0.5;
    } else {
        segmentT = qBound(0.0, (t - m_start.offset) / m_length, 1.0);
    }
 
    qreal colorT = m_interpolator->valueAt(segmentT, m_middleT);
 
    m_colorInterpolator->colorAt(dst, colorT, m_start.color, m_end.color);
 
}

References KoGradientSegmentEndpoint::color, KoGradientSegment::ColorInterpolationStrategy::colorAt(), m_colorInterpolator, m_end, m_interpolator, m_length, m_middleT, m_start, KoGradientSegmentEndpoint::offset, and KoGradientSegment::InterpolationStrategy::valueAt().

◆ colorInterpolation()

int KoGradientSegment::colorInterpolation ( ) const

Definition at line 546 of file KoSegmentGradient.cpp.

{
    return m_colorInterpolator->type();
}

References m_colorInterpolator, and KoGradientSegment::ColorInterpolationStrategy::type().

◆ endColor()

const KoColor & KoGradientSegment::endColor ( ) const

Definition at line 392 of file KoSegmentGradient.cpp.

{
    return m_end.color;
}

References KoGradientSegmentEndpoint::color, and m_end.

◆ endOffset()

qreal KoGradientSegment::endOffset ( ) const

Definition at line 407 of file KoSegmentGradient.cpp.

{
    return m_end.offset;
}

References m_end, and KoGradientSegmentEndpoint::offset.

◆ endType()

KoGradientSegmentEndpointType KoGradientSegment::endType ( ) const

Definition at line 417 of file KoSegmentGradient.cpp.

{
    return m_end.type;
}

References m_end, and KoGradientSegmentEndpoint::type.

◆ hasVariableColors()

bool KoGradientSegment::hasVariableColors ( )

Definition at line 516 of file KoSegmentGradient.cpp.

                                          {
    return m_hasVariableColors;
}

References m_hasVariableColors.

◆ interpolation()

int KoGradientSegment::interpolation ( ) const

Definition at line 520 of file KoSegmentGradient.cpp.

{
    return m_interpolator->type();
}

References m_interpolator, and KoGradientSegment::InterpolationStrategy::type().

◆ isValid()

bool KoGradientSegment::isValid ( ) const

Definition at line 609 of file KoSegmentGradient.cpp.

{
    if (m_interpolator == 0 || m_colorInterpolator == 0)
        return false;
    return true;
}

References m_colorInterpolator, and m_interpolator.

◆ length()

qreal KoGradientSegment::length ( )

inline

Definition at line 106 of file KoSegmentGradient.h.

                   {
        return m_length;
    }

◆ middleOffset()

qreal KoGradientSegment::middleOffset ( ) const

Definition at line 402 of file KoSegmentGradient.cpp.

{
    return m_middleOffset;
}

References m_middleOffset.

◆ mirrorSegment()

void KoGradientSegment::mirrorSegment ( )

Definition at line 584 of file KoSegmentGradient.cpp.

{
    KoColor tmpColor = startColor();
    setStartColor(endColor());
    setEndColor(tmpColor);
    KoGradientSegmentEndpointType tmpType = startType();
    setStartType(endType());
    setEndType(tmpType);
 
    setMiddleOffset(endOffset() - (middleOffset() - startOffset()));
 
    if (interpolation() == INTERP_SPHERE_INCREASING) {
        setInterpolation(INTERP_SPHERE_DECREASING);
    }
    else if (interpolation() == INTERP_SPHERE_DECREASING) {
        setInterpolation(INTERP_SPHERE_INCREASING);
    }
    if (colorInterpolation() == COLOR_INTERP_HSV_CW) {
        setColorInterpolation(COLOR_INTERP_HSV_CCW);
    }
    else if (colorInterpolation() == COLOR_INTERP_HSV_CCW) {
        setColorInterpolation(COLOR_INTERP_HSV_CW);
    }
}

References COLOR_INTERP_HSV_CCW, COLOR_INTERP_HSV_CW, colorInterpolation(), endColor(), endOffset(), endType(), INTERP_SPHERE_DECREASING, INTERP_SPHERE_INCREASING, interpolation(), middleOffset(), setColorInterpolation(), setEndColor(), setEndType(), setInterpolation(), setMiddleOffset(), setStartColor(), setStartType(), startColor(), startOffset(), and startType().

◆ setColorInterpolation()

void KoGradientSegment::setColorInterpolation ( int colorInterpolationType )

Definition at line 551 of file KoSegmentGradient.cpp.

{
    switch (colorInterpolationType) {
    case COLOR_INTERP_RGB:
        m_colorInterpolator = RGBColorInterpolationStrategy::instance();
        break;
    case COLOR_INTERP_HSV_CCW:
        m_colorInterpolator = HSVCCWColorInterpolationStrategy::instance();
        break;
    case COLOR_INTERP_HSV_CW:
        m_colorInterpolator = HSVCWColorInterpolationStrategy::instance();
        break;
    }
}

References COLOR_INTERP_HSV_CCW, COLOR_INTERP_HSV_CW, COLOR_INTERP_RGB, KoGradientSegment::RGBColorInterpolationStrategy::instance(), KoGradientSegment::HSVCWColorInterpolationStrategy::instance(), KoGradientSegment::HSVCCWColorInterpolationStrategy::instance(), and m_colorInterpolator.

◆ setEndColor()

void KoGradientSegment::setEndColor ( const KoColor & color )

inline

Definition at line 83 of file KoSegmentGradient.h.

                                           {
        m_end.color = color;
        if (m_end.type == FOREGROUND_TRANSPARENT_ENDPOINT || m_end.type == BACKGROUND_TRANSPARENT_ENDPOINT) {
            m_end.color.setOpacity(quint8(0));
        } else if (m_end.type == FOREGROUND_ENDPOINT || m_end.type == BACKGROUND_ENDPOINT) {
            m_end.color.setOpacity(quint8(255));
        }
    }

References BACKGROUND_ENDPOINT, BACKGROUND_TRANSPARENT_ENDPOINT, FOREGROUND_ENDPOINT, FOREGROUND_TRANSPARENT_ENDPOINT, and KoColor::setOpacity().

◆ setEndOffset()

void KoGradientSegment::setEndOffset ( qreal t )

Definition at line 464 of file KoSegmentGradient.cpp.

{
    m_end.offset = t;
    m_length = m_end.offset - m_start.offset;
 
    if (m_length < DBL_EPSILON) {
        m_middleT = 0.5;
    } else {
        m_middleT = (m_middleOffset - m_start.offset) / m_length;
    }
}

References m_end, m_length, m_middleOffset, m_middleT, m_start, and KoGradientSegmentEndpoint::offset.

◆ setEndType()

void KoGradientSegment::setEndType ( KoGradientSegmentEndpointType type )

Definition at line 432 of file KoSegmentGradient.cpp.

                                                                     {
    m_end.type = type;
    if (type != COLOR_ENDPOINT) {
        m_hasVariableColors = true;
    }
    else if (m_start.type == COLOR_ENDPOINT) {
        m_hasVariableColors = false;
    }
}

References COLOR_ENDPOINT, m_end, m_hasVariableColors, m_start, and KoGradientSegmentEndpoint::type.

◆ setInterpolation()

void KoGradientSegment::setInterpolation ( int interpolationType )

Definition at line 525 of file KoSegmentGradient.cpp.

{
    switch (interpolationType) {
    case INTERP_LINEAR:
        m_interpolator = LinearInterpolationStrategy::instance();
        break;
    case INTERP_CURVED:
        m_interpolator = CurvedInterpolationStrategy::instance();
        break;
    case INTERP_SINE:
        m_interpolator = SineInterpolationStrategy::instance();
        break;
    case INTERP_SPHERE_INCREASING:
        m_interpolator = SphereIncreasingInterpolationStrategy::instance();
        break;
    case INTERP_SPHERE_DECREASING:
        m_interpolator = SphereDecreasingInterpolationStrategy::instance();
        break;
    }
}

References KoGradientSegment::LinearInterpolationStrategy::instance(), KoGradientSegment::CurvedInterpolationStrategy::instance(), KoGradientSegment::SphereIncreasingInterpolationStrategy::instance(), KoGradientSegment::SphereDecreasingInterpolationStrategy::instance(), KoGradientSegment::SineInterpolationStrategy::instance(), INTERP_CURVED, INTERP_LINEAR, INTERP_SINE, INTERP_SPHERE_DECREASING, INTERP_SPHERE_INCREASING, and m_interpolator.

◆ setMiddleOffset()

void KoGradientSegment::setMiddleOffset ( qreal t )

Definition at line 453 of file KoSegmentGradient.cpp.

{
    m_middleOffset = t;
 
    if (m_length < DBL_EPSILON) {
        m_middleT = 0.5;
    } else {
        m_middleT = (m_middleOffset - m_start.offset) / m_length;
    }
}

References m_length, m_middleOffset, m_middleT, m_start, and KoGradientSegmentEndpoint::offset.

◆ setStartColor()

void KoGradientSegment::setStartColor ( const KoColor & color )

inline

Definition at line 75 of file KoSegmentGradient.h.

                                             {
        m_start.color = color;
        if (m_start.type == FOREGROUND_TRANSPARENT_ENDPOINT || m_start.type == BACKGROUND_TRANSPARENT_ENDPOINT) {
            m_start.color.setOpacity(quint8(0));
        } else if (m_start.type == FOREGROUND_ENDPOINT || m_start.type == BACKGROUND_ENDPOINT) {
            m_start.color.setOpacity(quint8(255));
        }
    }

References BACKGROUND_ENDPOINT, BACKGROUND_TRANSPARENT_ENDPOINT, FOREGROUND_ENDPOINT, FOREGROUND_TRANSPARENT_ENDPOINT, and KoColor::setOpacity().

◆ setStartOffset()

void KoGradientSegment::setStartOffset ( qreal t )

Definition at line 442 of file KoSegmentGradient.cpp.

{
    m_start.offset = t;
    m_length = m_end.offset - m_start.offset;
 
    if (m_length < DBL_EPSILON) {
        m_middleT = 0.5;
    } else {
        m_middleT = (m_middleOffset - m_start.offset) / m_length;
    }
}

References m_end, m_length, m_middleOffset, m_middleT, m_start, and KoGradientSegmentEndpoint::offset.

◆ setStartType()

void KoGradientSegment::setStartType ( KoGradientSegmentEndpointType type )

Definition at line 422 of file KoSegmentGradient.cpp.

                                                                       {
    m_start.type = type;
    if (type != COLOR_ENDPOINT) {
        m_hasVariableColors = true;
    }
    else if (m_end.type == COLOR_ENDPOINT) {
        m_hasVariableColors = false;
    }
}

References COLOR_ENDPOINT, m_end, m_hasVariableColors, m_start, and KoGradientSegmentEndpoint::type.

◆ setVariableColors()

void KoGradientSegment::setVariableColors	(	const KoColor &	foreground,
		const KoColor &	background )

Definition at line 476 of file KoSegmentGradient.cpp.

                                                                                              {
    switch (m_start.type) {
    case COLOR_ENDPOINT:
        break;
    case FOREGROUND_ENDPOINT:
        m_start.color = foreground;
        break;
    case FOREGROUND_TRANSPARENT_ENDPOINT: //TODO: add Transparent options to gradient editor...
        m_start.color = foreground;
        m_start.color.setOpacity(quint8(0));
        break;
    case BACKGROUND_ENDPOINT:
        m_start.color = background;
        break;
    case BACKGROUND_TRANSPARENT_ENDPOINT:
        m_start.color = background;
        m_start.color.setOpacity(quint8(0));
        break;
    }
 
    switch (m_end.type) {
    case COLOR_ENDPOINT:
        break;
    case FOREGROUND_ENDPOINT:
        m_end.color = foreground;
        break;
    case FOREGROUND_TRANSPARENT_ENDPOINT:
        m_end.color = foreground;
        m_end.color.setOpacity(quint8(0));
        break;
    case BACKGROUND_ENDPOINT:
        m_end.color = background;
        break;
    case BACKGROUND_TRANSPARENT_ENDPOINT:
        m_end.color = background;
        m_end.color.setOpacity(quint8(0));
        break;
    }
}

References BACKGROUND_ENDPOINT, BACKGROUND_TRANSPARENT_ENDPOINT, KoGradientSegmentEndpoint::color, COLOR_ENDPOINT, FOREGROUND_ENDPOINT, FOREGROUND_TRANSPARENT_ENDPOINT, m_end, m_start, KoColor::setOpacity(), and KoGradientSegmentEndpoint::type.

◆ startColor()

const KoColor & KoGradientSegment::startColor ( ) const

Definition at line 387 of file KoSegmentGradient.cpp.

{
    return m_start.color;
}

References KoGradientSegmentEndpoint::color, and m_start.

◆ startOffset()

qreal KoGradientSegment::startOffset ( ) const

Definition at line 397 of file KoSegmentGradient.cpp.

{
    return m_start.offset;
}

References m_start, and KoGradientSegmentEndpoint::offset.

◆ startType()

KoGradientSegmentEndpointType KoGradientSegment::startType ( ) const

Definition at line 412 of file KoSegmentGradient.cpp.

{
    return m_start.type;
}

References m_start, and KoGradientSegmentEndpoint::type.

Member Data Documentation

◆ m_colorInterpolator

ColorInterpolationStrategy* KoGradientSegment::m_colorInterpolator

private

Definition at line 274 of file KoSegmentGradient.h.

◆ m_end

KoGradientSegmentEndpoint KoGradientSegment::m_end

private

Definition at line 280 of file KoSegmentGradient.h.

◆ m_hasVariableColors

bool KoGradientSegment::m_hasVariableColors = false

private

Definition at line 281 of file KoSegmentGradient.h.

◆ m_interpolator

InterpolationStrategy* KoGradientSegment::m_interpolator

private

Definition at line 273 of file KoSegmentGradient.h.

◆ m_length

qreal KoGradientSegment::m_length

private

Definition at line 277 of file KoSegmentGradient.h.

◆ m_middleOffset

qreal KoGradientSegment::m_middleOffset

private

Definition at line 276 of file KoSegmentGradient.h.

◆ m_middleT

qreal KoGradientSegment::m_middleT

private

Definition at line 278 of file KoSegmentGradient.h.

◆ m_start

KoGradientSegmentEndpoint KoGradientSegment::m_start

private

Definition at line 280 of file KoSegmentGradient.h.

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

libs/pigment/resources/KoSegmentGradient.h
libs/pigment/resources/KoSegmentGradient.cpp

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KoGradientSegment()

Member Function Documentation

◆ colorAt()

◆ colorInterpolation()

◆ endColor()

◆ endOffset()

◆ endType()

◆ hasVariableColors()

◆ interpolation()

◆ isValid()

◆ length()

◆ middleOffset()

◆ mirrorSegment()

◆ setColorInterpolation()

◆ setEndColor()

◆ setEndOffset()

◆ setEndType()

◆ setInterpolation()

◆ setMiddleOffset()

◆ setStartColor()

◆ setStartOffset()

◆ setStartType()

◆ setVariableColors()

◆ startColor()

◆ startOffset()

◆ startType()

Member Data Documentation

◆ m_colorInterpolator

◆ m_end

◆ m_hasVariableColors

◆ m_interpolator

◆ m_length

◆ m_middleOffset

◆ m_middleT

◆ m_start