#include <kis_deform_paintop_settings.h>

Inheritance diagram for KisDeformPaintOpSettings:

Classes
struct	Private

Public Member Functions
KisOptimizedBrushOutline	brushOutline (const KisPaintInformation &info, const OutlineMode &mode, qreal alignForZoom) override

bool	isAirbrushing () const override

	KisDeformPaintOpSettings (KisResourcesInterfaceSP resourcesInterface)

bool	paintIncremental () override

qreal	paintOpAngle () const override

qreal	paintOpSize () const override

void	setPaintOpAngle (qreal value) override

void	setPaintOpSize (qreal value) override

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

	~KisDeformPaintOpSettings () override

Public Member Functions inherited from KisOutlineGenerationPolicy< KisPaintOpSettings >
	KisOutlineGenerationPolicy (KisCurrentOutlineFetcher::Options options, KisResourcesInterfaceSP resourcesInterface)

void	onPropertyChanged () override

const KisCurrentOutlineFetcher *	outlineFetcher () const

	~KisOutlineGenerationPolicy () override

Public Member Functions inherited from KisPaintOpSettings
virtual void	activate ()

virtual qreal	airbrushInterval () const

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	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

QString	paintOpCompositeOp ()

qreal	paintOpFade ()

qreal	paintOpFlow ()

virtual qreal	paintOpOpacity ()

virtual qreal	paintOpPatternSize ()

qreal	paintOpScatter ()

	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)

void	setPaintOpCompositeOp (const QString &value)

void	setPaintOpFade (qreal value)

void	setPaintOpFlow (qreal value)

virtual void	setPaintOpOpacity (qreal value)

void	setPaintOpScatter (qreal value)

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

virtual void	setRandomOffset (const KisPaintInformation &paintInformation)

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)

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 ()

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Types inherited from KisPaintOpSettings
using	UpdateListenerSP = QSharedPointer<UpdateListener>

using	UpdateListenerWSP = QWeakPointer<UpdateListener>

Static Public Member Functions inherited from KisPaintOpSettings
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 inherited from KisPaintOpSettings
KoCanvasResourcesInterfaceSP	canvasResourcesInterface

bool	disableDirtyNotifications

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 inherited from KisShared
	KisShared ()

	~KisShared ()

Detailed Description

Definition at line 15 of file kis_deform_paintop_settings.h.

Constructor & Destructor Documentation

◆ KisDeformPaintOpSettings()

KisDeformPaintOpSettings::KisDeformPaintOpSettings ( KisResourcesInterfaceSP resourcesInterface )

Definition at line 20 of file kis_deform_paintop_settings.cpp.

    : KisOutlineGenerationPolicy<KisPaintOpSettings>(KisCurrentOutlineFetcher::SIZE_OPTION |
                                                     KisCurrentOutlineFetcher::ROTATION_OPTION,
                                                     resourcesInterface),
    m_d(new Private)
{
}

◆ ~KisDeformPaintOpSettings()

KisDeformPaintOpSettings::~KisDeformPaintOpSettings ( )

override

Definition at line 28 of file kis_deform_paintop_settings.cpp.

29{

30}

Member Function Documentation

◆ brushOutline()

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

overridevirtual

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 from KisPaintOpSettings.

Definition at line 73 of file kis_deform_paintop_settings.cpp.

{
    KisOptimizedBrushOutline path;
    if (mode.isVisible) {
        qreal width = getInt("Brush/diameter");
        qreal height = getInt("Brush/diameter") * getDouble("Brush/aspect");
        path = ellipseOutline(width, height, getDouble("Brush/scale"), -getDouble("Brush/rotation"));
 
        path = outlineFetcher()->fetchOutline(info, this, path, mode, alignForZoom);
 
        if (mode.showTiltDecoration) {
            QPainterPath tiltLine = makeTiltIndicator(info, QPointF(0.0, 0.0), width * 0.5, 3.0);
            path.addPath(outlineFetcher()->fetchOutline(info, this, tiltLine, mode, alignForZoom, 1.0, 0.0, true, 0, 0));
        }
    }
    return path;
}

References KisPaintOpSettings::ellipseOutline(), KisCurrentOutlineFetcher::fetchOutline(), KisPropertiesConfiguration::getDouble(), KisPropertiesConfiguration::getInt(), KisPaintOpSettings::OutlineMode::isVisible, KisPaintOpSettings::makeTiltIndicator(), KisOutlineGenerationPolicy< KisPaintOpSettings >::outlineFetcher(), and KisPaintOpSettings::OutlineMode::showTiltDecoration.

◆ isAirbrushing()

bool KisDeformPaintOpSettings::isAirbrushing ( ) const

overridevirtual

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 from KisPaintOpSettings.

Definition at line 62 of file kis_deform_paintop_settings.cpp.

{
    // version 2.3
    if (hasProperty(AIRBRUSH_ENABLED)) {
        return getBool(AIRBRUSH_ENABLED);
    }
    else {
        return getBool("Deform/useMovementPaint");
    }
}

References AIRBRUSH_ENABLED, KisPropertiesConfiguration::getBool(), and KisPropertiesConfiguration::hasProperty().

◆ paintIncremental()

bool KisDeformPaintOpSettings::paintIncremental ( )

overridevirtual

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 from KisPaintOpSettings.

Definition at line 57 of file kis_deform_paintop_settings.cpp.

{
    return true;
}

◆ paintOpAngle()

qreal KisDeformPaintOpSettings::paintOpAngle ( ) const

overridevirtual

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

Implements KisPaintOpSettings.

Definition at line 52 of file kis_deform_paintop_settings.cpp.

{
    return 0.0;
}

◆ paintOpSize()

qreal KisDeformPaintOpSettings::paintOpSize ( ) const

overridevirtual

Returns: size saved in the properties

Implements KisPaintOpSettings.

Definition at line 40 of file kis_deform_paintop_settings.cpp.

{
    KisBrushSizeOptionData option;
    option.read(this);
    return option.brushDiameter;
}

References KisBrushSizeOptionData::brushDiameter, and KisBrushSizeOptionData::read().

◆ setPaintOpAngle()

void KisDeformPaintOpSettings::setPaintOpAngle ( qreal value )

overridevirtual

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

Implements KisPaintOpSettings.

Definition at line 47 of file kis_deform_paintop_settings.cpp.

{
    Q_UNUSED(value);
}

References value().

◆ setPaintOpSize()

void KisDeformPaintOpSettings::setPaintOpSize ( qreal value )

overridevirtual

Set paintop size directly in the properties

Implements KisPaintOpSettings.

Definition at line 32 of file kis_deform_paintop_settings.cpp.

{
    KisBrushSizeOptionData option;
    option.read(this);
    option.brushDiameter = value;
    option.write(this);
}

References KisBrushSizeOptionData::brushDiameter, KisBrushSizeOptionData::read(), value(), and KisBrushSizeOptionData::write().

◆ uniformProperties()

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

overridevirtual

Reimplemented from KisPaintOpSettings.

Definition at line 99 of file kis_deform_paintop_settings.cpp.

{
    QList<KisUniformPaintOpPropertySP> props =
        listWeakToStrong(m_d->uniformProperties);
 
    if (props.isEmpty()) {
        {
            KisDoubleSliderBasedPaintOpPropertyCallback *prop =
                new KisDoubleSliderBasedPaintOpPropertyCallback(KisDoubleSliderBasedPaintOpPropertyCallback::Double,
                                                                KoID("deform_amount", i18n("Amount")),
                                                                settings,
                                                                0);
 
            prop->setRange(0.01, 1.0);
            prop->setSingleStep(0.01);
            prop->setDecimals(2);
 
            prop->setReadCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisDeformOptionData option;
                    option.read(prop->settings().data());
                    prop->setValue(option.deformAmount);
                });
            prop->setWriteCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisDeformOptionData option;
                    option.read(prop->settings().data());
                    option.deformAmount = prop->value().toReal();
                    option.write(prop->settings().data());
                });
 
            QObject::connect(updateProxy, SIGNAL(sigSettingsChanged()), prop, SLOT(requestReadValue()));
            prop->requestReadValue();
            props << toQShared(prop);
        }
 
        {
            KisComboBasedPaintOpPropertyCallback *prop = new KisComboBasedPaintOpPropertyCallback(KoID("deform_mode", i18n("Deform Mode")), settings, 0);
 
            QList<QString> modes;
            modes << i18nc("Grow as in deform brush engine", "Grow");
            modes << i18nc("Shrink as in deform brush engine", "Shrink");
            modes << i18n("Swirl CW");
            modes << i18n("Swirl CCW");
            modes << i18n("Move");
            modes << i18n("Lens Zoom In");
            modes << i18n("Lens Zoom Out");
            modes << i18nc("Rearrange the positions of the pixels under the cursor", "Color Deformation");
 
            prop->setItems(modes);
 
            prop->setReadCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisDeformOptionData option;
                    option.read(prop->settings().data());
                    prop->setValue(int(option.deformAction) - 1); // DeformModes start at 1, combobox indices start at 0
                });
            prop->setWriteCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisDeformOptionData option;
                    option.read(prop->settings().data());
                    option.deformAction = (DeformModes)(prop->value().toInt() + 1); // Combobox indices start at 0, DeformModes start at 1
                    option.write(prop->settings().data());
                });
 
            QObject::connect(updateProxy, SIGNAL(sigSettingsChanged()), prop, SLOT(requestReadValue()));
            prop->requestReadValue();
            props << toQShared(prop);
        }
 
 
        {
            KisIntSliderBasedPaintOpPropertyCallback *prop =
                new KisIntSliderBasedPaintOpPropertyCallback(KisIntSliderBasedPaintOpPropertyCallback::Int,
                                                             KisIntSliderBasedPaintOpPropertyCallback::SubType_Angle,
                                                             KoID("deform_angle", i18n("Angle")),
                                                             settings,
                                                             0);
 
            const QString degree(QStringLiteral("°"));
            prop->setRange(0, 360);
            prop->setSingleStep(1);
            prop->setSuffix(degree);
 
            prop->setReadCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisBrushSizeOptionData option;
                    option.read(prop->settings().data());
 
                    prop->setValue(int(option.brushRotation));
                });
            prop->setWriteCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisBrushSizeOptionData option;
                    option.read(prop->settings().data());
                    option.brushRotation = prop->value().toInt();
                    option.write(prop->settings().data());
                });
 
            QObject::connect(updateProxy, SIGNAL(sigSettingsChanged()), prop, SLOT(requestReadValue()));
            prop->requestReadValue();
            props << toQShared(prop);
        }
    }
 
    {
        using namespace KisStandardUniformPropertiesFactory;
 
        Q_FOREACH (KisUniformPaintOpPropertySP prop, KisPaintOpSettings::uniformProperties(settings, updateProxy)) {
            if (prop->id() == opacity.id() ||
                prop->id() == size.id()) {
                props.prepend(prop);
            }
        }
    }
 
    return props;
}

References KisBrushSizeOptionData::brushRotation, KisDeformOptionData::deformAction, KisDeformOptionData::deformAmount, listWeakToStrong(), m_d, KisBrushSizeOptionData::read(), KisDeformOptionData::read(), KisCallbackBasedPaintopProperty< ParentClass >::setReadCallback(), KisCallbackBasedPaintopProperty< ParentClass >::setWriteCallback(), toQShared(), KisPaintOpSettings::uniformProperties, KisBrushSizeOptionData::write(), and KisDeformOptionData::write().

Member Data Documentation

◆ m_d

const QScopedPointer<Private> KisDeformPaintOpSettings::m_d

private

Definition at line 37 of file kis_deform_paintop_settings.h.

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

plugins/paintops/deform/kis_deform_paintop_settings.h
plugins/paintops/deform/kis_deform_paintop_settings.cpp

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisDeformPaintOpSettings()

◆ ~KisDeformPaintOpSettings()

Member Function Documentation

◆ brushOutline()

◆ isAirbrushing()

◆ paintIncremental()

◆ paintOpAngle()

◆ paintOpSize()

◆ setPaintOpAngle()

◆ setPaintOpSize()

◆ uniformProperties()

Member Data Documentation

◆ m_d