KisGridPaintOpSettings Class Reference

#include <kis_grid_paintop_settings.h>

Inheritance diagram for KisGridPaintOpSettings:

Classes
struct	Private

Public Member Functions
KisOptimizedBrushOutline	brushOutline (const KisPaintInformation &info, const OutlineMode &mode, qreal alignForZoom) override
	KisGridPaintOpSettings (KisResourcesInterfaceSP resourcesInterface)
bool	mousePressEvent (const KisPaintInformation &pos, Qt::KeyboardModifiers modifiers, KisNodeWSP currentNode) override
bool	mouseReleaseEvent () override
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
	~KisGridPaintOpSettings () 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	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	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 ()

Public Attributes
bool	m_modifyOffsetWithShortcut
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

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)
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Definition at line 20 of file kis_grid_paintop_settings.h.

Constructor & Destructor Documentation

KisGridPaintOpSettings()

KisGridPaintOpSettings::KisGridPaintOpSettings

(

KisResourcesInterfaceSP

resourcesInterface

)

Definition at line 23 of file kis_grid_paintop_settings.cpp.

    : KisOutlineGenerationPolicy<KisPaintOpSettings>(KisCurrentOutlineFetcher::NO_OPTION,
                                                     resourcesInterface),
    m_d(new Private),
    m_modifyOffsetWithShortcut(false)
{
}

~KisGridPaintOpSettings()

KisGridPaintOpSettings::~KisGridPaintOpSettings ( )

override

Definition at line 56 of file kis_grid_paintop_settings.cpp.

{
}

Member Function Documentation

brushOutline()

KisOptimizedBrushOutline KisGridPaintOpSettings::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 103 of file kis_grid_paintop_settings.cpp.

{
    KisOptimizedBrushOutline path;
    KisGridOpOptionData option;
    option.read(this);
    KisGridShapeOptionData shapeOption;
    shapeOption.read(this);
    if (mode.isVisible) {
        qreal sizex = option.diameter * option.grid_scale;
        qreal sizey = option.diameter * option.grid_scale;
        QRectF rc(0, 0, sizex, sizey);
        rc.translate(-rc.center());
        path.addRect(rc);
 
        path = outlineFetcher()->fetchOutline(info, this, path, mode, alignForZoom);
 
        if (mode.showTiltDecoration) {
            QPainterPath tiltLine = makeTiltIndicator(info, QPointF(0.0, 0.0), sizex * 0.5, 3.0);
            path.addPath(outlineFetcher()->fetchOutline(info, this, tiltLine, mode, alignForZoom, 1.0, 0.0, true, 0, 0));
        }
    }
    else if (m_modifyOffsetWithShortcut) {
        qreal gridWidth = option.diameter * option.grid_scale ;
        qreal gridHeight = option.diameter * option.grid_scale ;
 
        qreal cellWidth = option.grid_width * option.grid_scale ;
        qreal cellHeight = option.grid_height * option.grid_scale;
 
        qreal horizontalOffset = option.horizontal_offset;
        qreal verticalOffset = option.vertical_offset;
 
        int divide;
        if (option.grid_pressure_division) {
            divide = option.grid_division_level * info.pressure();
        }
        else {
            divide = option.grid_division_level;
        }
 
        divide = qRound(option.grid_scale * divide);
 
        //Adjust the start position of the drawn grid to the top left of the brush instead of in the center
        qreal posX = info.pos().x() - (gridWidth/2) + (cellWidth/2) - horizontalOffset;
        qreal posY = info.pos().y() - (gridHeight/2) + (cellHeight/2) - verticalOffset;
 
        //Lock the grid alignment
        posX = posX - std::fmod(posX, cellWidth) + horizontalOffset;
        posY = posY - std::fmod(posY, cellHeight) + verticalOffset;
        const QRectF dabRect(posX , posY , cellWidth, cellHeight);
 
        divide = qMax(1, divide);
        const qreal yStep = cellHeight / (qreal)divide;
        const qreal xStep = cellWidth / (qreal)divide;
 
        QRectF tile;
        QPainterPath cellPath;
        for (int y = 0; y < (gridHeight)/yStep; y++) {
            for (int x = 0; x < (gridWidth)/xStep; x++) {
                tile = QRectF(dabRect.x() + x * xStep, dabRect.y() + y * yStep, xStep, yStep);
                switch (shapeOption.shape) {
                case 0: {
                    cellPath.addEllipse(tile);
                    break;
                }
                case 1: {
                    cellPath.addRect(tile);
                    break;
                }
                case 2: {
                    cellPath.moveTo(tile.topRight());
                    cellPath.lineTo(tile.bottomLeft());
                    break;
                }
                case 3: {
                    cellPath.moveTo(tile.topRight());
                    cellPath.lineTo(tile.bottomLeft());
                    break;
                }
                case 4: {
                    cellPath.moveTo(tile.topRight());
                    cellPath.lineTo(tile.bottomLeft());
                    break;
                }
                default: {
                break;
                }
                }
            }
        }
        KisOptimizedBrushOutline cellPath2 = outlineFetcher()->fetchOutline(info, this, cellPath, mode, alignForZoom);
        path.addPath(cellPath2);
    }
    return path;
}

References KisOptimizedBrushOutline::addPath(), KisGridOpOptionData::diameter, KisCurrentOutlineFetcher::fetchOutline(), KisGridOpOptionData::grid_division_level, KisGridOpOptionData::grid_height, KisGridOpOptionData::grid_pressure_division, KisGridOpOptionData::grid_scale, KisGridOpOptionData::grid_width, KisGridOpOptionData::horizontal_offset, KisPaintOpSettings::OutlineMode::isVisible, m_modifyOffsetWithShortcut, KisPaintOpSettings::makeTiltIndicator(), KisOutlineGenerationPolicy< KisPaintOpSettings >::outlineFetcher(), KisPaintInformation::pos(), KisPaintInformation::pressure(), KisGridOpOptionData::read(), KisGridShapeOptionData::read(), KisGridShapeOptionData::shape, KisPaintOpSettings::OutlineMode::showTiltDecoration, and KisGridOpOptionData::vertical_offset.

mousePressEvent()

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

overridevirtual

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

Definition at line 67 of file kis_grid_paintop_settings.cpp.

{
    Q_UNUSED(currentNode);
 
    KisGridOpOptionData option;
    option.read(this);
    bool eventIgnored = true;
    qreal newHorizontalOffset = std::fmod(info.pos().x() + option.grid_width/2.0, (float)option.grid_width);
    qreal newVerticalOffset = std::fmod(info.pos().y() + option.grid_height/2.0, (float)option.grid_height);
 
    // If pressing ctrl+alt change the offset according to mouse position
    if (modifiers == (Qt::ControlModifier | Qt::AltModifier) || m_modifyOffsetWithShortcut) {
        m_modifyOffsetWithShortcut = true;
        newHorizontalOffset = (newHorizontalOffset / (float)option.grid_width);
        newVerticalOffset = (newVerticalOffset / (float)option.grid_height);
 
        if (newHorizontalOffset > 0.5) {
            newHorizontalOffset = newHorizontalOffset - 1;
        }
        if (newVerticalOffset > 0.5) {
            newVerticalOffset = newVerticalOffset -1;
        }
        option.horizontal_offset = newHorizontalOffset * option.grid_width;
        option.vertical_offset = newVerticalOffset * option.grid_height;
        option.write(this);
        eventIgnored = false;
    }
    return eventIgnored;
}

References KisGridOpOptionData::grid_height, KisGridOpOptionData::grid_width, KisGridOpOptionData::horizontal_offset, m_modifyOffsetWithShortcut, KisPaintInformation::pos(), KisGridOpOptionData::read(), KisGridOpOptionData::vertical_offset, and KisGridOpOptionData::write().

mouseReleaseEvent()

bool KisGridPaintOpSettings::mouseReleaseEvent ( )

overridevirtual

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

Definition at line 97 of file kis_grid_paintop_settings.cpp.

{
    m_modifyOffsetWithShortcut = false;
    bool ignoreEvent = true;
    return ignoreEvent;
}

References m_modifyOffsetWithShortcut.

paintIncremental()

bool KisGridPaintOpSettings::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 60 of file kis_grid_paintop_settings.cpp.

{
    KisPaintingModeOptionData data;
    data.read(this);
    return data.paintingMode == enumPaintingMode::BUILDUP;
}

References BUILDUP, KisPaintingModeOptionData::paintingMode, and KisPaintingModeOptionData::read().

paintOpAngle()

qreal KisGridPaintOpSettings::paintOpAngle ( ) const

overridevirtual

Returns

paintop angle (in degrees) saved in the properties

Implements KisPaintOpSettings.

Definition at line 51 of file kis_grid_paintop_settings.cpp.

{
    return 0.0;
}

paintOpSize()

qreal KisGridPaintOpSettings::paintOpSize ( ) const

overridevirtual

Returns

size saved in the properties

Implements KisPaintOpSettings.

Definition at line 39 of file kis_grid_paintop_settings.cpp.

{
    KisGridOpOptionData option;
    option.read(this);
    return option.diameter;
}

References KisGridOpOptionData::diameter, and KisGridOpOptionData::read().

setPaintOpAngle()

void KisGridPaintOpSettings::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 46 of file kis_grid_paintop_settings.cpp.

{
    Q_UNUSED(value);
}

References value().

setPaintOpSize()

void KisGridPaintOpSettings::setPaintOpSize ( qreal value )

overridevirtual

Set paintop size directly in the properties

Implements KisPaintOpSettings.

Definition at line 31 of file kis_grid_paintop_settings.cpp.

{
    KisGridOpOptionData option;
    option.read(this);
    option.diameter = value;
    option.write(this);
}

References KisGridOpOptionData::diameter, KisGridOpOptionData::read(), value(), and KisGridOpOptionData::write().

uniformProperties()

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

overridevirtual

Reimplemented from KisPaintOpSettings.

Definition at line 203 of file kis_grid_paintop_settings.cpp.

{
    QList<KisUniformPaintOpPropertySP> props =
        listWeakToStrong(m_d->uniformProperties);
 
    if (props.isEmpty()) {
        {
            KisIntSliderBasedPaintOpPropertyCallback *prop = new KisIntSliderBasedPaintOpPropertyCallback(KisIntSliderBasedPaintOpPropertyCallback::Int,
                                                                                                          KoID("grid_divisionlevel", i18n("Division Level")),
                                                                                                          settings,
                                                                                                          0);
 
            prop->setRange(1, 25);
            prop->setSingleStep(1);
 
            prop->setReadCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisGridOpOptionData option;
                    option.read(prop->settings().data());
 
                    prop->setValue(int(option.grid_division_level));
                });
            prop->setWriteCallback(
                [](KisUniformPaintOpProperty *prop) {
                    KisGridOpOptionData option;
                    option.read(prop->settings().data());
                    option.grid_division_level = prop->value().toInt();
                    option.write(prop->settings().data());
                });
 
            QObject::connect(updateProxy, SIGNAL(sigSettingsChanged()), prop, SLOT(requestReadValue()));
            prop->requestReadValue();
            props << toQShared(prop);
        }
    }
 
    return KisPaintOpSettings::uniformProperties(settings, updateProxy) + props;
}

References KisGridOpOptionData::grid_division_level, listWeakToStrong(), m_d, KisGridOpOptionData::read(), KisCallbackBasedPaintopProperty< ParentClass >::setReadCallback(), KisCallbackBasedPaintopProperty< ParentClass >::setWriteCallback(), toQShared(), KisPaintOpSettings::uniformProperties, and KisGridOpOptionData::write().

Member Data Documentation

m_d

const QScopedPointer<Private> KisGridPaintOpSettings::m_d

private

Definition at line 43 of file kis_grid_paintop_settings.h.

m_modifyOffsetWithShortcut

bool KisGridPaintOpSettings::m_modifyOffsetWithShortcut

Definition at line 46 of file kis_grid_paintop_settings.h.

---

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

• plugins/paintops/gridbrush/kis_grid_paintop_settings.h
• plugins/paintops/gridbrush/kis_grid_paintop_settings.cpp