#include <kis_paintop_settings.h>

Inheritance diagram for KisPaintOpSettings:

Classes
struct	OutlineMode

struct	UpdateListener

Public Types
using	UpdateListenerSP = QSharedPointer<UpdateListener>

using	UpdateListenerWSP = QWeakPointer<UpdateListener>

Public Member Functions
virtual void	activate ()

virtual qreal	airbrushInterval () const

virtual KisOptimizedBrushOutline	brushOutline (const KisPaintInformation &info, const OutlineMode &mode, qreal alignForZoom)

KoCanvasResourcesInterfaceSP	canvasResourcesInterface () const

virtual KisPaintOpSettingsSP	clone () const

KisPaintOpSettingsSP	createMaskingSettings () const

QString	effectivePaintOpCompositeOp ()

bool	eraserMode ()

bool	hasMaskingSettings () const

virtual bool	hasPatternSettings () const

virtual QString	indirectPaintingCompositeOp () const

virtual bool	isAirbrushing () const

virtual bool	isValid () const

	KisPaintOpSettings (const KisPaintOpSettings &rhs)

	KisPaintOpSettings (KisResourcesInterfaceSP resourcesInterface)

qreal	lodSizeThreshold () const

virtual bool	lodSizeThresholdSupported () const

QString	maskingBrushCompositeOp () const

virtual QString	modelName () const

virtual bool	mousePressEvent (const KisPaintInformation &paintInformation, Qt::KeyboardModifiers modifiers, KisNodeWSP currentNode)

virtual bool	mouseReleaseEvent ()

virtual bool	needsAsynchronousUpdates () const

KisNodeSP	node () const

virtual bool	paintIncremental ()

virtual qreal	paintOpAngle () const =0

QString	paintOpCompositeOp ()

qreal	paintOpFade ()

qreal	paintOpFlow ()

virtual qreal	paintOpOpacity ()

virtual qreal	paintOpPatternSize ()

qreal	paintOpScatter ()

virtual qreal	paintOpSize () const =0

	Private ()

	Private (const Private &rhs)

virtual void	regenerateResourceCache (KoResourceCacheInterfaceSP cacheInterface)

virtual QList< int >	requiredCanvasResources () const

virtual void	resetSettings (const QStringList &preserveProperties=QStringList())

KoResourceCacheInterfaceSP	resourceCacheInterface () const

KisResourcesInterfaceSP	resourcesInterface () const

quint64	sanityVersionCookie () const

qreal	savedBrushOpacity () const

qreal	savedBrushSize () const

qreal	savedEraserOpacity () const

qreal	savedEraserSize () const

void	setCanvasResourcesInterface (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

void	setEraserMode (bool value)

void	setLodSizeThreshold (qreal value)

void	setModelName (const QString &modelName)

virtual void	setPaintOpAngle (qreal value)=0

void	setPaintOpCompositeOp (const QString &value)

void	setPaintOpFade (qreal value)

void	setPaintOpFlow (qreal value)

virtual void	setPaintOpOpacity (qreal value)

void	setPaintOpScatter (qreal value)

virtual void	setPaintOpSize (qreal value)=0

void	setProperty (const QString &name, const QVariant &value) override

virtual void	setResourceCacheInterface (KoResourceCacheInterfaceSP cacheInterface)

void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)

void	setSavedBrushOpacity (qreal value)

void	setSavedBrushSize (qreal value)

void	setSavedEraserOpacity (qreal value)

void	setSavedEraserSize (qreal value)

void	setUpdateListener (UpdateListenerWSP listener)

virtual QList< KisUniformPaintOpPropertySP >	uniformProperties (KisPaintOpSettingsSP settings, QPointer< KisPaintOpPresetUpdateProxy > updateProxy)

UpdateListenerWSP	updateListener () const

virtual bool	useSpacingUpdates () const

	~KisPaintOpSettings () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Member Functions inherited from KisPropertiesConfiguration
void	clearProperties ()
	Clear the map of properties.

virtual bool	compareTo (const KisPropertiesConfiguration *rhs) const

virtual void	dump () const

void	fromXML (const QDomElement &) override

bool	fromXML (const QString &xml, bool clear=true) override

bool	getBool (const QString &name, bool def=false) const

KoColor	getColor (const QString &name, const KoColor &color=KoColor()) const
	getColor fetch the given property as a KoColor.

KisCubicCurve	getCubicCurve (const QString &name, const KisCubicCurve &curve=KisCubicCurve()) const

double	getDouble (const QString &name, double def=0.0) const

float	getFloat (const QString &name, float def=0.0) const

int	getInt (const QString &name, int def=0) const

void	getPrefixedProperties (const QString &prefix, KisPropertiesConfiguration *config) const

void	getPrefixedProperties (const QString &prefix, KisPropertiesConfigurationSP config) const

virtual QMap< QString, QVariant >	getProperties () const

virtual QList< QString >	getPropertiesKeys () const

virtual QVariant	getProperty (const QString &name) const

virtual bool	getProperty (const QString &name, QVariant &value) const

QString	getPropertyLazy (const QString &name, const char *defaultValue) const

QStringList	getPropertyLazy (const QString &name, const QStringList &defaultValue) const

template<typename T >
T	getPropertyLazy (const QString &name, const T &defaultValue) const

QString	getString (const QString &name, const QString &def=QString()) const

QStringList	getStringList (const QString &name, const QStringList &defaultValue=QStringList()) const

virtual bool	hasProperty (const QString &name) const

	KisPropertiesConfiguration ()

	KisPropertiesConfiguration (const KisPropertiesConfiguration &rhs)

KisPropertiesConfiguration &	operator= (const KisPropertiesConfiguration &rhs)

void	removeProperty (const QString &name)

void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfiguration *config)

void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfigurationSP config)

void	setProperty (const QString &name, const QStringList &value)

void	setPropertyNotSaved (const QString &name)
	Marks a property that should not be saved by toXML.

QString	toXML () const override

void	toXML (QDomDocument &, QDomElement &) const override

	~KisPropertiesConfiguration () override

Public Member Functions inherited from KisSerializableConfiguration
	KisSerializableConfiguration ()

	KisSerializableConfiguration (const KisSerializableConfiguration &rhs)

virtual	~KisSerializableConfiguration ()

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static KisOptimizedBrushOutline	ellipseOutline (qreal width, qreal height, qreal scale, qreal rotation)

static bool	isLodUserAllowed (const KisPropertiesConfigurationSP config)

static QPainterPath	makeTiltIndicator (KisPaintInformation const &info, QPointF const &start, qreal lengthScale, qreal angle)

static void	setLodUserAllowed (KisPropertiesConfigurationSP config, bool value)

Static Public Member Functions inherited from KisPropertiesConfiguration
static QString	escapeString (const QString &string)

static QString	extractedPrefixKey ()

static QString	unescapeString (const QString &string)

Public Attributes
KoCanvasResourcesInterfaceSP	canvasResourcesInterface

QString	modelName

KoResourceCacheInterfaceSP	resourceCacheInterface

KisResourcesInterfaceSP	resourcesInterface

QPointer< KisPaintOpConfigWidget >	settingsWidget

QList< KisUniformPaintOpPropertyWSP >	uniformProperties

UpdateListenerWSP	updateListener

quint64	versionCookie

KisRandomSource	versionRandomSource

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KisPropertiesConfiguration
QSet< QString >	notSavedProperties

QMap< QString, QVariant >	properties

Protected Member Functions
virtual void	onPropertyChanged ()

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

This class is used to cache the settings for a paintop between two creations. There is one KisPaintOpSettings per input device (mouse, tablet, etc...).

The settings may be stored in a preset. Note that if your paintop's settings subclass has data that is not stored as a property, that data is not saved and restored.

The object also contains a pointer to its parent KisPaintOpPreset object.This is to control the DirtyPreset property of KisPaintOpPreset. Whenever the settings are changed/modified from the original – the preset is set to dirty.

Definition at line 54 of file kis_paintop_settings.cpp.

Member Typedef Documentation

◆ UpdateListenerSP

using KisPaintOpSettings::UpdateListenerSP = QSharedPointer<UpdateListener>

Definition at line 78 of file kis_paintop_settings.h.

◆ UpdateListenerWSP

using KisPaintOpSettings::UpdateListenerWSP = QWeakPointer<UpdateListener>

Definition at line 79 of file kis_paintop_settings.h.

Constructor & Destructor Documentation

◆ KisPaintOpSettings() [1/2]

KisPaintOpSettings::KisPaintOpSettings ( KisResourcesInterfaceSP resourcesInterface )

Definition at line 98 of file kis_paintop_settings.cpp.

    : d(new Private)
{
    d->resourcesInterface = resourcesInterface;
}

References d, and resourcesInterface.

◆ ~KisPaintOpSettings()

KisPaintOpSettings::~KisPaintOpSettings ( )

override

Definition at line 104 of file kis_paintop_settings.cpp.

105{

106}

◆ KisPaintOpSettings() [2/2]

KisPaintOpSettings::KisPaintOpSettings ( const KisPaintOpSettings & rhs )

Definition at line 108 of file kis_paintop_settings.cpp.

    : KisPropertiesConfiguration(rhs)
    , d(new Private(*rhs.d))
{
}

Member Function Documentation

◆ activate()

void KisPaintOpSettings::activate ( )

virtual

Call this function when the paint op is selected or the tool is activated

Reimplemented in KisDuplicateOpSettings.

Definition at line 293 of file kis_paintop_settings.cpp.

294{

295}

◆ airbrushInterval()

qreal KisPaintOpSettings::airbrushInterval ( ) const

virtual

Indicates the minimum time interval that might be needed between airbrush dabs, in milliseconds. A lower value means painting updates need to happen more frequently. This value should be ignored if isAirbrushing() is false.

The default implementation uses the property AIRBRUSH_RATE, defaulting to an interval of one second if the property is not found. This should be suitable for most paintops.

Reimplemented in KisRoundMarkerOpSettings.

Definition at line 503 of file kis_paintop_settings.cpp.

{
    qreal rate = getDouble(AIRBRUSH_RATE, 1.0);
    if (rate == 0.0) {
        return LONG_TIME;
    }
    else {
        return 1000.0 / rate;
    }
}

References AIRBRUSH_RATE, KisPropertiesConfiguration::getDouble(), and LONG_TIME.

◆ brushOutline()

KisOptimizedBrushOutline KisPaintOpSettings::brushOutline	(	const KisPaintInformation &	info,
		const OutlineMode &	mode,
		qreal	alignForZoom )

virtual

Returns the brush outline in pixel coordinates. Tool is responsible for conversion into view coordinates. Outline mode has to be passed to the paintop which builds the outline as some paintops have to paint outline always like clone paintop indicating the duplicate position

Reimplemented in KisBrushBasedPaintOpSettings, KisDuplicateOpSettings, KisDuplicateOpSettings, KisDeformPaintOpSettings, KisExperimentPaintOpSettings, KisGridPaintOpSettings, KisHairyPaintOpSettings, KisHairyPaintOpSettings, KisBrushBasedPaintOpSettings, KisMyPaintOpSettings, KisRoundMarkerOpSettings, KisSketchPaintOpSettings, and KisSprayPaintOpSettings.

Definition at line 524 of file kis_paintop_settings.cpp.

{
    KisOptimizedBrushOutline path;
    if (mode.isVisible) {
        path = ellipseOutline(10, 10, 1.0, 0);
 
        if (mode.showTiltDecoration) {
            path.addPath(makeTiltIndicator(info, QPointF(0.0, 0.0), 0.0, 2.0));
        }
 
        path.translate(KisAlgebra2D::alignForZoom(info.pos(), alignForZoom));
    }
 
    return path;
}

References KisAlgebra2D::alignForZoom(), ellipseOutline(), KisPaintOpSettings::OutlineMode::isVisible, makeTiltIndicator(), KisPaintInformation::pos(), and KisPaintOpSettings::OutlineMode::showTiltDecoration.

◆ canvasResourcesInterface()

KoCanvasResourcesInterfaceSP KisPaintOpSettings::canvasResourcesInterface ( ) const

◆ clone()

KisPaintOpSettingsSP KisPaintOpSettings::clone ( ) const

virtual

Clone the current settings object. Override this if your settings instance doesn't store everything as properties.

Reimplemented in KisDuplicateOpSettings, and KisBrushBasedPaintOpSettings.

Definition at line 252 of file kis_paintop_settings.cpp.

{
    QString paintopID = getString("paintop");
    if (paintopID.isEmpty())
        return 0;
 
    KisPaintOpSettingsSP settings = KisPaintOpRegistry::instance()->createSettings(KoID(paintopID), resourcesInterface());
    QMapIterator<QString, QVariant> i(getProperties());
    while (i.hasNext()) {
        i.next();
        settings->setProperty(i.key(), QVariant(i.value()));
    }
 
    settings->setCanvasResourcesInterface(this->canvasResourcesInterface());
 
#ifdef SANITY_CHECK_CACHE
    settings->d->versionCookie = this->d->versionCookie;
#endif
 
    return settings;
}

References canvasResourcesInterface, KisPaintOpRegistry::createSettings(), KisSharedPtr< T >::d, d, KisPropertiesConfiguration::getProperties(), KisPropertiesConfiguration::getString(), KisPaintOpRegistry::instance(), and resourcesInterface.

◆ createMaskingSettings()

KisPaintOpSettingsSP KisPaintOpSettings::createMaskingSettings ( ) const

Returns: a newly created settings object representing a preset of the masking brush that should be run alongside the current brush

WARNING: cropping is a workaround for too big brushes due to the proportional scaling using shift+drag gesture.

See this bug: https://bugs.kde.org/show_bug.cgi?id=423572

TODO:

1) Implement a warning notifying the user that his masking brush has been cropped

2) Make sure that the sliders in KisMaskingBrushOption have correct limits (right now they are limited by usual maximumBrushSize)

Definition at line 141 of file kis_paintop_settings.cpp.

{
    if (!hasMaskingSettings()) return KisPaintOpSettingsSP();
 
    const KoID pixelBrushId(KisPaintOpUtils::MaskingBrushPaintOpId, QString());
 
    KisPaintOpSettingsSP maskingSettings = KisPaintOpRegistry::instance()->createSettings(pixelBrushId, resourcesInterface());
    maskingSettings->setCanvasResourcesInterface(canvasResourcesInterface());
 
    this->getPrefixedProperties(KisPaintOpUtils::MaskingBrushPresetPrefix, maskingSettings);
 
    const bool useMasterSize = this->getBool(KisPaintOpUtils::MaskingBrushUseMasterSizeTag, true);
    if (useMasterSize) {
        const qreal maxMaskingBrushSize = KisImageConfig(true).maxMaskingBrushSize();
        const qreal masterSizeCoeff = getDouble(KisPaintOpUtils::MaskingBrushMasterSizeCoeffTag, 1.0);
        maskingSettings->setPaintOpSize(qMin(maxMaskingBrushSize, masterSizeCoeff * paintOpSize()));
    }
 
    if (d->resourceCacheInterface) {
        maskingSettings->setResourceCacheInterface(
                    toQShared(new KoResourceCachePrefixedStorageWrapper(
                                  KisPaintOpUtils::MaskingBrushPresetPrefix,
                                  d->resourceCacheInterface)));
    }
 
    return maskingSettings;
}

References canvasResourcesInterface, KisPaintOpRegistry::createSettings(), d, KisPropertiesConfiguration::getBool(), KisPropertiesConfiguration::getDouble(), KisPropertiesConfiguration::getPrefixedProperties(), hasMaskingSettings(), KisPaintOpRegistry::instance(), KisPaintOpUtils::MaskingBrushMasterSizeCoeffTag, KisPaintOpUtils::MaskingBrushPaintOpId, KisPaintOpUtils::MaskingBrushPresetPrefix, KisPaintOpUtils::MaskingBrushUseMasterSizeTag, KisImageConfig::maxMaskingBrushSize(), paintOpSize(), resourcesInterface, and toQShared().

◆ effectivePaintOpCompositeOp()

QString KisPaintOpSettings::effectivePaintOpCompositeOp ( )

Definition at line 429 of file kis_paintop_settings.cpp.

{
    return !eraserMode() ? paintOpCompositeOp() : COMPOSITE_ERASE;
}

References COMPOSITE_ERASE, eraserMode(), and paintOpCompositeOp().

◆ ellipseOutline()

KisOptimizedBrushOutline KisPaintOpSettings::ellipseOutline	(	qreal	width,
		qreal	height,
		qreal	scale,
		qreal	rotation )

static

Helpers for drawing the brush outline

Definition at line 540 of file kis_paintop_settings.cpp.

{
    QPainterPath path;
    QRectF ellipse(0, 0, width * scale, height * scale);
    ellipse.translate(-ellipse.center());
    path.addEllipse(ellipse);
 
    QTransform m;
    m.reset();
    m.rotate(rotation);
    path = m.map(path);
    return path;
}

◆ eraserMode()

bool KisPaintOpSettings::eraserMode ( )

Definition at line 421 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    return proxy->getBool("EraserMode", false);
}

References KisLockedPropertiesServer::instance().

◆ hasMaskingSettings()

bool KisPaintOpSettings::hasMaskingSettings ( ) const

Returns: true if this preset demands a secondary masked brush running alongside it

Definition at line 136 of file kis_paintop_settings.cpp.

{
    return getBool(KisPaintOpUtils::MaskingBrushEnabledTag, false);
}

References KisPropertiesConfiguration::getBool(), and KisPaintOpUtils::MaskingBrushEnabledTag.

◆ hasPatternSettings()

bool KisPaintOpSettings::hasPatternSettings ( ) const

virtual

Reimplemented in KisFilterOpSettings, KisHairyPaintOpSettings, KisBrushBasedPaintOpSettings, and KisSketchPaintOpSettings.

Definition at line 184 of file kis_paintop_settings.cpp.

{
    return false;
}

◆ indirectPaintingCompositeOp()

QString KisPaintOpSettings::indirectPaintingCompositeOp ( ) const

virtual

Returns: the composite op it to which the indirect painting device should be initialized to. This is used by clone op to reset the composite op to COMPOSITE_COPY

Reimplemented in KisDuplicateOpSettings.

Definition at line 493 of file kis_paintop_settings.cpp.

{
    return COMPOSITE_ALPHA_DARKEN;
}

References COMPOSITE_ALPHA_DARKEN.

◆ isAirbrushing()

bool KisPaintOpSettings::isAirbrushing ( ) const

virtual

Whether this paintop wants to deposit paint even when not moving, i.e. the tool needs to activate its timer. If this is true, painting updates need to be generated at regular intervals even in the absence of input device events, e.g. when the cursor is not moving.

The default implementation checks the property AIRBRUSH_ENABLED, defaulting to false if the property is not found. This should be suitable for most paintops.

Reimplemented in KisDeformPaintOpSettings, and KisRoundMarkerOpSettings.

Definition at line 498 of file kis_paintop_settings.cpp.

{
    return getBool(AIRBRUSH_ENABLED, false);
}

References AIRBRUSH_ENABLED, and KisPropertiesConfiguration::getBool().

◆ isLodUserAllowed()

bool KisPaintOpSettings::isLodUserAllowed ( const KisPropertiesConfigurationSP config )

static

Definition at line 604 of file kis_paintop_settings.cpp.

{
    return config->getBool("lodUserAllowed", true);
}

◆ isValid()

bool KisPaintOpSettings::isValid ( ) const

virtual

Check if the settings are valid, setting might be invalid through missing brushes etc Overwrite if the settings of a paintop can be invalid

Returns: state of the settings, default implementation is true

Definition at line 488 of file kis_paintop_settings.cpp.

{
    return true;
}

◆ lodSizeThreshold()

qreal KisPaintOpSettings::lodSizeThreshold ( ) const

Definition at line 619 of file kis_paintop_settings.cpp.

{
    return getDouble("lodSizeThreshold", 100.0);
}

References KisPropertiesConfiguration::getDouble().

◆ lodSizeThresholdSupported()

bool KisPaintOpSettings::lodSizeThresholdSupported ( ) const

virtual

Definition at line 614 of file kis_paintop_settings.cpp.

{
    return true;
}

◆ makeTiltIndicator()

QPainterPath KisPaintOpSettings::makeTiltIndicator	(	KisPaintInformation const &	info,
		QPointF const &	start,
		qreal	lengthScale,
		qreal	angle )

static

Helper for drawing a triangle representing the tilt of the stylus.

Parameters

start	is the offset from the brush's outline's bounding box
lengthScale	is used for deciding the size of the triangle. Brush diameter or width are common choices for this.
angle	is the angle between the two sides of the triangle.

Definition at line 554 of file kis_paintop_settings.cpp.

{
    if (maxLength == 0.0) maxLength = 50.0;
    maxLength = qMax(maxLength, 50.0);
    qreal const length = maxLength * (1 - info.tiltElevation(info, 60.0, 60.0, true));
    qreal const baseAngle = 360.0 - fmod(KisPaintInformation::tiltDirection(info, true) * 360.0 + 270.0, 360.0);
 
    QLineF guideLine = QLineF::fromPolar(length, baseAngle + angle);
    guideLine.translate(start);
    QPainterPath ret;
    ret.moveTo(guideLine.p1());
    ret.lineTo(guideLine.p2());
    guideLine.setAngle(baseAngle - angle);
    ret.lineTo(guideLine.p2());
    ret.lineTo(guideLine.p1());
    return ret;
}

References length(), KisPaintInformation::tiltDirection(), and KisPaintInformation::tiltElevation().

◆ maskingBrushCompositeOp()

QString KisPaintOpSettings::maskingBrushCompositeOp ( ) const

Returns: a composite op id of the masked brush rendering algorithm.

Please take into account that the brush itself always paints in alpha- darken mode, but the final result is combined with this composite op.

Definition at line 237 of file kis_paintop_settings.cpp.

{
    return getString(KisPaintOpUtils::MaskingBrushCompositeOpTag, COMPOSITE_MULT);
}

References COMPOSITE_MULT, KisPropertiesConfiguration::getString(), and KisPaintOpUtils::MaskingBrushCompositeOpTag.

◆ modelName()

virtual QString KisPaintOpSettings::modelName ( ) const

virtual

Returns: filename of the 3D brush model, empty if no brush is set

Reimplemented in KisMyPaintOpSettings, and KisSprayPaintOpSettings.

◆ mousePressEvent()

bool KisPaintOpSettings::mousePressEvent	(	const KisPaintInformation &	paintInformation,
		Qt::KeyboardModifiers	modifiers,
		KisNodeWSP	currentNode )

virtual

This function is called by a tool when the mouse is pressed. It's useful if the paintop needs mouse interaction for instance in the case of the clone op. If the tool is supposed to ignore the event, the paint op should return true and if the tool is supposed to use the event, return false. See kis_tool_freehand:tryPickByPaintOp()

Reimplemented in KisDuplicateOpSettings, and KisGridPaintOpSettings.

Definition at line 124 of file kis_paintop_settings.cpp.

{
    Q_UNUSED(modifiers);
    Q_UNUSED(currentNode);
    return true; // ignore the event by default
}

◆ mouseReleaseEvent()

bool KisPaintOpSettings::mouseReleaseEvent ( )

virtual

This function is called by a tool when the mouse is released. It's useful if the paintop needs mouse interaction for instance in the case of the clone op. If the tool is supposed to ignore the event, the paint op should return true and if the tool is supposed to use the event, return false.

Reimplemented in KisDuplicateOpSettings, and KisGridPaintOpSettings.

Definition at line 131 of file kis_paintop_settings.cpp.

{
    return true; // ignore the event by default
}

◆ needsAsynchronousUpdates()

bool KisPaintOpSettings::needsAsynchronousUpdates ( ) const

virtual

Indicates if the tool should call paintOp->doAsynchronousUpdate() in between paintAt() calls to do the asynchronous rendering

Reimplemented in KisBrushOpSettings.

Definition at line 519 of file kis_paintop_settings.cpp.

{
    return false;
}

◆ node()

KisNodeSP KisPaintOpSettings::node ( ) const

Returns: the node the paintop is working on.

◆ onPropertyChanged()

void KisPaintOpSettings::onPropertyChanged ( )

protectedvirtual

The callback is called every time when a property changes

Reimplemented in KisBrushBasedPaintOpSettings, KisOutlineGenerationPolicy< KisPaintOpSettings >, and KisMyPaintOpSettings.

Definition at line 588 of file kis_paintop_settings.cpp.

{
    // clear cached data for the resource
    d->resourceCacheInterface.clear();
 
#ifdef SANITY_CHECK_CACHE
    d->versionCookie = d->versionRandomSource.generate();
#endif
 
    UpdateListenerSP updateListener = d->updateListener.toStrongRef();
 
    if (updateListener) {
        updateListener->notifySettingsChanged();
    }
}

References d, and updateListener.

◆ paintIncremental()

virtual bool KisPaintOpSettings::paintIncremental ( )

inlinevirtual

XXX: Remove this after 2.0, when the paint operation (incremental/non incremental) will be completely handled in the paintop, not in the tool. This is a filthy hack to move the option to the right place, at least.

Returns: true if we paint incrementally, false if we paint like Photoshop. By default, paintops do not support non-incremental.

Reimplemented in KisCurvePaintOpSettings, KisDuplicateOpSettings, KisDeformPaintOpSettings, KisExperimentPaintOpSettings, KisFilterOpSettings, KisGridPaintOpSettings, KisBrushBasedPaintOpSettings, KisMyPaintOpSettings, KisParticlePaintOpSettings, KisRoundMarkerOpSettings, KisSketchPaintOpSettings, and KisSprayPaintOpSettings.

Definition at line 131 of file kis_paintop_settings.h.

                                    {
        return true;
    }

◆ paintOpAngle()

virtual qreal KisPaintOpSettings::paintOpAngle ( ) const

pure virtual

Returns: paintop angle (in degrees) saved in the properties

Implemented in KisNoSizePaintOpSettings, KisCurvePaintOpSettings, KisDeformPaintOpSettings, KisGridPaintOpSettings, KisBrushBasedPaintOpSettings, KisMyPaintOpSettings, KisRoundMarkerOpSettings, and KisSprayPaintOpSettings.

◆ paintOpCompositeOp()

QString KisPaintOpSettings::paintOpCompositeOp ( )

Returns: composite mode saved in the properties

Definition at line 405 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    return proxy->getString("CompositeOp", COMPOSITE_OVER);
}

References COMPOSITE_OVER, and KisLockedPropertiesServer::instance().

◆ paintOpFade()

qreal KisPaintOpSettings::paintOpFade ( )

Returns: fade saved in the properties

Definition at line 367 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
        KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    if (!proxy->hasProperty("brush_definition")) return 1.0;
 
    QDomDocument doc;
    doc.setContent(proxy->getString("brush_definition"));
 
    QDomElement element = doc.documentElement();
    QDomElement elementChild = element.elementsByTagName("MaskGenerator").item(0).toElement();
 
    if (elementChild.attributeNode("hfade").value().toDouble() >= elementChild.attributeNode("vfade").value().toDouble()) {
        return elementChild.attributeNode("hfade").value().toDouble();
    } else {
        return elementChild.attributeNode("vfade").value().toDouble();
    }
 
}

References KisLockedPropertiesServer::instance().

◆ paintOpFlow()

qreal KisPaintOpSettings::paintOpFlow ( )

Returns: flow saved in the properties

Definition at line 359 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    return proxy->getDouble("FlowValue", 1.0);
}

References KisLockedPropertiesServer::instance().

◆ paintOpOpacity()

qreal KisPaintOpSettings::paintOpOpacity ( )

virtual

Returns: opacity saved in the properties

Reimplemented in KisMyPaintOpSettings.

Definition at line 352 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy = KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this);
 
    return proxy->getDouble("OpacityValue", 1.0);
}

References KisLockedPropertiesServer::createLockedPropertiesProxy(), and KisLockedPropertiesServer::instance().

◆ paintOpPatternSize()

qreal KisPaintOpSettings::paintOpPatternSize ( )

virtual

Returns: pattern size saved in the properties

Definition at line 397 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
        KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    return proxy->getDouble("Texture/Pattern/Scale", 0.5);
}

References KisLockedPropertiesServer::instance().

◆ paintOpScatter()

qreal KisPaintOpSettings::paintOpScatter ( )

Returns: scatter saved in the properties

Definition at line 388 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
        KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    return proxy->getDouble("ScatterValue", 0.0);
}

References KisLockedPropertiesServer::instance().

◆ paintOpSize()

virtual qreal KisPaintOpSettings::paintOpSize ( ) const

pure virtual

Returns: size saved in the properties

Implemented in KisNoSizePaintOpSettings, KisCurvePaintOpSettings, KisDeformPaintOpSettings, KisGridPaintOpSettings, KisBrushBasedPaintOpSettings, KisMyPaintOpSettings, KisRoundMarkerOpSettings, and KisSprayPaintOpSettings.

◆ Private() [1/2]

KisPaintOpSettings::Private ( )

inline

Definition at line 55 of file kis_paintop_settings.cpp.

        : settingsWidget(0)
#ifdef SANITY_CHECK_CACHE
        , versionRandomSource(int(reinterpret_cast<std::intptr_t>(this)))
        , versionCookie(versionRandomSource.generate())
#endif
    {}

◆ Private() [2/2]

KisPaintOpSettings::Private ( const Private & rhs )

inline

NOTE: we don't copy updateListener intentionally, it is a job of the cloned preset to set the new listener properly

Definition at line 63 of file kis_paintop_settings.cpp.

        : settingsWidget(0),
          modelName(rhs.modelName),
          resourcesInterface(rhs.resourcesInterface),
          canvasResourcesInterface(rhs.canvasResourcesInterface),
          resourceCacheInterface(rhs.resourceCacheInterface)
#ifdef SANITY_CHECK_CACHE
        , versionRandomSource(int(reinterpret_cast<std::intptr_t>(this)))
        , versionCookie(rhs.versionCookie)
#endif
    {
    }

◆ regenerateResourceCache()

void KisPaintOpSettings::regenerateResourceCache ( KoResourceCacheInterfaceSP cacheInterface )

virtual

Reimplemented in KisBrushBasedPaintOpSettings.

Definition at line 214 of file kis_paintop_settings.cpp.

{
    if (hasMaskingSettings()) {
        KisPaintOpSettingsSP maskingSettings = createMaskingSettings();
 
        KoResourceCacheInterfaceSP wrappedCacheInterface =
            toQShared(new KoResourceCachePrefixedStorageWrapper(
                          KisPaintOpUtils::MaskingBrushPresetPrefix,
                          cacheInterface));
 
        maskingSettings->regenerateResourceCache(wrappedCacheInterface);
    }
}

References createMaskingSettings(), hasMaskingSettings(), KisPaintOpUtils::MaskingBrushPresetPrefix, and toQShared().

◆ requiredCanvasResources()

QList< int > KisPaintOpSettings::requiredCanvasResources ( ) const

virtual

Reimplemented in KisBrushBasedPaintOpSettings.

Definition at line 189 of file kis_paintop_settings.cpp.

{
    return {};
}

◆ resetSettings()

void KisPaintOpSettings::resetSettings ( const QStringList & preserveProperties = QStringList() )

virtual

Removes all the settings from the object while keeping the paintop id, which is loaded to the object by the factory

Reimplemented in KisMyPaintOpSettings.

Definition at line 274 of file kis_paintop_settings.cpp.

{
    QStringList allKeys = preserveProperties;
    allKeys << "paintop";
 
    QHash<QString, QVariant> preserved;
    Q_FOREACH (const QString &key, allKeys) {
        if (hasProperty(key)) {
            preserved[key] = getProperty(key);
        }
    }
 
    clearProperties();
 
    for (auto it = preserved.constBegin(); it != preserved.constEnd(); ++it) {
        setProperty(it.key(), it.value());
    }
}

References KisPropertiesConfiguration::clearProperties(), KisPropertiesConfiguration::getProperty(), KisPropertiesConfiguration::hasProperty(), and setProperty().

◆ resourceCacheInterface()

KoResourceCacheInterfaceSP KisPaintOpSettings::resourceCacheInterface ( ) const

◆ resourcesInterface()

KisResourcesInterfaceSP KisPaintOpSettings::resourcesInterface ( ) const

Returns: resource interface that is used for loading linked resources

◆ sanityVersionCookie()

quint64 KisPaintOpSettings::sanityVersionCookie ( ) const

Definition at line 228 of file kis_paintop_settings.cpp.

{
#ifdef SANITY_CHECK_CACHE
    return d->versionCookie;
#else
    return 0;
#endif
}

References d.

◆ savedBrushOpacity()

qreal KisPaintOpSettings::savedBrushOpacity ( ) const

Definition at line 467 of file kis_paintop_settings.cpp.

{
    return getDouble("SavedBrushOpacity", 0.0);
}

References KisPropertiesConfiguration::getDouble().

◆ savedBrushSize()

qreal KisPaintOpSettings::savedBrushSize ( ) const

Definition at line 445 of file kis_paintop_settings.cpp.

{
    return getDouble("SavedBrushSize", 0.0);
}

References KisPropertiesConfiguration::getDouble().

◆ savedEraserOpacity()

qreal KisPaintOpSettings::savedEraserOpacity ( ) const

Definition at line 456 of file kis_paintop_settings.cpp.

{
    return getDouble("SavedEraserOpacity", 0.0);
}

References KisPropertiesConfiguration::getDouble().

◆ savedEraserSize()

qreal KisPaintOpSettings::savedEraserSize ( ) const

Definition at line 434 of file kis_paintop_settings.cpp.

{
    return getDouble("SavedEraserSize", 0.0);
}

References KisPropertiesConfiguration::getDouble().

◆ setCanvasResourcesInterface()

void KisPaintOpSettings::setCanvasResourcesInterface ( KoCanvasResourcesInterfaceSP canvasResourcesInterface )

Definition at line 199 of file kis_paintop_settings.cpp.

{
    d->canvasResourcesInterface = canvasResourcesInterface;
}

References canvasResourcesInterface, and d.

◆ setEraserMode()

void KisPaintOpSettings::setEraserMode ( bool value )

Definition at line 413 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    proxy->setProperty("EraserMode", value);
}

References KisLockedPropertiesServer::instance(), and value().

◆ setLodSizeThreshold()

void KisPaintOpSettings::setLodSizeThreshold ( qreal value )

Definition at line 624 of file kis_paintop_settings.cpp.

{
    setProperty("lodSizeThreshold", value);
}

References setProperty(), and value().

◆ setLodUserAllowed()

void KisPaintOpSettings::setLodUserAllowed	(	KisPropertiesConfigurationSP	config,
		bool	value )

static

Definition at line 609 of file kis_paintop_settings.cpp.

{
    config->setProperty("lodUserAllowed", value);
}

References value().

◆ setModelName()

void KisPaintOpSettings::setModelName ( const QString & modelName )

Set filename of 3D brush model. By default no brush is set

Definition at line 483 of file kis_paintop_settings.cpp.

{
    d->modelName = modelName;
}

References d, and modelName.

◆ setPaintOpAngle()

virtual void KisPaintOpSettings::setPaintOpAngle ( qreal value )

pure virtual

Set paintop angle (in degrees) directly in the properties. Increasing the angle corresponds to a counter-clockwise rotation.

Implemented in KisNoSizePaintOpSettings, KisCurvePaintOpSettings, KisDeformPaintOpSettings, KisGridPaintOpSettings, KisBrushBasedPaintOpSettings, KisMyPaintOpSettings, KisRoundMarkerOpSettings, and KisSprayPaintOpSettings.

◆ setPaintOpCompositeOp()

void KisPaintOpSettings::setPaintOpCompositeOp ( const QString & value )

Set paintop composite mode directly in the properties

Definition at line 344 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    proxy->setProperty("CompositeOp", value);
}

References KisLockedPropertiesServer::instance(), and value().

◆ setPaintOpFade()

void KisPaintOpSettings::setPaintOpFade ( qreal value )

Set paintop fade directly in the properties

Definition at line 313 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    if (!proxy->hasProperty("brush_definition")) return;
 
    // Setting the Fade value is a bit more complex.
    QDomDocument doc;
    doc.setContent(proxy->getString("brush_definition"));
 
    QDomElement element = doc.documentElement();
    QDomElement elementChild = element.elementsByTagName("MaskGenerator").item(0).toElement();
 
    elementChild.attributeNode("hfade").setValue(KisDomUtils::toString(value));
    elementChild.attributeNode("vfade").setValue(KisDomUtils::toString(value));
 
    proxy->setProperty("brush_definition", doc.toString());
}

References KisLockedPropertiesServer::instance(), KisDomUtils::toString(), and value().

◆ setPaintOpFlow()

void KisPaintOpSettings::setPaintOpFlow ( qreal value )

Set paintop flow directly in the properties

Definition at line 305 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    proxy->setProperty("FlowValue", value);
}

References KisLockedPropertiesServer::instance(), and value().

◆ setPaintOpOpacity()

void KisPaintOpSettings::setPaintOpOpacity ( qreal value )

virtual

Set paintop opacity directly in the properties

Reimplemented in KisMyPaintOpSettings.

Definition at line 297 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    proxy->setProperty("OpacityValue", value);
}

References KisLockedPropertiesServer::instance(), and value().

◆ setPaintOpScatter()

void KisPaintOpSettings::setPaintOpScatter ( qreal value )

Set paintop scatter directly in the properties

Definition at line 333 of file kis_paintop_settings.cpp.

{
    KisLockedPropertiesProxySP proxy(
                KisLockedPropertiesServer::instance()->createLockedPropertiesProxy(this));
 
    if (!proxy->hasProperty("PressureScatter")) return;
 
    proxy->setProperty("ScatterValue", value);
    proxy->setProperty("PressureScatter", !qFuzzyIsNull(value));
}

References KisLockedPropertiesServer::instance(), qFuzzyIsNull(), and value().

◆ setPaintOpSize()

virtual void KisPaintOpSettings::setPaintOpSize ( qreal value )

pure virtual

Set paintop size directly in the properties

Implemented in KisNoSizePaintOpSettings, KisCurvePaintOpSettings, KisDeformPaintOpSettings, KisGridPaintOpSettings, KisBrushBasedPaintOpSettings, KisMyPaintOpSettings, KisRoundMarkerOpSettings, and KisSprayPaintOpSettings.

◆ setProperty()

void KisPaintOpSettings::setProperty	(	const QString &	name,
		const QVariant &	value )

overridevirtual

Overrides the method in KisPropertiesConfiguration to allow onPropertyChanged() callback

Reimplemented from KisPropertiesConfiguration.

Definition at line 573 of file kis_paintop_settings.cpp.

{
    if (value != KisPropertiesConfiguration::getProperty(name)) {
        UpdateListenerSP updateListener = d->updateListener.toStrongRef();
 
        if (updateListener) {
            updateListener->setDirty(true);
        }
    }
 
    KisPropertiesConfiguration::setProperty(name, value);
    onPropertyChanged();
}

References d, KisPropertiesConfiguration::getProperty(), onPropertyChanged(), KisPropertiesConfiguration::setProperty(), updateListener, and value().

◆ setResourceCacheInterface()

void KisPaintOpSettings::setResourceCacheInterface ( KoResourceCacheInterfaceSP cacheInterface )

virtual

Reimplemented in KisBrushBasedPaintOpSettings.

Definition at line 204 of file kis_paintop_settings.cpp.

{
    d->resourceCacheInterface = cacheInterface;
}

References d.

◆ setResourcesInterface()

void KisPaintOpSettings::setResourcesInterface ( KisResourcesInterfaceSP resourcesInterface )

Set resource interface that will be used for loading linked resources

Definition at line 247 of file kis_paintop_settings.cpp.

{
    d->resourcesInterface = resourcesInterface;
}

References d, and resourcesInterface.

◆ setSavedBrushOpacity()

void KisPaintOpSettings::setSavedBrushOpacity ( qreal value )

Definition at line 472 of file kis_paintop_settings.cpp.

{
    setProperty("SavedBrushOpacity", value);
    setPropertyNotSaved("SavedBrushOpacity");
}

References setProperty(), KisPropertiesConfiguration::setPropertyNotSaved(), and value().

◆ setSavedBrushSize()

void KisPaintOpSettings::setSavedBrushSize ( qreal value )

Definition at line 450 of file kis_paintop_settings.cpp.

{
    setProperty("SavedBrushSize", value);
    setPropertyNotSaved("SavedBrushSize");
}

References setProperty(), KisPropertiesConfiguration::setPropertyNotSaved(), and value().

◆ setSavedEraserOpacity()

void KisPaintOpSettings::setSavedEraserOpacity ( qreal value )

Definition at line 461 of file kis_paintop_settings.cpp.

{
    setProperty("SavedEraserOpacity", value);
    setPropertyNotSaved("SavedEraserOpacity");
}

References setProperty(), KisPropertiesConfiguration::setPropertyNotSaved(), and value().

◆ setSavedEraserSize()

void KisPaintOpSettings::setSavedEraserSize ( qreal value )

Definition at line 439 of file kis_paintop_settings.cpp.

{
    setProperty("SavedEraserSize", value);
    setPropertyNotSaved("SavedEraserSize");
}

References setProperty(), KisPropertiesConfiguration::setPropertyNotSaved(), and value().

◆ setUpdateListener()

void KisPaintOpSettings::setUpdateListener ( UpdateListenerWSP listener )

Definition at line 114 of file kis_paintop_settings.cpp.

{
    d->updateListener = listener;
}

References d.

◆ uniformProperties()

virtual QList< KisUniformPaintOpPropertySP > KisPaintOpSettings::uniformProperties	(	KisPaintOpSettingsSP	settings,
		QPointer< KisPaintOpPresetUpdateProxy >	updateProxy )

virtual

Reimplemented in KisColorSmudgeOpSettings, KisCurvePaintOpSettings, KisBrushOpSettings, KisDuplicateOpSettings, KisDeformPaintOpSettings, KisExperimentPaintOpSettings, KisGridPaintOpSettings, KisHatchingPaintOpSettings, KisBrushBasedPaintOpSettings, KisParticlePaintOpSettings, KisRoundMarkerOpSettings, and KisSprayPaintOpSettings.

◆ updateListener()

UpdateListenerWSP KisPaintOpSettings::updateListener ( ) const

◆ useSpacingUpdates()

bool KisPaintOpSettings::useSpacingUpdates ( ) const

virtual

Indicates whether this configuration allows spacing information to be updated between painted dabs during a stroke.

Definition at line 514 of file kis_paintop_settings.cpp.

{
    return getBool(SPACING_USE_UPDATES, false);
}

References KisPropertiesConfiguration::getBool(), and SPACING_USE_UPDATES.

Member Data Documentation

◆ canvasResourcesInterface

KoCanvasResourcesInterfaceSP KisPaintOpSettings::canvasResourcesInterface

Definition at line 84 of file kis_paintop_settings.cpp.

◆ d

const QScopedPointer<Private> KisPaintOpSettings::d

private

Definition at line 390 of file kis_paintop_settings.h.

◆ modelName

QString KisPaintOpSettings::modelName

Definition at line 80 of file kis_paintop_settings.cpp.

◆ resourceCacheInterface

KoResourceCacheInterfaceSP KisPaintOpSettings::resourceCacheInterface

Definition at line 85 of file kis_paintop_settings.cpp.

◆ resourcesInterface

KisResourcesInterfaceSP KisPaintOpSettings::resourcesInterface

Definition at line 83 of file kis_paintop_settings.cpp.

◆ settingsWidget

QPointer<KisPaintOpConfigWidget> KisPaintOpSettings::settingsWidget

Definition at line 79 of file kis_paintop_settings.cpp.

◆ uniformProperties

QList< KisUniformPaintOpPropertySP > KisPaintOpSettings::uniformProperties

Definition at line 82 of file kis_paintop_settings.cpp.

◆ updateListener

KisPaintOpSettings::UpdateListenerWSP KisPaintOpSettings::updateListener

Definition at line 81 of file kis_paintop_settings.cpp.

◆ versionCookie

quint64 KisPaintOpSettings::versionCookie

Definition at line 89 of file kis_paintop_settings.cpp.

◆ versionRandomSource

KisRandomSource KisPaintOpSettings::versionRandomSource

Definition at line 88 of file kis_paintop_settings.cpp.

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

libs/image/brushengine/kis_paintop_settings.cpp
libs/image/brushengine/kis_paintop_settings.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ UpdateListenerSP

◆ UpdateListenerWSP

Constructor & Destructor Documentation

◆ KisPaintOpSettings() [1/2]

◆ ~KisPaintOpSettings()

◆ KisPaintOpSettings() [2/2]

Member Function Documentation

◆ activate()

◆ airbrushInterval()

◆ brushOutline()

◆ canvasResourcesInterface()

◆ clone()

◆ createMaskingSettings()

◆ effectivePaintOpCompositeOp()

◆ ellipseOutline()

◆ eraserMode()

◆ hasMaskingSettings()

◆ hasPatternSettings()

◆ indirectPaintingCompositeOp()

◆ isAirbrushing()

◆ isLodUserAllowed()

◆ isValid()

◆ lodSizeThreshold()

◆ lodSizeThresholdSupported()

◆ makeTiltIndicator()

◆ maskingBrushCompositeOp()

◆ modelName()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ needsAsynchronousUpdates()

◆ node()

◆ onPropertyChanged()

◆ paintIncremental()

◆ paintOpAngle()

◆ paintOpCompositeOp()

◆ paintOpFade()

◆ paintOpFlow()

◆ paintOpOpacity()

◆ paintOpPatternSize()

◆ paintOpScatter()

◆ paintOpSize()

◆ Private() [1/2]

◆ Private() [2/2]

◆ regenerateResourceCache()

◆ requiredCanvasResources()

◆ resetSettings()

◆ resourceCacheInterface()

◆ resourcesInterface()

◆ sanityVersionCookie()

◆ savedBrushOpacity()

◆ savedBrushSize()

◆ savedEraserOpacity()

◆ savedEraserSize()

◆ setCanvasResourcesInterface()

◆ setEraserMode()

◆ setLodSizeThreshold()

◆ setLodUserAllowed()

◆ setModelName()

◆ setPaintOpAngle()

◆ setPaintOpCompositeOp()

◆ setPaintOpFade()

◆ setPaintOpFlow()

◆ setPaintOpOpacity()

◆ setPaintOpScatter()

◆ setPaintOpSize()

◆ setProperty()

◆ setResourceCacheInterface()

◆ setResourcesInterface()

◆ setSavedBrushOpacity()

◆ setSavedBrushSize()

◆ setSavedEraserOpacity()