KisKritaSensorPack Class Reference

#include <KisKritaSensorPack.h>

Inheritance diagram for KisKritaSensorPack:

Public Types
enum class	Checkability { NotCheckable , Checkable , CheckableIfHasPrefix }

Public Member Functions
int	calcActiveSensorLength (const QString &activeSensorId) const override
KisSensorPackInterface *	clone () const override
bool	compare (const KisSensorPackInterface *rhs) const override
std::vector< const KisSensorData * >	constSensors () const override
const KisKritaSensorData &	constSensorsStruct () const
	KisKritaSensorPack (Checkability checkability)
	KisKritaSensorPack (const KisKritaSensorPack &rhs)=default
bool	read (KisCurveOptionDataCommon &data, const KisPropertiesConfiguration *setting) const override
std::vector< KisSensorData * >	sensors () override
KisKritaSensorData &	sensorsStruct ()
void	write (const KisCurveOptionDataCommon &data, KisPropertiesConfiguration *setting) const override
Public Member Functions inherited from KisSensorPackInterface
virtual	~KisSensorPackInterface ()

Private Attributes
Checkability	m_checkability
KisKritaSensorData	m_data

Detailed Description

Definition at line 58 of file KisKritaSensorPack.h.

Member Enumeration Documentation

Checkability

enum class KisKritaSensorPack::Checkability

strong

Some options make be uncheckable in normal situation, and become checkable when loaded from a prefix. E.g. Opacity, Flow and Size options of the masking brush. Such options will be marked with CheckableIfHasPrefix and their state will be deduced from the prefix.

Enumerator
NotCheckable
Checkable
CheckableIfHasPrefix

Definition at line 68 of file KisKritaSensorPack.h.

                            {
        NotCheckable,
        Checkable,
        CheckableIfHasPrefix,
    };

Constructor & Destructor Documentation

KisKritaSensorPack() [1/2]

KisKritaSensorPack::KisKritaSensorPack

(

Checkability

checkability

)

Definition at line 74 of file KisKritaSensorPack.cpp.

    : m_checkability(checkability)
{
}

KisKritaSensorPack() [2/2]

KisKritaSensorPack::KisKritaSensorPack ( const KisKritaSensorPack & rhs )

default

Member Function Documentation

calcActiveSensorLength()

int KisKritaSensorPack::calcActiveSensorLength ( const QString & activeSensorId ) const

overridevirtual

Reimplemented from KisSensorPackInterface.

Definition at line 274 of file KisKritaSensorPack.cpp.

{
    if (activeSensorId == FadeId.id()) {
        return m_data.sensorFade.length;
    } else if (activeSensorId == DistanceId.id()) {
        return m_data.sensorDistance.length;
    } else if (activeSensorId == TimeId.id()) {
        return m_data.sensorTime.length;
    }
 
    return -1;
}

References DistanceId(), FadeId(), KoID::id(), KisSensorWithLengthData::length, m_data, KisKritaSensorData::sensorDistance, KisKritaSensorData::sensorFade, KisKritaSensorData::sensorTime, and TimeId().

clone()

KisSensorPackInterface * KisKritaSensorPack::clone ( ) const

overridevirtual

Implements KisSensorPackInterface.

Definition at line 79 of file KisKritaSensorPack.cpp.

{
    return new KisKritaSensorPack(*this);
}

References KisKritaSensorPack().

compare()

bool KisKritaSensorPack::compare ( const KisSensorPackInterface * rhs ) const

overridevirtual

Implements KisSensorPackInterface.

Definition at line 104 of file KisKritaSensorPack.cpp.

{
    const KisKritaSensorPack *pack = dynamic_cast<const KisKritaSensorPack*>(rhs);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(pack, false);
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(m_checkability == pack->m_checkability, false);
 
    return m_data == pack->m_data;
}

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_checkability, and m_data.

constSensors()

std::vector< const KisSensorData * > KisKritaSensorPack::constSensors ( ) const

overridevirtual

Implements KisSensorPackInterface.

Definition at line 84 of file KisKritaSensorPack.cpp.

{
    return detail::sensors(&m_data);
}

References m_data, and detail::sensors().

constSensorsStruct()

const KisKritaSensorData & KisKritaSensorPack::constSensorsStruct

(

)

const

Definition at line 94 of file KisKritaSensorPack.cpp.

{
    return m_data;
}

References m_data.

read()

bool KisKritaSensorPack::read ( KisCurveOptionDataCommon & data, const KisPropertiesConfiguration * setting ) const

overridevirtual

due to legacy reasons we initialize common curve with the "last read curve value"

Implements KisSensorPackInterface.

Definition at line 113 of file KisKritaSensorPack.cpp.

{
    data.isCheckable = m_checkability == Checkability::Checkable ||
        (m_checkability == Checkability::CheckableIfHasPrefix &&
         (!data.prefix.isEmpty() ||
          !setting->getString(KisPropertiesConfiguration::extractedPrefixKey()).isEmpty()));
 
    data.isChecked = !data.isCheckable || setting->getBool("Pressure" + data.id.id(), false);
 
    std::vector<KisSensorData*> sensors = data.sensors();
    QMap<QString, KisSensorData*> sensorById;
 
    Q_FOREACH (KisSensorData *sensor, sensors) {
        sensorById.insert(sensor->id.id(), sensor);
    }
 
    QSet<KisSensorData*> sensorsToReset;
 
    QList l = sensorById.values();
    if (!l.isEmpty()) {
        sensorsToReset = QSet<KisSensorData*>(l.begin(), l.end());
    }
 
    const QString sensorDefinition = setting->getString(data.id.id() + "Sensor");
 
    if (sensorDefinition.isEmpty()) {
        // noop
    } else if (!sensorDefinition.contains("sensorslist")) {
        QDomDocument doc;
        doc.setContent(sensorDefinition);
        QDomElement e = doc.documentElement();
 
        const QString sensorId = e.attribute("id", "");
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!sensorId.isEmpty(), false);
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(sensorById.contains(sensorId), false);
 
        KisSensorData *sensor = sensorById[sensorId];
        sensor->read(e);
        sensor->isActive = true;
        sensorsToReset.remove(sensor);
 
        data.commonCurve = sensor->curve;
 
    } else {
        QString proposedCommonCurve;
 
        QDomDocument doc;
        doc.setContent(sensorDefinition);
        QDomElement elt = doc.documentElement();
        QDomNode node = elt.firstChild();
        while (!node.isNull()) {
            if (node.isElement())  {
                QDomElement childelt = node.toElement();
                if (childelt.tagName() == "ChildSensor") {
 
                    const QString sensorId = childelt.attribute("id", "");
                    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!sensorId.isEmpty(), false);
                    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(sensorById.contains(sensorId), false);
 
                    KisSensorData *sensor = sensorById[sensorId];
                    sensor->read(childelt);
                    sensor->isActive = true;
                    sensorsToReset.remove(sensor);
 
                    proposedCommonCurve = sensor->curve;
                }
            }
            node = node.nextSibling();
        }
 
        data.commonCurve = !proposedCommonCurve.isEmpty() ? proposedCommonCurve : DEFAULT_CURVE_STRING;
    }
 
    data.useSameCurve = setting->getBool(data.id.id() + "UseSameCurve", true);
 
    // Only load the old curve format if the curve wasn't saved by the sensor
    // This will give every sensor the same curve.
    if (!sensorDefinition.contains("curve")) {
        if (setting->getBool("Custom" + data.id.id(), false)) {
            data.commonCurve = setting->getString("Curve" + data.id.id(), DEFAULT_CURVE_STRING);
            Q_FOREACH (KisSensorData *sensor, sensors) {
                sensor->curve = data.commonCurve;
                sensorsToReset.remove(sensor);
            }
        } else {
            data.commonCurve = DEFAULT_CURVE_STRING;
        }
    }
 
    if (data.useSameCurve) {
        data.commonCurve = setting->getString(data.id.id() + "commonCurve",
                                              !data.commonCurve.isEmpty() ?
                                                  data.commonCurve :
                                                  DEFAULT_CURVE_STRING);
        if (data.commonCurve.isEmpty()) {
            data.commonCurve = DEFAULT_CURVE_STRING;
        }
    }
 
    Q_FOREACH (KisSensorData *sensor, sensorsToReset) {
        sensor->reset();
    }
 
    // At least one sensor needs to be active
    if (std::find_if(sensors.begin(), sensors.end(),
                     std::mem_fn(&KisSensorData::isActive)) == sensors.end()) {
 
        sensorById[PressureId.id()]->isActive = true;
    }
 
    data.strengthValue = setting->getDouble(data.id.id() + "Value", data.strengthMaxValue);
 
    if (data.valueFixUpReadCallback) {
        data.valueFixUpReadCallback(&data, setting);
    }
 
    data.useCurve = setting->getBool(data.id.id() + "UseCurve", true);
    data.curveMode = setting->getInt(data.id.id() + "curveMode", 0);
 
    return true;
}

References Checkable, CheckableIfHasPrefix, KisCurveOptionDataCommon::commonCurve, KisSensorData::curve, KisCurveOptionDataCommon::curveMode, DEFAULT_CURVE_STRING, KisPropertiesConfiguration::extractedPrefixKey(), KisPropertiesConfiguration::getBool(), KisPropertiesConfiguration::getDouble(), KisPropertiesConfiguration::getInt(), KisPropertiesConfiguration::getString(), KoID::id(), KisCurveOptionDataCommon::id, KisSensorData::id, KisSensorData::isActive, KisCurveOptionDataCommon::isCheckable, KisCurveOptionDataCommon::isChecked, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_checkability, KisCurveOptionDataCommon::prefix, PressureId(), KisSensorData::read(), KisSensorData::reset(), KisCurveOptionDataCommon::sensors(), sensors(), KisCurveOptionDataCommon::strengthMaxValue, KisCurveOptionDataCommon::strengthValue, KisCurveOptionDataCommon::useCurve, KisCurveOptionDataCommon::useSameCurve, and KisCurveOptionDataCommon::valueFixUpReadCallback.

sensors()

std::vector< KisSensorData * > KisKritaSensorPack::sensors ( )

overridevirtual

Implements KisSensorPackInterface.

Definition at line 89 of file KisKritaSensorPack.cpp.

{
    return detail::sensors(&m_data);
}

References m_data, and detail::sensors().

sensorsStruct()

KisKritaSensorData & KisKritaSensorPack::sensorsStruct

(

)

Definition at line 99 of file KisKritaSensorPack.cpp.

{
    return m_data;
}

References m_data.

write()

void KisKritaSensorPack::write ( const KisCurveOptionDataCommon & data, KisPropertiesConfiguration * setting ) const

overridevirtual

Implements KisSensorPackInterface.

Definition at line 237 of file KisKritaSensorPack.cpp.

{
    setting->setProperty("Pressure" + data.id.id(), data.isChecked || !data.isCheckable);
 
    QVector<const KisSensorData*> activeSensors;
    Q_FOREACH(const KisSensorData *sensor, data.sensors()) {
        if (sensor->isActive) {
            activeSensors.append(sensor);
        }
    }
 
    QDomDocument doc = QDomDocument("params");
    QDomElement root = doc.createElement("params");
    doc.appendChild(root);
 
    if (activeSensors.size() == 1) {
        activeSensors.first()->write(doc, root);
    } else {
        root.setAttribute("id", "sensorslist");
        Q_FOREACH (const KisSensorData *sensor, activeSensors) {
            QDomElement childelt = doc.createElement("ChildSensor");
            sensor->write(doc, childelt);
            root.appendChild(childelt);
        }
    }
    setting->setProperty(data.id.id() + "Sensor", doc.toString());
 
    setting->setProperty(data.id.id() + "UseCurve", data.useCurve);
    setting->setProperty(data.id.id() + "UseSameCurve", data.useSameCurve);
    setting->setProperty(data.id.id() + "Value", data.strengthValue);
    if (data.valueFixUpWriteCallback) {
        data.valueFixUpWriteCallback(data.strengthValue, setting);
    }
    setting->setProperty(data.id.id() + "curveMode", data.curveMode);
    setting->setProperty(data.id.id() + "commonCurve", data.commonCurve);
}

References KisCurveOptionDataCommon::commonCurve, KisCurveOptionDataCommon::curveMode, KoID::id(), KisCurveOptionDataCommon::id, KisSensorData::isActive, KisCurveOptionDataCommon::isCheckable, KisCurveOptionDataCommon::isChecked, KisCurveOptionDataCommon::sensors(), KisPropertiesConfiguration::setProperty(), KisCurveOptionDataCommon::strengthValue, KisCurveOptionDataCommon::useCurve, KisCurveOptionDataCommon::useSameCurve, KisCurveOptionDataCommon::valueFixUpWriteCallback, and KisSensorData::write().

Member Data Documentation

m_checkability

Checkability KisKritaSensorPack::m_checkability

private

Definition at line 94 of file KisKritaSensorPack.h.

m_data

KisKritaSensorData KisKritaSensorPack::m_data

private

Definition at line 93 of file KisKritaSensorPack.h.

---

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

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