KisCurveOption Class Reference

#include <kis_curve_option.h>

Inheritance diagram for KisCurveOption:

Classes
struct	ValueComponents

Public Member Functions
	KisCurveOption (const QString &name, KisPaintOpOption::PaintopCategory category, bool checked, qreal value=1.0, qreal min=0.0, qreal max=1.0)
virtual	~KisCurveOption ()
QList< KisDynamicSensorSP >	activeSensors () const
KisPaintOpOption::PaintopCategory	category () const
qreal	computeRotationLikeValue (const KisPaintInformation &info, qreal baseValue, bool absoluteAxesFlipped, qreal scalingPartCoeff, bool disableScalingPart) const
qreal	computeSizeLikeValue (const KisPaintInformation &info) const
ValueComponents	computeValueComponents (const KisPaintInformation &info) const
KisCubicCurve	defaultCurve ()
KisCubicCurve	emptyCurve ()
KisCubicCurve	getCommonCurve () const
int	getCurveMode () const
virtual int	intMaxValue () const
virtual int	intMinValue () const
bool	isCheckable ()
bool	isChecked () const
bool	isCurveUsed () const
bool	isRandom () const
bool	isSameCurveUsed () const
virtual void	lodLimitations (KisPaintopLodLimitations *l) const
qreal	maxValue () const
qreal	minValue () const
const QString &	name () const
virtual void	readOptionSetting (KisPropertiesConfigurationSP setting)
void	replaceSensor (KisDynamicSensorSP sensor)
void	resetAllSensors ()
KisDynamicSensorSP	sensor (DynamicSensorType sensorType, bool active) const
QList< KisDynamicSensorSP >	sensors ()
void	setChecked (bool checked)
void	setCommonCurve (KisCubicCurve curve)
void	setCurve (DynamicSensorType sensorType, bool useSameCurve, const KisCubicCurve &curve)
void	setCurveMode (int mode)
void	setCurveUsed (bool useCurve)
void	setSeparateCurveValue (bool separateCurveValue)
void	setUseSameCurve (bool useSameCurve)
void	setValue (qreal value)
qreal	value () const
virtual QString	valueSuffix () const
virtual void	writeOptionSetting (KisPropertiesConfigurationSP setting) const

Protected Member Functions
void	readNamedOptionSetting (const QString &prefix, const KisPropertiesConfigurationSP setting)
void	setValueRange (qreal min, qreal max)

Protected Attributes
KisPaintOpOption::PaintopCategory	m_category
bool	m_checkable
bool	m_checked
KisCubicCurve	m_commonCurve
int	m_curveMode
QString	m_name
QMap< DynamicSensorType, KisDynamicSensorSP >	m_sensorMap
bool	m_separateCurveValue
bool	m_useCurve
bool	m_useSameCurve

Detailed Description

KisCurveOption is the base class for paintop options that are defined through one or more curves.

Note: it is NOT a KisPaintOpOption, even though the API is pretty similar!

KisCurveOption classes have a generic GUI widget, KisCurveOptionWidget. So, in contrast to KisPaintOpOption classes, KisCurveOption instances can and will be created in the constructor of KisPaintOp paintops. This class can manage to read and write its settings directly.

Definition at line 47 of file kis_curve_option.h.

Constructor & Destructor Documentation

KisCurveOption()

KisCurveOption::KisCurveOption	(	const QString &	name,
		KisPaintOpOption::PaintopCategory	category,
		bool	checked,
		qreal	value = 1.0,
		qreal	min = 0.0,
		qreal	max = 1.0
	)

Definition at line 54 of file kis_curve_option.cpp.

~KisCurveOption()

KisCurveOption::~KisCurveOption ( )

virtual

Definition at line 79 of file kis_curve_option.cpp.

Member Function Documentation

activeSensors()

QList< KisDynamicSensorSP > KisCurveOption::activeSensors

(

)

const

Definition at line 504 of file kis_curve_option.cpp.

category()

KisPaintOpOption::PaintopCategory KisCurveOption::category

(

)

const

Definition at line 88 of file kis_curve_option.cpp.

computeRotationLikeValue()

qreal KisCurveOption::computeRotationLikeValue	(	const KisPaintInformation &	info,
		qreal	baseValue,
		bool	absoluteAxesFlipped,
		qreal	scalingPartCoeff,
		bool	disableScalingPart
	)		const

Definition at line 471 of file kis_curve_option.cpp.

computeSizeLikeValue()

qreal KisCurveOption::computeSizeLikeValue

(

const KisPaintInformation &

info

)

const

Definition at line 465 of file kis_curve_option.cpp.

computeValueComponents()

KisCurveOption::ValueComponents KisCurveOption::computeValueComponents

(

const KisPaintInformation &

info

)

const

Uses the curves set on the sensors to compute a single double value that can control the parameters of a brush.

This value is derives from the values stored in ValuesComponents object.

Definition at line 399 of file kis_curve_option.cpp.

defaultCurve()

KisCubicCurve KisCurveOption::defaultCurve

(

)

defaultCurve returns a curve that is set when the KisCurveOption is not initialized yet the purpose of distinguishing between this one and emptyCurve() is to allow easier finding out that something is wrong in the code setting common curves

Returns

a non-standard curve with two hills

Definition at line 477 of file kis_curve_option.cpp.

emptyCurve()

KisCubicCurve KisCurveOption::emptyCurve

(

)

emptyCurve returns the simplest usable curve

Returns

curve from (0, 0) to (1, 1)

Definition at line 490 of file kis_curve_option.cpp.

getCommonCurve()

KisCubicCurve KisCurveOption::getCommonCurve

(

)

const

Returns the curve that is being used instead of sensor ones in case "Use the same curve" is checked.

Definition at line 308 of file kis_curve_option.cpp.

getCurveMode()

int KisCurveOption::getCurveMode

(

)

const

Definition at line 303 of file kis_curve_option.cpp.

intMaxValue()

int KisCurveOption::intMaxValue ( ) const

virtual

Reimplemented in KisPressureHSVOption, and KisPressureRotationOption.

Definition at line 162 of file kis_curve_option.cpp.

intMinValue()

int KisCurveOption::intMinValue ( ) const

virtual

Reimplemented in KisPressureHSVOption, and KisPressureRotationOption.

Definition at line 157 of file kis_curve_option.cpp.

isCheckable()

bool KisCurveOption::isCheckable

(

)

Definition at line 318 of file kis_curve_option.cpp.

isChecked()

bool KisCurveOption::isChecked

(

)

const

Definition at line 323 of file kis_curve_option.cpp.

isCurveUsed()

bool KisCurveOption::isCurveUsed

(

)

const

Definition at line 293 of file kis_curve_option.cpp.

isRandom()

bool KisCurveOption::isRandom

(

)

const

Definition at line 287 of file kis_curve_option.cpp.

isSameCurveUsed()

bool KisCurveOption::isSameCurveUsed

(

)

const

Definition at line 298 of file kis_curve_option.cpp.

lodLimitations()

void KisCurveOption::lodLimitations ( KisPaintopLodLimitations *  l ) const

virtual

Reimplemented in KisPressureSizeOption.

Definition at line 152 of file kis_curve_option.cpp.

maxValue()

qreal KisCurveOption::maxValue

(

)

const

Definition at line 98 of file kis_curve_option.cpp.

minValue()

qreal KisCurveOption::minValue

(

)

const

Definition at line 93 of file kis_curve_option.cpp.

name()

const QString & KisCurveOption::name

(

)

const

Definition at line 83 of file kis_curve_option.cpp.

readNamedOptionSetting()

void KisCurveOption::readNamedOptionSetting ( const QString &  prefix, const KisPropertiesConfigurationSP  setting  )

protected

Read the option using the prefix in argument.

Definition at line 172 of file kis_curve_option.cpp.

readOptionSetting()

void KisCurveOption::readOptionSetting ( KisPropertiesConfigurationSP  setting )

virtual

Reimplemented in KisPressureMirrorOption, KisPressureSharpnessOption, KisPressureSpacingOption, KisPressureOpacityOption, KisPressureScatterOption, KisFlowOpacityOption, and KisPressureRotationOption.

Definition at line 147 of file kis_curve_option.cpp.

replaceSensor()

void KisCurveOption::replaceSensor

(

KisDynamicSensorSP

sensor

)

Definition at line 265 of file kis_curve_option.cpp.

resetAllSensors()

void KisCurveOption::resetAllSensors

(

)

Definition at line 108 of file kis_curve_option.cpp.

sensor()

KisDynamicSensorSP KisCurveOption::sensor	(	DynamicSensorType	sensorType,
		bool	active
	)		const

Definition at line 271 of file kis_curve_option.cpp.

sensors()

QList< KisDynamicSensorSP > KisCurveOption::sensors

(

)

Definition at line 498 of file kis_curve_option.cpp.

setChecked()

void KisCurveOption::setChecked

(

bool

checked

)

Definition at line 328 of file kis_curve_option.cpp.

setCommonCurve()

void KisCurveOption::setCommonCurve

(

KisCubicCurve

curve

)

Sets the curve that is being used instead of sensor ones in case "Share curve across all settings" is checked.

Definition at line 348 of file kis_curve_option.cpp.

setCurve()

void KisCurveOption::setCurve	(	DynamicSensorType	sensorType,
		bool	useSameCurve,
		const KisCubicCurve &	curve
	)

Definition at line 353 of file kis_curve_option.cpp.

setCurveMode()

void KisCurveOption::setCurveMode

(

int

mode

)

Definition at line 338 of file kis_curve_option.cpp.

setCurveUsed()

void KisCurveOption::setCurveUsed

(

bool

useCurve

)

Definition at line 333 of file kis_curve_option.cpp.

setSeparateCurveValue()

void KisCurveOption::setSeparateCurveValue

(

bool

separateCurveValue

)

Definition at line 313 of file kis_curve_option.cpp.

setUseSameCurve()

void KisCurveOption::setUseSameCurve

(

bool

useSameCurve

)

Sets the bool indicating whether "Share curve across all settings" is checked.

Definition at line 343 of file kis_curve_option.cpp.

setValue()

void KisCurveOption::setValue

(

qreal

value

)

Definition at line 394 of file kis_curve_option.cpp.

setValueRange()

void KisCurveOption::setValueRange ( qreal  min, qreal  max  )

protected

Definition at line 388 of file kis_curve_option.cpp.

value()

qreal KisCurveOption::value

(

)

const

Definition at line 103 of file kis_curve_option.cpp.

valueSuffix()

QString KisCurveOption::valueSuffix ( ) const

virtual

Reimplemented in KisPressureHSVOption, and KisPressureRotationOption.

Definition at line 167 of file kis_curve_option.cpp.

writeOptionSetting()

void KisCurveOption::writeOptionSetting ( KisPropertiesConfigurationSP  setting ) const

virtual

Reimplemented in KisPressureMirrorOption, KisPressureSpacingOption, KisPressureSharpnessOption, KisPressureOpacityOption, KisPressureScatterOption, and KisFlowOpacityOption.

Definition at line 117 of file kis_curve_option.cpp.

Member Data Documentation

m_category

KisPaintOpOption::PaintopCategory KisCurveOption::m_category

protected

Definition at line 181 of file kis_curve_option.h.

m_checkable

bool KisCurveOption::m_checkable

protected

Definition at line 183 of file kis_curve_option.h.

m_checked

bool KisCurveOption::m_checked

protected

Definition at line 184 of file kis_curve_option.h.

m_commonCurve

KisCubicCurve KisCurveOption::m_commonCurve

protected

Curve that is being used instead of sensors' internal ones in case "Use the same curve" is checked.

Definition at line 193 of file kis_curve_option.h.

m_curveMode

int KisCurveOption::m_curveMode

protected

Definition at line 195 of file kis_curve_option.h.

m_name

QString KisCurveOption::m_name

protected

Definition at line 180 of file kis_curve_option.h.

m_sensorMap

QMap<DynamicSensorType, KisDynamicSensorSP> KisCurveOption::m_sensorMap

protected

Definition at line 197 of file kis_curve_option.h.

m_separateCurveValue

bool KisCurveOption::m_separateCurveValue

protected

Definition at line 187 of file kis_curve_option.h.

m_useCurve

bool KisCurveOption::m_useCurve

protected

Definition at line 185 of file kis_curve_option.h.

m_useSameCurve

bool KisCurveOption::m_useSameCurve

protected

Definition at line 186 of file kis_curve_option.h.

---

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

• kis_curve_option.h
• kis_curve_option.cpp