KisCubicCurve Class Reference

#include <kis_cubic_curve.h>

Inheritance diagram for KisCubicCurve:

Public Member Functions
int	addPoint (const KisCubicCurvePoint &point)
int	addPoint (const QPointF &position)
int	addPoint (const QPointF &position, bool setAsCorner)
const QList< KisCubicCurvePoint > &	curvePoints () const
	Data ()
	Data (const Data &data)
const QVector< qreal >	floatTransfer (int size=256) const
Q_DECL_DEPRECATED void	fromString (const QString &)
void	invalidate ()
bool	isConstant (qreal c) const
bool	isIdentity () const
void	keepSorted ()
	KisCubicCurve ()
	KisCubicCurve (const KisCubicCurve &curve)
	KisCubicCurve (const QList< KisCubicCurvePoint > &points)
	KisCubicCurve (const QList< QPointF > &points)
	KisCubicCurve (const QString &curveString)
const QString &	name () const
KisCubicCurve &	operator= (const KisCubicCurve &curve)
bool	operator== (const KisCubicCurve &curve) const
Q_DECL_DEPRECATED QList< QPointF >	points () const
void	removePoint (int idx)
void	setName (const QString &name)
void	setPoint (int idx, const KisCubicCurvePoint &point)
void	setPoint (int idx, const QPointF &position)
void	setPoint (int idx, const QPointF &position, bool setAsCorner)
void	setPointAsCorner (int idx, bool setAsCorner)
void	setPointPosition (int idx, const QPointF &position)
void	setPoints (const QList< KisCubicCurvePoint > &points)
void	setPoints (const QList< QPointF > &points)
QString	toString () const
const QVector< quint16 >	uint16Transfer (int size=256) const
void	updateSpline ()
template<typename _T_ , typename _T2_ >
void	updateTransfer (QVector< _T_ > *transfer, bool &valid, _T2_ min, _T2_ max, int size)
qreal	value (qreal x)
qreal	value (qreal x) const
	~Data ()
	~KisCubicCurve ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Static Public Member Functions
static qreal	interpolateLinear (qreal normalizedValue, const QVector< qreal > &transfer)

Public Attributes
QSharedDataPointer< Data >	data
QVector< qreal >	fTransfer
QString	name
QList< KisCubicCurvePoint >	points
KisCubicSpline< KisCubicCurvePoint, qreal >	spline
QVector< quint16 >	u16Transfer
QVector< quint8 >	u8Transfer
bool	validFTransfer {false}
bool	validSpline {false}
bool	validU16Transfer {false}
bool	validU8Transfer {false}
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Attributes
Private *const	d {nullptr}

Detailed Description

Hold the data for a cubic curve.

Definition at line 76 of file kis_cubic_curve.cpp.

Constructor & Destructor Documentation

~Data()

KisCubicCurve::~Data ( )

inline

Definition at line 83 of file kis_cubic_curve.cpp.

            {
    }

KisCubicCurve() [1/5]

KisCubicCurve::KisCubicCurve

(

)

Definition at line 158 of file kis_cubic_curve.cpp.

    : d(new Private)
{
    d->data = new Data;
    d->data->points.append({ 0.0, 0.0, false });
    d->data->points.append({ 1.0, 1.0, false });
}

References d, and Data().

KisCubicCurve() [2/5]

KisCubicCurve::KisCubicCurve

(

const QList< QPointF > &

points

)

Definition at line 166 of file kis_cubic_curve.cpp.

    : d(new Private)
{
    d->data = new Data;
    d->data->points.reserve(points.size());
    Q_FOREACH(const QPointF p, points) {
        d->data->points.append({ p, false });
    }
    d->data->keepSorted();
}

References d, Data(), p, and points.

KisCubicCurve() [3/5]

KisCubicCurve::KisCubicCurve

(

const QList< KisCubicCurvePoint > &

points

)

Definition at line 177 of file kis_cubic_curve.cpp.

    : d(new Private)
{
    d->data = new Data;
    d->data->points = points;
    d->data->keepSorted();
}

References d, Data(), and points.

KisCubicCurve() [4/5]

KisCubicCurve::KisCubicCurve

(

const QString &

curveString

)

Definition at line 190 of file kis_cubic_curve.cpp.

    : d(new Private)
{
    // Curve string format: a semi-colon separated list of point entries.
    // Previous point entry format: a pair of numbers, separated by a comma,
    //      that represent the x and y coordinates of the point, in that order.
    //      Examples: identity "0.0,0.0;1.0,1.0;"
    //                U-shaped curve "0.0,1.0;0.5,0.0;1.0,1.0"
    // New point entry format: a list of comma separated point properties. The
    //      first and second properties are required and should be numbers
    //      that represent the x and y coordinates of the point, in that order.
    //      After those, some optional properties/flags may be present or not.
    //      If there are no optional properties for any point entry, then the
    //      format of the string is identical to the old one.
    //      Currently, only the "is_corner" flag is supported. All other
    //      present optional properties are ignored.
    //      Examples: identity "0.0,0.0;1.0,1.0;"
    //                V-shaped curve "0.0,1.0;0.5,0.0,is_corner;1.0,1.0"
 
    d->data = new Data;
 
    KIS_SAFE_ASSERT_RECOVER(!curveString.isEmpty()) {
        *this = KisCubicCurve();
        return;
    }
 
    const QStringList data = curveString.split(';', Qt::SkipEmptyParts);
 
    QList<KisCubicCurvePoint> points;
    Q_FOREACH (const QString &entry, data) {
        const QStringList entryData = entry.split(',', Qt::SkipEmptyParts);
        KIS_SAFE_ASSERT_RECOVER(entryData.size() > 1) {
            *this = KisCubicCurve();
            return;
        }
        bool ok;
        const qreal x = KisDomUtils::toDouble(entryData[0], &ok);
        KIS_SAFE_ASSERT_RECOVER(ok) {
            *this = KisCubicCurve();
            return;
        }
        const qreal y = KisDomUtils::toDouble(entryData[1], &ok);
        KIS_SAFE_ASSERT_RECOVER(ok) {
            *this = KisCubicCurve();
            return;
        }
        bool isCorner = false;
        for (int i = 2; i < entryData.size(); ++i) {
            if (entryData[i] == "is_corner") {
                isCorner = true;
            }
        }
        points.append({ x, y, isCorner });
    }
 
    setPoints(points);
}

References d, Data(), data, KIS_SAFE_ASSERT_RECOVER, KisCubicCurve(), points, setPoints(), and KisDomUtils::toDouble().

KisCubicCurve() [5/5]

KisCubicCurve::KisCubicCurve

(

const KisCubicCurve &

curve

)

Definition at line 185 of file kis_cubic_curve.cpp.

    : d(new Private(*curve.d))
{
}

~KisCubicCurve()

KisCubicCurve::~KisCubicCurve

(

)

Definition at line 248 of file kis_cubic_curve.cpp.

{
    delete d;
}

References d.

Member Function Documentation

addPoint() [1/3]

int KisCubicCurve::addPoint

(

const KisCubicCurvePoint &

point

)

Add a point to the curve, the list of point is always sorted.

Returns

the index of the inserted point

Definition at line 337 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points.append(point);
    d->data->keepSorted();
    d->data->invalidate();
 
    return d->data->points.indexOf(point);
}

References d.

addPoint() [2/3]

int KisCubicCurve::addPoint

(

const QPointF &

position

)

Definition at line 352 of file kis_cubic_curve.cpp.

{
    return addPoint({ position, false });
}

References addPoint().

addPoint() [3/3]

int KisCubicCurve::addPoint	(	const QPointF &	position,
		bool	setAsCorner )

Definition at line 347 of file kis_cubic_curve.cpp.

{
    return addPoint({ position, setAsCorner });
}

References addPoint().

curvePoints()

const QList< KisCubicCurvePoint > & KisCubicCurve::curvePoints

(

)

const

Definition at line 282 of file kis_cubic_curve.cpp.

{
    return d->data->points;
}

References d.

Data() [1/2]

KisCubicCurve::Data ( )

inline

Definition at line 77 of file kis_cubic_curve.cpp.

           {
    }

Data() [2/2]

KisCubicCurve::Data ( const Data & data )

inline

Definition at line 79 of file kis_cubic_curve.cpp.

                           : QSharedData() {
        points = data.points;
        name = data.name;
    }

floatTransfer()

const QVector< qreal > KisCubicCurve::floatTransfer

(

int

size = 256

)

const

Definition at line 468 of file kis_cubic_curve.cpp.

{
    d->data->updateTransfer<qreal, qreal>(&d->data->fTransfer, d->data->validFTransfer, 0.0, 1.0, size);
    return d->data->fTransfer;
}

References d.

fromString()

void KisCubicCurve::fromString

(

const QString &

string

)

Definition at line 457 of file kis_cubic_curve.cpp.

{
    *this = KisCubicCurve(string);
}

References KisCubicCurve().

interpolateLinear()

qreal KisCubicCurve::interpolateLinear ( qreal normalizedValue, const QVector< qreal > & transfer )

static

Definition at line 400 of file kis_cubic_curve.cpp.

{
    const qreal maxValue = transfer.size() - 1;
 
    const qreal bilinearX = qBound(0.0, maxValue * normalizedValue, maxValue);
    const qreal xFloored = std::floor(bilinearX);
    const qreal xCeiled = std::ceil(bilinearX);
 
    const qreal t = bilinearX - xFloored;
 
    constexpr qreal eps = 1e-6;
 
    qreal newValue = normalizedValue;
 
    if (t < eps) {
        newValue = transfer[int(xFloored)];
    } else if (t > (1.0 - eps)) {
        newValue = transfer[int(xCeiled)];
    } else {
        qreal a = transfer[int(xFloored)];
        qreal b = transfer[int(xCeiled)];
 
        newValue = a + t * (b - a);
    }
 
    return KisAlgebra2D::copysign(newValue, normalizedValue);
}

References KisAlgebra2D::copysign(), and eps.

invalidate()

void KisCubicCurve::invalidate

(

)

isConstant()

bool KisCubicCurve::isConstant

(

qreal

c

)

const

Definition at line 382 of file kis_cubic_curve.cpp.

{
    const QList<KisCubicCurvePoint> &points = d->data->points;
 
    Q_FOREACH (const KisCubicCurvePoint &pt, points) {
        if (!qFuzzyCompare(c, pt.y())) {
            return false;
        }
    }
 
    return true;
}

References d, points, qFuzzyCompare(), and KisCubicCurvePoint::y().

isIdentity()

bool KisCubicCurve::isIdentity

(

)

const

Definition at line 364 of file kis_cubic_curve.cpp.

{
    const QList<KisCubicCurvePoint> &points = d->data->points;
 
    if (points.first().x() != 0.0 || points.first().y() != 0.0 ||
        points.last().x() != 1.0 || points.last().y() != 1.0) {
        return false;
    }
 
    for (int i = 1; i < points.size() - 1; i++) {
        if (!qFuzzyCompare(points[i].x(), points[i].y())) {
            return false;
        }
    }
 
    return true;
}

References d, points, and qFuzzyCompare().

keepSorted()

void KisCubicCurve::keepSorted

(

)

name()

const QString & KisCubicCurve::name

(

)

const

operator=()

KisCubicCurve & KisCubicCurve::operator=

(

const KisCubicCurve &

curve

)

Definition at line 253 of file kis_cubic_curve.cpp.

{
    if (&curve != this) {
        *d = *curve.d;
    }
    return *this;
}

References d.

operator==()

bool KisCubicCurve::operator==

(

const KisCubicCurve &

curve

)

const

Definition at line 261 of file kis_cubic_curve.cpp.

{
    if (d->data == curve.d->data) return true;
    return d->data->points == curve.d->data->points;
}

References d.

points()

Q_DECL_DEPRECATED QList< QPointF > KisCubicCurve::points

(

)

const

Deprecated. Use curvePoints instead

removePoint()

void KisCubicCurve::removePoint

(

int

idx

)

Definition at line 357 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points.removeAt(idx);
    d->data->invalidate();
}

References d.

setName()

void KisCubicCurve::setName

(

const QString &

name

)

This allows us to carry around a display name for the curve internally. It is used currently in Sketch for perchannel, but would potentially be useful anywhere curves are used in the UI

Definition at line 428 of file kis_cubic_curve.cpp.

{
    d->data->name = name;
}

References d, and name.

setPoint() [1/3]

void KisCubicCurve::setPoint	(	int	idx,
		const KisCubicCurvePoint &	point )

Definition at line 304 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points[idx] = point;
    d->data->keepSorted();
    d->data->invalidate();
}

References d.

setPoint() [2/3]

void KisCubicCurve::setPoint	(	int	idx,
		const QPointF &	position )

Definition at line 317 of file kis_cubic_curve.cpp.

{
    setPointPosition(idx, position);
}

References setPointPosition().

setPoint() [3/3]

void KisCubicCurve::setPoint	(	int	idx,
		const QPointF &	position,
		bool	setAsCorner )

Definition at line 312 of file kis_cubic_curve.cpp.

{
    setPoint(idx, { position, setAsCorner });
}

References setPoint().

setPointAsCorner()

void KisCubicCurve::setPointAsCorner	(	int	idx,
		bool	setAsCorner )

Definition at line 330 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points[idx].setAsCorner(setAsCorner);
    d->data->invalidate();
}

References d.

setPointPosition()

void KisCubicCurve::setPointPosition	(	int	idx,
		const QPointF &	position )

Definition at line 322 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points[idx].setPosition(position);
    d->data->keepSorted();
    d->data->invalidate();
}

References d.

setPoints() [1/2]

void KisCubicCurve::setPoints

(

const QList< KisCubicCurvePoint > &

points

)

Definition at line 297 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points = points;
    d->data->invalidate();
}

References d, and points.

setPoints() [2/2]

void KisCubicCurve::setPoints

(

const QList< QPointF > &

points

)

Definition at line 287 of file kis_cubic_curve.cpp.

{
    d->data.detach();
    d->data->points.clear();
    Q_FOREACH(const QPointF &p, points) {
        d->data->points.append({ p, false });
    }
    d->data->invalidate();
}

References d, p, and points.

toString()

QString KisCubicCurve::toString

(

)

const

Definition at line 433 of file kis_cubic_curve.cpp.

{
    // See comments in KisCubicCurve(const QString &curveString) for the
    // specification of the string format
    
    QString sCurve;
 
    if(d->data->points.count() < 1)
        return sCurve;
 
    Q_FOREACH (const KisCubicCurvePoint &point, d->data->points) {
        sCurve += QString::number(point.x());
        sCurve += ',';
        sCurve += QString::number(point.y());
        if (point.isSetAsCorner()) {
            sCurve += ',';
            sCurve += "is_corner";
        }
        sCurve += ';';
    }
 
    return sCurve;
}

References d, KisCubicCurvePoint::isSetAsCorner(), KisCubicCurvePoint::x(), and KisCubicCurvePoint::y().

uint16Transfer()

const QVector< quint16 > KisCubicCurve::uint16Transfer

(

int

size = 256

)

const

Definition at line 462 of file kis_cubic_curve.cpp.

{
    d->data->updateTransfer<quint16, int>(&d->data->u16Transfer, d->data->validU16Transfer, 0x0, 0xFFFF, size);
    return d->data->u16Transfer;
}

References d.

updateSpline()

void KisCubicCurve::updateSpline

(

)

updateTransfer()

template<typename _T_ , typename _T2_ >

void KisCubicCurve::updateTransfer	(	QVector< _T_ > *	transfer,
		bool &	valid,
		_T2_	min,
		_T2_	max,
		int	size )

value() [1/2]

qreal KisCubicCurve::value

(

qreal

x

)

value() [2/2]

qreal KisCubicCurve::value

(

qreal

x

)

const

Definition at line 267 of file kis_cubic_curve.cpp.

{
    qreal value = d->data->value(x);
    return value;
}

References d, and value().

Member Data Documentation

d

Private* const KisCubicCurve::d {nullptr}

private

Definition at line 119 of file kis_cubic_curve.h.

{nullptr};

data

QSharedDataPointer<Data> KisCubicCurve::data

Definition at line 155 of file kis_cubic_curve.cpp.

fTransfer

QVector<qreal> KisCubicCurve::fTransfer

mutable

Definition at line 94 of file kis_cubic_curve.cpp.

name

const QString & KisCubicCurve::name

mutable

Definition at line 86 of file kis_cubic_curve.cpp.

points

QList< QPointF > KisCubicCurve::points

Definition at line 88 of file kis_cubic_curve.cpp.

spline

KisCubicSpline<KisCubicCurvePoint, qreal> KisCubicCurve::spline

mutable

Definition at line 87 of file kis_cubic_curve.cpp.

u16Transfer

QVector<quint16> KisCubicCurve::u16Transfer

mutable

Definition at line 92 of file kis_cubic_curve.cpp.

u8Transfer

QVector<quint8> KisCubicCurve::u8Transfer

mutable

Definition at line 90 of file kis_cubic_curve.cpp.

validFTransfer

bool KisCubicCurve::validFTransfer {false}

mutable

Definition at line 95 of file kis_cubic_curve.cpp.

{false};

validSpline

bool KisCubicCurve::validSpline {false}

mutable

Definition at line 89 of file kis_cubic_curve.cpp.

{false};

validU16Transfer

bool KisCubicCurve::validU16Transfer {false}

mutable

Definition at line 93 of file kis_cubic_curve.cpp.

{false};

validU8Transfer

bool KisCubicCurve::validU8Transfer {false}

mutable

Definition at line 91 of file kis_cubic_curve.cpp.

{false};

---

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

• libs/image/kis_cubic_curve.cpp
• libs/image/kis_cubic_curve.h