KisHSVCurveAdjustment< _channel_type_, traits > Class Template Reference

Inheritance diagram for KisHSVCurveAdjustment< _channel_type_, traits >:

Public Member Functions
	KisHSVCurveAdjustment ()
float	lookupComponent (float x, float max) const
int	parameterId (const QString &name) const override
QList< QString >	parameters () const override
void	setParameter (int id, const QVariant &parameter) override
void	transform (const quint8 *srcU8, quint8 *dstU8, qint32 nPixels) const override
Public Member Functions inherited from KoColorTransformation
virtual bool	isValid () const
void	setParameters (const QHash< QString, QVariant > &parameters)
virtual	~KoColorTransformation ()

Public Attributes
const float	SCALE_FROM_16BIT = 1.0f / 0xFFFF

Private Types
enum	ParameterID {   PAR_CURVE , PAR_CHANNEL , PAR_DRIVER_CHANNEL , PAR_RELATIVE ,   PAR_LUMA_R , PAR_LUMA_G , PAR_LUMA_B }
typedef RGBTrait::Pixel	RGBPixel
typedef traits	RGBTrait

Private Attributes
int	m_channel = 0
QVector< quint16 >	m_curve
int	m_driverChannel = 0
qreal	m_lumaBlue
qreal	m_lumaGreen
qreal	m_lumaRed
bool	m_relative = false

Detailed Description

template<typename _channel_type_, typename traits>
class KisHSVCurveAdjustment< _channel_type_, traits >

Definition at line 638 of file kis_hsv_adjustment.cpp.

Member Typedef Documentation

RGBPixel

template<typename _channel_type_ , typename traits >

typedef RGBTrait::Pixel KisHSVCurveAdjustment< _channel_type_, traits >::RGBPixel

private

Definition at line 641 of file kis_hsv_adjustment.cpp.

RGBTrait

template<typename _channel_type_ , typename traits >

typedef traits KisHSVCurveAdjustment< _channel_type_, traits >::RGBTrait

private

Definition at line 640 of file kis_hsv_adjustment.cpp.

Member Enumeration Documentation

ParameterID

template<typename _channel_type_ , typename traits >

enum KisHSVCurveAdjustment::ParameterID

private

Enumerator
PAR_CURVE
PAR_CHANNEL
PAR_DRIVER_CHANNEL
PAR_RELATIVE
PAR_LUMA_R
PAR_LUMA_G
PAR_LUMA_B

Definition at line 818 of file kis_hsv_adjustment.cpp.

    {
        PAR_CURVE,
        PAR_CHANNEL,
        PAR_DRIVER_CHANNEL,
        PAR_RELATIVE,
        PAR_LUMA_R,
        PAR_LUMA_G,
        PAR_LUMA_B,
    };

Constructor & Destructor Documentation

KisHSVCurveAdjustment()

template<typename _channel_type_ , typename traits >

KisHSVCurveAdjustment< _channel_type_, traits >::KisHSVCurveAdjustment ( )

inline

Definition at line 644 of file kis_hsv_adjustment.cpp.

                            :
        m_lumaRed(0.0),
        m_lumaGreen(0.0),
        m_lumaBlue(0.0)
    {}

Member Function Documentation

lookupComponent()

template<typename _channel_type_ , typename traits >

float KisHSVCurveAdjustment< _channel_type_, traits >::lookupComponent ( float x, float max ) const

inline

Definition at line 796 of file kis_hsv_adjustment.cpp.

    {
        // No curve for this component? Pass through unmodified
        if (max < 2) return x;
        if (x < 0) return m_curve[0];
 
        float lookup = x * max;
        float base = floor(lookup);
        float offset = lookup - base;
 
        if (base >= max) {
            base = max - 1.0f;
            offset = 1.0f;
        }
        int index = (int)base;
 
        return (1.0f - offset) * m_curve[index]
                     + offset  * m_curve[index + 1];
    }

References KisHSVCurveAdjustment< _channel_type_, traits >::m_curve.

parameterId()

template<typename _channel_type_ , typename traits >

int KisHSVCurveAdjustment< _channel_type_, traits >::parameterId ( const QString & name ) const

inlineoverridevirtual

Get the parameter id for a parameter name

Reimplemented from KoColorTransformation.

Definition at line 657 of file kis_hsv_adjustment.cpp.

    {
        if (name == "curve") {
            return PAR_CURVE;
        } else if (name == "channel") {
            return PAR_CHANNEL;
        } else if (name == "driverChannel") {
            return PAR_DRIVER_CHANNEL;
        } else if (name == "relative") {
            return PAR_RELATIVE;
        } else if (name == "lumaRed") {
            return PAR_LUMA_R;
        } else if (name == "lumaGreen") {
            return PAR_LUMA_G;
        } else if (name == "lumaBlue") {
            return PAR_LUMA_B;
        }
        return -1;
    }

References KisHSVCurveAdjustment< _channel_type_, traits >::PAR_CHANNEL, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_CURVE, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_DRIVER_CHANNEL, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_LUMA_B, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_LUMA_G, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_LUMA_R, and KisHSVCurveAdjustment< _channel_type_, traits >::PAR_RELATIVE.

parameters()

template<typename _channel_type_ , typename traits >

QList< QString > KisHSVCurveAdjustment< _channel_type_, traits >::parameters ( ) const

inlineoverridevirtual

Returns

the list of parameters

Reimplemented from KoColorTransformation.

Definition at line 650 of file kis_hsv_adjustment.cpp.

    {
      QList<QString> list;
      list << "curve" << "channel" << "driverChannel" << "relative" << "lumaRed" << "lumaGreen"<< "lumaBlue";
      return list;
    }

setParameter()

template<typename _channel_type_ , typename traits >

void KisHSVCurveAdjustment< _channel_type_, traits >::setParameter ( int id, const QVariant & parameter )

inlineoverridevirtual

curve: adjustment curve as QVector<quin16> channel: which channel to adjust. See KisHSVCurve::ColorChannel. driverChannel: which channel to use as source for adjustments. relative: false: use curve for direct lookup. true: add adjustment to original. In this mode, the curve range is mapped to -1.0 to 1.0 luma Red/Green/Blue: Used for luma calculations.

Reimplemented from KoColorTransformation.

Definition at line 686 of file kis_hsv_adjustment.cpp.

    {
        switch(id)
        {
        case PAR_CURVE:
            m_curve = parameter.value<QVector<quint16>>();
            break;
        case PAR_CHANNEL:
        case PAR_DRIVER_CHANNEL: {
            int channel = parameter.toInt();
            KIS_ASSERT_RECOVER_RETURN(0 <= channel && channel < KisHSVCurve::ChannelCount && "Invalid channel. Ignored!");
 
            if (id == PAR_CHANNEL) {
                m_channel = channel;
            } else {
                m_driverChannel = channel;
            }
            } break;
        case PAR_RELATIVE:
            m_relative = parameter.toBool();
            break;
        case PAR_LUMA_R:
            m_lumaRed = parameter.toDouble();
            break;
        case PAR_LUMA_G:
            m_lumaGreen = parameter.toDouble();
            break;
        case PAR_LUMA_B:
            m_lumaBlue = parameter.toDouble();
            break;
        default:
            KIS_ASSERT_RECOVER_NOOP(false && "Unknown parameter ID. Ignored!");
        }
    }

References KisHSVCurve::ChannelCount, KIS_ASSERT_RECOVER_NOOP, KIS_ASSERT_RECOVER_RETURN, KisHSVCurveAdjustment< _channel_type_, traits >::m_channel, KisHSVCurveAdjustment< _channel_type_, traits >::m_curve, KisHSVCurveAdjustment< _channel_type_, traits >::m_driverChannel, KisHSVCurveAdjustment< _channel_type_, traits >::m_lumaBlue, KisHSVCurveAdjustment< _channel_type_, traits >::m_lumaGreen, KisHSVCurveAdjustment< _channel_type_, traits >::m_lumaRed, KisHSVCurveAdjustment< _channel_type_, traits >::m_relative, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_CHANNEL, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_CURVE, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_DRIVER_CHANNEL, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_LUMA_B, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_LUMA_G, KisHSVCurveAdjustment< _channel_type_, traits >::PAR_LUMA_R, and KisHSVCurveAdjustment< _channel_type_, traits >::PAR_RELATIVE.

transform()

template<typename _channel_type_ , typename traits >

void KisHSVCurveAdjustment< _channel_type_, traits >::transform ( const quint8 * src, quint8 * dst, qint32 nPixels ) const

inlineoverridevirtual

This function apply the transformation on a given number of pixels.

Parameters

src	a pointer to the source pixels
dst	a pointer to the destination pixels
nPixels	the number of pixels

This function may or may not be thread safe. You need to create one KoColorTransformation per thread.

Implements KoColorTransformation.

Definition at line 722 of file kis_hsv_adjustment.cpp.

    {
        const RGBPixel* src = reinterpret_cast<const RGBPixel*>(srcU8);
        RGBPixel* dst = reinterpret_cast<RGBPixel*>(dstU8);
        float max = m_curve.size() - 1;
 
        int driverChannel = m_relative ? m_driverChannel : m_channel;
 
        float component[KisHSVCurve::ChannelCount];
 
        // Aliases for convenience
        float &h = component[KisHSVCurve::Hue];
        float &s = component[KisHSVCurve::Saturation];
        float &v = component[KisHSVCurve::Value];
        float &r = component[traits::red_pos];
        float &g = component[traits::green_pos];
        float &b = component[traits::blue_pos];
        float &a = component[KisHSVCurve::Alpha];
 
        while (nPixels > 0) {
            r = SCALE_TO_FLOAT(src->red);
            g = SCALE_TO_FLOAT(src->green);
            b = SCALE_TO_FLOAT(src->blue);
            a = SCALE_TO_FLOAT(src->alpha);
 
            RGBToHSV(r, g, b, &h, &s, &v);
 
            // Normalize hue to 0.0 to 1.0 range
            h /= 360.0f;
 
            float adjustment = lookupComponent(component[driverChannel], max) * SCALE_FROM_16BIT;
 
            if (m_relative) {
                // Curve uses range 0.0 to 1.0, but for adjustment we need -1.0 to 1.0
                adjustment = 2.0f * adjustment - 1.0f;
 
                if (m_channel == KisHSVCurve::AllColors) {
                    r += adjustment;
                    g += adjustment;
                    b += adjustment;
                } else {
                    component[m_channel] += adjustment;
                }
            } else {
                if (m_channel == KisHSVCurve::AllColors) {
                    r = b = g = adjustment;
                } else {
                    component[m_channel] = adjustment;
                }
            }
 
            h *= 360.0f;
            if (h > 360) h -= 360;
            if (h < 0) h += 360;
 
            if (m_channel >= KisHSVCurve::Hue) {
                HSVToRGB(h, s, v, &r, &g, &b);
            }
 
            clamp< _channel_type_ >(&r, &g, &b);
            FLOAT_CLAMP(&a);
 
            dst->red = SCALE_FROM_FLOAT(r);
            dst->green = SCALE_FROM_FLOAT(g);
            dst->blue = SCALE_FROM_FLOAT(b);
            dst->alpha = SCALE_FROM_FLOAT(a);
 
            --nPixels;
            ++src;
            ++dst;
        }
    }

References KisHSVCurve::AllColors, KisHSVCurve::Alpha, KisHSVCurve::ChannelCount, FLOAT_CLAMP, HSVToRGB(), KisHSVCurve::Hue, KisHSVCurveAdjustment< _channel_type_, traits >::lookupComponent(), KisHSVCurveAdjustment< _channel_type_, traits >::m_channel, KisHSVCurveAdjustment< _channel_type_, traits >::m_curve, KisHSVCurveAdjustment< _channel_type_, traits >::m_driverChannel, KisHSVCurveAdjustment< _channel_type_, traits >::m_relative, RGBToHSV(), KisHSVCurve::Saturation, KisHSVCurveAdjustment< _channel_type_, traits >::SCALE_FROM_16BIT, SCALE_FROM_FLOAT, SCALE_TO_FLOAT, v, and KisHSVCurve::Value.

Member Data Documentation

m_channel

template<typename _channel_type_ , typename traits >

int KisHSVCurveAdjustment< _channel_type_, traits >::m_channel = 0

private

Definition at line 830 of file kis_hsv_adjustment.cpp.

m_curve

template<typename _channel_type_ , typename traits >

QVector<quint16> KisHSVCurveAdjustment< _channel_type_, traits >::m_curve

private

Definition at line 829 of file kis_hsv_adjustment.cpp.

m_driverChannel

template<typename _channel_type_ , typename traits >

int KisHSVCurveAdjustment< _channel_type_, traits >::m_driverChannel = 0

private

Definition at line 831 of file kis_hsv_adjustment.cpp.

m_lumaBlue

template<typename _channel_type_ , typename traits >

qreal KisHSVCurveAdjustment< _channel_type_, traits >::m_lumaBlue

private

Definition at line 837 of file kis_hsv_adjustment.cpp.

m_lumaGreen

template<typename _channel_type_ , typename traits >

qreal KisHSVCurveAdjustment< _channel_type_, traits >::m_lumaGreen

private

Definition at line 837 of file kis_hsv_adjustment.cpp.

m_lumaRed

template<typename _channel_type_ , typename traits >

qreal KisHSVCurveAdjustment< _channel_type_, traits >::m_lumaRed

private

Definition at line 837 of file kis_hsv_adjustment.cpp.

m_relative

template<typename _channel_type_ , typename traits >

bool KisHSVCurveAdjustment< _channel_type_, traits >::m_relative = false

private

Definition at line 832 of file kis_hsv_adjustment.cpp.

SCALE_FROM_16BIT

template<typename _channel_type_ , typename traits >

const float KisHSVCurveAdjustment< _channel_type_, traits >::SCALE_FROM_16BIT = 1.0f / 0xFFFF

Definition at line 721 of file kis_hsv_adjustment.cpp.

---

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

• plugins/color/colorspaceextensions/kis_hsv_adjustment.cpp