KisDynamicSensor Class Reference

#include <kis_dynamic_sensor.h>

Inheritance diagram for KisDynamicSensor:

Public Types
enum	ParameterSign { NegativeParameter = -1, UnSignedParameter = 0, PositiveParameter = 1 }

Public Member Functions
	~KisDynamicSensor () override
virtual QWidget *	createConfigurationWidget (QWidget *parent, QWidget *selector)
const KisCubicCurve &	curve () const
virtual bool	dependsOnCanvasRotation () const
void	fromXML (const QDomElement &) override
bool	hasCustomCurve () const
virtual bool	isAbsoluteRotation () const
bool	isActive () const
virtual bool	isAdditive () const
int	length ()
qreal	parameter (const KisPaintInformation &info)
qreal	parameter (const KisPaintInformation &info, const KisCubicCurve curve, const bool customCurve)
void	removeCurve ()
virtual void	reset ()
DynamicSensorType	sensorType () const
void	setActive (bool active)
void	setCurve (const KisCubicCurve &curve)
void	toXML (QDomDocument &, QDomElement &) const override

Static Public Member Functions
static qreal	additiveToScaling (qreal x)
static KisDynamicSensorSP	createFromXML (const QDomElement &, const QString &parentOptionName)
static KisDynamicSensorSP	createFromXML (const QString &, const QString &parentOptionName)
static QString	id (DynamicSensorType sensorType)
static KisDynamicSensorSP	id2Sensor (const KoID &id, const QString &parentOptionName)
static KisDynamicSensorSP	id2Sensor (const QString &s, const QString &parentOptionName)
static DynamicSensorType	id2Type (const KoID &id)
static DynamicSensorType	id2Type (const QString &s)
static QString	maximumLabel (DynamicSensorType sensorType, int max=-1)
static int	maximumValue (DynamicSensorType sensorType, int max=-1)
static QString	minimumLabel (DynamicSensorType sensorType)
static int	minimumValue (DynamicSensorType sensorType)
static qreal	scalingToAdditive (qreal x)
static QList< KoID >	sensorsIds ()
static QList< DynamicSensorType >	sensorsTypes ()
static KisDynamicSensorSP	type2Sensor (DynamicSensorType sensorType, const QString &parentOptionName)
static QString	valueSuffix (DynamicSensorType sensorType)

Protected Member Functions
	KisDynamicSensor (DynamicSensorType type)
virtual qreal	value (const KisPaintInformation &info)=0

Protected Attributes
int	m_length

Detailed Description

Sensors are used to extract from KisPaintInformation a single double value which can be used to control the parameters of a brush.

Definition at line 96 of file kis_dynamic_sensor.h.

Member Enumeration Documentation

ParameterSign

enum KisDynamicSensor::ParameterSign

Enumerator
NegativeParameter
UnSignedParameter
PositiveParameter

Definition at line 100 of file kis_dynamic_sensor.h.

Constructor & Destructor Documentation

KisDynamicSensor()

KisDynamicSensor::KisDynamicSensor ( DynamicSensorType  type )

protected

Definition at line 32 of file kis_dynamic_sensor.cc.

~KisDynamicSensor()

KisDynamicSensor::~KisDynamicSensor ( )

override

Definition at line 40 of file kis_dynamic_sensor.cc.

Member Function Documentation

additiveToScaling()

static qreal KisDynamicSensor::additiveToScaling ( qreal  x )

inlinestatic

Definition at line 208 of file kis_dynamic_sensor.h.

createConfigurationWidget()

QWidget * KisDynamicSensor::createConfigurationWidget ( QWidget *  parent, QWidget *  selector  )

virtual

Parameters

parent	the parent QWidget
selector	is a QWidget that contains a signal called "parametersChanged()"

Reimplemented in KisDynamicSensorDrawingAngle, KisDynamicSensorTime, KisDynamicSensorDistance, and KisDynamicSensorFade.

Definition at line 44 of file kis_dynamic_sensor.cc.

createFromXML() [1/2]

KisDynamicSensorSP KisDynamicSensor::createFromXML ( const QDomElement &  e, const QString &  parentOptionName  )

static

Definition at line 394 of file kis_dynamic_sensor.cc.

createFromXML() [2/2]

KisDynamicSensorSP KisDynamicSensor::createFromXML ( const QString &  s, const QString &  parentOptionName  )

static

Definition at line 386 of file kis_dynamic_sensor.cc.

curve()

const KisCubicCurve & KisDynamicSensor::curve

(

)

const

Definition at line 545 of file kis_dynamic_sensor.cc.

dependsOnCanvasRotation()

bool KisDynamicSensor::dependsOnCanvasRotation ( ) const

virtual

Reimplemented in KisDynamicSensorFuzzy, and KisDynamicSensorDrawingAngle.

Definition at line 560 of file kis_dynamic_sensor.cc.

fromXML()

void KisDynamicSensor::fromXML ( const QDomElement &  e )

override

Definition at line 505 of file kis_dynamic_sensor.cc.

hasCustomCurve()

bool KisDynamicSensor::hasCustomCurve

(

)

const

Definition at line 555 of file kis_dynamic_sensor.cc.

id()

QString KisDynamicSensor::id ( DynamicSensorType  sensorType )

static

Returns

the identifier of this sensor

Definition at line 451 of file kis_dynamic_sensor.cc.

id2Sensor() [1/2]

KisDynamicSensorSP KisDynamicSensor::id2Sensor ( const KoID &  id, const QString &  parentOptionName  )

static

Creates a sensor from its identifier.

Definition at line 54 of file kis_dynamic_sensor.cc.

id2Sensor() [2/2]

static KisDynamicSensorSP KisDynamicSensor::id2Sensor ( const QString &  s, const QString &  parentOptionName  )

inlinestatic

Definition at line 141 of file kis_dynamic_sensor.h.

id2Type() [1/2]

DynamicSensorType KisDynamicSensor::id2Type ( const KoID &  id )

static

Definition at line 108 of file kis_dynamic_sensor.cc.

id2Type() [2/2]

static DynamicSensorType KisDynamicSensor::id2Type ( const QString &  s )

inlinestatic

Definition at line 146 of file kis_dynamic_sensor.h.

isAbsoluteRotation()

bool KisDynamicSensor::isAbsoluteRotation ( ) const

virtual

Reimplemented in KisDynamicSensorDrawingAngle.

Definition at line 570 of file kis_dynamic_sensor.cc.

isActive()

bool KisDynamicSensor::isActive

(

)

const

Definition at line 580 of file kis_dynamic_sensor.cc.

isAdditive()

bool KisDynamicSensor::isAdditive ( ) const

virtual

Reimplemented in KisDynamicSensorTiltDirection, KisDynamicSensorRotation, and KisDynamicSensorFuzzy.

Definition at line 565 of file kis_dynamic_sensor.cc.

length()

int KisDynamicSensor::length ( )

inline

Returns

the currently set length or -1 if not relevant

Definition at line 200 of file kis_dynamic_sensor.h.

maximumLabel()

QString KisDynamicSensor::maximumLabel ( DynamicSensorType  sensorType, int  max = -1  )

static

Definition at line 239 of file kis_dynamic_sensor.cc.

maximumValue()

int KisDynamicSensor::maximumValue ( DynamicSensorType  sensorType, int  max = -1  )

static

Definition at line 314 of file kis_dynamic_sensor.cc.

minimumLabel()

QString KisDynamicSensor::minimumLabel ( DynamicSensorType  sensorType )

static

Definition at line 201 of file kis_dynamic_sensor.cc.

minimumValue()

int KisDynamicSensor::minimumValue ( DynamicSensorType  sensorType )

static

Definition at line 286 of file kis_dynamic_sensor.cc.

parameter() [1/2]

qreal KisDynamicSensor::parameter

(

const KisPaintInformation &

info

)

Returns

the value of this sensor for the given KisPaintInformation

Definition at line 516 of file kis_dynamic_sensor.cc.

parameter() [2/2]

qreal KisDynamicSensor::parameter	(	const KisPaintInformation &	info,
		const KisCubicCurve	curve,
		const bool	customCurve
	)

Returns

the value of this sensor for the given KisPaintInformation curve – a custom, temporary curve that should be used instead of the one for the sensor customCurve – if it's a new curve or not; should always be true if the function is called from outside (aka not in parameter(info) function)

Definition at line 521 of file kis_dynamic_sensor.cc.

removeCurve()

void KisDynamicSensor::removeCurve

(

)

Definition at line 550 of file kis_dynamic_sensor.cc.

reset()

void KisDynamicSensor::reset ( )

virtual

This function is call before beginning a stroke to reset the sensor.

Default implementation does nothing.

Reimplemented in KisDynamicSensorDrawingAngle, KisDynamicSensorFuzzy, KisDynamicSensorTime, KisDynamicSensorSpeed, and KisDynamicSensorSpeed.

Definition at line 50 of file kis_dynamic_sensor.cc.

scalingToAdditive()

static qreal KisDynamicSensor::scalingToAdditive ( qreal  x )

inlinestatic

Definition at line 204 of file kis_dynamic_sensor.h.

sensorsIds()

QList< KoID > KisDynamicSensor::sensorsIds ( )

static

Returns

the list of sensors

Definition at line 404 of file kis_dynamic_sensor.cc.

sensorsTypes()

QList< DynamicSensorType > KisDynamicSensor::sensorsTypes ( )

static

Definition at line 428 of file kis_dynamic_sensor.cc.

sensorType()

DynamicSensorType KisDynamicSensor::sensorType ( ) const

inline

Definition at line 194 of file kis_dynamic_sensor.h.

setActive()

void KisDynamicSensor::setActive

(

bool

active

)

Definition at line 575 of file kis_dynamic_sensor.cc.

setCurve()

void KisDynamicSensor::setCurve

(

const KisCubicCurve &

curve

)

Definition at line 539 of file kis_dynamic_sensor.cc.

toXML()

void KisDynamicSensor::toXML ( QDomDocument &  doc, QDomElement &  elt  ) const

override

Definition at line 494 of file kis_dynamic_sensor.cc.

type2Sensor()

KisDynamicSensorSP KisDynamicSensor::type2Sensor ( DynamicSensorType  sensorType, const QString &  parentOptionName  )

static

type2Sensor creates a new sensor for the give type

Definition at line 161 of file kis_dynamic_sensor.cc.

value()

virtual qreal KisDynamicSensor::value ( const KisPaintInformation &  info )

protectedpure virtual

Implemented in KisDynamicSensorTangentialPressure, KisDynamicSensorPerspective, KisDynamicSensorTiltElevation, KisDynamicSensorTiltDirection, KisDynamicSensorYTilt, KisDynamicSensorXTilt, KisDynamicSensorPressureIn, KisDynamicSensorPressure, KisDynamicSensorRotation, KisDynamicSensorFuzzy, KisDynamicSensorDrawingAngle, KisDynamicSensorSpeed, KisDynamicSensorTangentialPressure, KisDynamicSensorPerspective, KisDynamicSensorTiltElevation, KisDynamicSensorTiltDirection, KisDynamicSensorYTilt, KisDynamicSensorXTilt, KisDynamicSensorPressureIn, KisDynamicSensorPressure, KisDynamicSensorRotation, KisDynamicSensorSpeed, KisDynamicSensorDistance, KisDynamicSensorFade, and KisDynamicSensorTime.

valueSuffix()

QString KisDynamicSensor::valueSuffix ( DynamicSensorType  sensorType )

static

Definition at line 357 of file kis_dynamic_sensor.cc.

Member Data Documentation

m_length

int KisDynamicSensor::m_length

protected

Definition at line 216 of file kis_dynamic_sensor.h.

---

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

• kis_dynamic_sensor.h
• kis_dynamic_sensor.cc