KisCurveOptionDataCommon Struct Reference

#include <KisCurveOptionDataCommon.h>

Inheritance diagram for KisCurveOptionDataCommon:

Public Types
using	ValueFixUpReadCallback = std::function<void (KisCurveOptionDataCommon *, const KisPropertiesConfiguration *)>
using	ValueFixUpWriteCallback = std::function<void (qreal, KisPropertiesConfiguration *)>

Public Member Functions
	KisCurveOptionDataCommon (const KoID &id, bool isCheckable, bool isChecked, qreal minValue, qreal maxValue, KisSensorPackInterface *sensorInterface)
	KisCurveOptionDataCommon (const QString &prefix, const KoID &id, bool isCheckable, bool isChecked, qreal minValue, qreal maxValue, KisSensorPackInterface *sensorInterface)
bool	read (const KisPropertiesConfiguration *setting)
std::vector< KisSensorData * >	sensors ()
std::vector< const KisSensorData * >	sensors () const
void	write (KisPropertiesConfiguration *setting) const

Public Attributes
QString	commonCurve = DEFAULT_CURVE_STRING
int	curveMode = 0
KoID	id
bool	isCheckable = true
bool	isChecked = true
QString	prefix
QSharedDataPointer< KisSensorPackInterface >	sensorData
qreal	strengthMaxValue = 1.0
qreal	strengthMinValue = 0.0
qreal	strengthValue = 1.0
bool	useCurve = true
bool	useSameCurve = true
ValueFixUpReadCallback	valueFixUpReadCallback
ValueFixUpWriteCallback	valueFixUpWriteCallback

Static Public Attributes
static constexpr bool	supports_prefix = true

Private Member Functions
bool	readPrefixed (const KisPropertiesConfiguration *setting)
void	writePrefixed (KisPropertiesConfiguration *setting) const

Friends
bool	operator== (const KisCurveOptionDataCommon &lhs, const KisCurveOptionDataCommon &rhs)

Detailed Description

Definition at line 19 of file KisCurveOptionDataCommon.h.

Member Typedef Documentation

ValueFixUpReadCallback

using KisCurveOptionDataCommon::ValueFixUpReadCallback = std::function<void (KisCurveOptionDataCommon *, const KisPropertiesConfiguration *)>

Definition at line 75 of file KisCurveOptionDataCommon.h.

ValueFixUpWriteCallback

using KisCurveOptionDataCommon::ValueFixUpWriteCallback = std::function<void (qreal, KisPropertiesConfiguration *)>

Definition at line 78 of file KisCurveOptionDataCommon.h.

Constructor & Destructor Documentation

KisCurveOptionDataCommon() [1/2]

KisCurveOptionDataCommon::KisCurveOptionDataCommon	(	const QString &	prefix,
		const KoID &	id,
		bool	isCheckable,
		bool	isChecked,
		qreal	minValue,
		qreal	maxValue,
		KisSensorPackInterface *	sensorInterface )

Definition at line 9 of file KisCurveOptionDataCommon.cpp.

    : id(_id),
      prefix(_prefix),
      isCheckable(_isCheckable),
      strengthMinValue(_minValue),
      strengthMaxValue(_maxValue),
      isChecked(_isChecked),
      strengthValue(_maxValue),
      sensorData(sensorInterface)
{
}

KisCurveOptionDataCommon() [2/2]

KisCurveOptionDataCommon::KisCurveOptionDataCommon	(	const KoID &	id,
		bool	isCheckable,
		bool	isChecked,
		qreal	minValue,
		qreal	maxValue,
		KisSensorPackInterface *	sensorInterface )

Definition at line 21 of file KisCurveOptionDataCommon.cpp.

    : KisCurveOptionDataCommon("", _id, _isCheckable, _isChecked, _minValue, _maxValue, sensorInterface)
{
}

Member Function Documentation

read()

bool KisCurveOptionDataCommon::read

(

const KisPropertiesConfiguration *

setting

)

Definition at line 37 of file KisCurveOptionDataCommon.cpp.

{
    if (!setting) return false;
 
    if (prefix.isEmpty()) {
        return readPrefixed(setting);
    } else {
        KisPropertiesConfiguration prefixedSetting;
        setting->getPrefixedProperties(prefix, &prefixedSetting);
        return readPrefixed(&prefixedSetting);
    }
}

References KisPropertiesConfiguration::getPrefixedProperties(), prefix, and readPrefixed().

readPrefixed()

bool KisCurveOptionDataCommon::readPrefixed ( const KisPropertiesConfiguration * setting )

private

Definition at line 61 of file KisCurveOptionDataCommon.cpp.

{
    return sensorData->read(*this, setting);
}

References sensorData.

sensors() [1/2]

std::vector< KisSensorData * > KisCurveOptionDataCommon::sensors

(

)

Definition at line 32 of file KisCurveOptionDataCommon.cpp.

{
    return sensorData->sensors();
}

References sensorData, and sensors().

sensors() [2/2]

std::vector< const KisSensorData * > KisCurveOptionDataCommon::sensors

(

)

const

Definition at line 27 of file KisCurveOptionDataCommon.cpp.

{
    return sensorData->constSensors();
}

References sensorData.

write()

void KisCurveOptionDataCommon::write

(

KisPropertiesConfiguration *

setting

)

const

Definition at line 50 of file KisCurveOptionDataCommon.cpp.

{
    if (prefix.isEmpty()) {
        writePrefixed(setting);
    } else {
        KisPropertiesConfiguration prefixedSetting;
        writePrefixed(&prefixedSetting);
        setting->setPrefixedProperties(prefix, &prefixedSetting);
    }
}

References prefix, KisPropertiesConfiguration::setPrefixedProperties(), and writePrefixed().

writePrefixed()

void KisCurveOptionDataCommon::writePrefixed ( KisPropertiesConfiguration * setting ) const

private

Definition at line 66 of file KisCurveOptionDataCommon.cpp.

{
    sensorData->write(*this, setting);
}

References sensorData.

Friends And Related Symbol Documentation

operator==

bool operator== ( const KisCurveOptionDataCommon & lhs, const KisCurveOptionDataCommon & rhs )

friend

Definition at line 38 of file KisCurveOptionDataCommon.h.

                                                                                                            {
        return lhs.id == rhs.id &&
                lhs.prefix == rhs.prefix &&
                lhs.isCheckable == rhs.isCheckable &&
                lhs.isChecked == rhs.isChecked &&
                lhs.useCurve == rhs.useCurve &&
                lhs.useSameCurve == rhs.useSameCurve &&
                lhs.curveMode == rhs.curveMode &&
                lhs.commonCurve == rhs.commonCurve &&
                lhs.strengthValue == rhs.strengthValue &&
                lhs.strengthMinValue == rhs.strengthMinValue &&
                lhs.strengthMaxValue == rhs.strengthMaxValue &&
                lhs.sensorData->compare(rhs.sensorData.constData());
    }

Member Data Documentation

commonCurve

QString KisCurveOptionDataCommon::commonCurve = DEFAULT_CURVE_STRING

Definition at line 64 of file KisCurveOptionDataCommon.h.

curveMode

int KisCurveOptionDataCommon::curveMode = 0

Definition at line 63 of file KisCurveOptionDataCommon.h.

id

KoID KisCurveOptionDataCommon::id

Definition at line 53 of file KisCurveOptionDataCommon.h.

isCheckable

bool KisCurveOptionDataCommon::isCheckable = true

Definition at line 55 of file KisCurveOptionDataCommon.h.

isChecked

bool KisCurveOptionDataCommon::isChecked = true

Definition at line 59 of file KisCurveOptionDataCommon.h.

prefix

QString KisCurveOptionDataCommon::prefix

Definition at line 54 of file KisCurveOptionDataCommon.h.

sensorData

QSharedDataPointer<KisSensorPackInterface> KisCurveOptionDataCommon::sensorData

Definition at line 67 of file KisCurveOptionDataCommon.h.

strengthMaxValue

qreal KisCurveOptionDataCommon::strengthMaxValue = 1.0

Definition at line 57 of file KisCurveOptionDataCommon.h.

strengthMinValue

qreal KisCurveOptionDataCommon::strengthMinValue = 0.0

Definition at line 56 of file KisCurveOptionDataCommon.h.

strengthValue

qreal KisCurveOptionDataCommon::strengthValue = 1.0

Definition at line 65 of file KisCurveOptionDataCommon.h.

supports_prefix

constexpr bool KisCurveOptionDataCommon::supports_prefix = true

staticconstexpr

Definition at line 21 of file KisCurveOptionDataCommon.h.

useCurve

bool KisCurveOptionDataCommon::useCurve = true

Definition at line 60 of file KisCurveOptionDataCommon.h.

useSameCurve

bool KisCurveOptionDataCommon::useSameCurve = true

Definition at line 61 of file KisCurveOptionDataCommon.h.

valueFixUpReadCallback

ValueFixUpReadCallback KisCurveOptionDataCommon::valueFixUpReadCallback

Definition at line 76 of file KisCurveOptionDataCommon.h.

valueFixUpWriteCallback

ValueFixUpWriteCallback KisCurveOptionDataCommon::valueFixUpWriteCallback

Definition at line 79 of file KisCurveOptionDataCommon.h.

---

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

• plugins/paintops/libpaintop/KisCurveOptionDataCommon.h
• plugins/paintops/libpaintop/KisCurveOptionDataCommon.cpp