KisSprayPaintOp Class Reference

#include <kis_spray_paintop.h>

Inheritance diagram for KisSprayPaintOp:

Public Member Functions
	KisSprayPaintOp (const KisPaintOpSettingsSP settings, KisPainter *painter, KisNodeSP node, KisImageSP image)
	~KisSprayPaintOp () override
Public Member Functions inherited from KisPaintOp
virtual bool	canPaint () const
virtual std::pair< int, bool >	doAsynchronousUpdate (QVector< KisRunnableStrokeJobData * > &jobs)
	KisPaintOp (KisPainter *painter)
void	paintAt (const KisPaintInformation &info, KisDistanceInformation *currentDistance)
virtual void	paintBezierCurve (const KisPaintInformation &pi1, const QPointF &control1, const QPointF &control2, const KisPaintInformation &pi2, KisDistanceInformation *currentDistance)
virtual void	paintLine (const KisPaintInformation &pi1, const KisPaintInformation &pi2, KisDistanceInformation *currentDistance)
	Private (KisPaintOp *_q)
void	updateSpacing (const KisPaintInformation &info, KisDistanceInformation &currentDistance) const
void	updateTiming (const KisPaintInformation &info, KisDistanceInformation &currentDistance) const
virtual	~KisPaintOp ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static QList< KoResourceLoadResult >	prepareLinkedResources (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface)
Static Public Member Functions inherited from KisPaintOp
static void	splitCoordinate (qreal coordinate, qint32 *whole, qreal *fraction)

Protected Member Functions
KisSpacingInformation	paintAt (const KisPaintInformation &info) override
KisSpacingInformation	updateSpacingImpl (const KisPaintInformation &info) const override
KisTimingInformation	updateTimingImpl (const KisPaintInformation &info) const override
Protected Member Functions inherited from KisPaintOp
KisFixedPaintDeviceSP	cachedDab ()
KisFixedPaintDeviceSP	cachedDab (const KoColorSpace *cs)
KisPainter *	painter () const
KisPaintDeviceSP	source () const
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Private Member Functions
KisSpacingInformation	computeSpacing (const KisPaintInformation &info, qreal lodScale) const

Private Attributes
KisAirbrushOptionData	m_airbrushData
KisBrushOptionProperties	m_brushOption
KisColorOptionData	m_colorProperties
KisPaintDeviceSP	m_dab
bool	m_isPresetValid
KisNodeSP	m_node
KisOpacityOption	m_opacityOption
KisRateOption	m_rateOption
KisRotationOption	m_rotationOption
KisSprayShapeDynamicsOptionData	m_shapeDynamicsProperties
KisSprayShapeOptionData	m_shapeProperties
KisSizeOption	m_sizeOption
qreal	m_spacing
SprayBrush	m_sprayBrush
KisSprayOpOption	m_sprayOpOption
qreal	m_xSpacing
qreal	m_ySpacing

Additional Inherited Members
Public Attributes inherited from KisPaintOp
KisFixedPaintDeviceSP	dab
bool	fanCornersEnabled {false}
qreal	fanCornersStep {1.0}
KisPainter *	painter {nullptr}
KisPaintOp *	q {nullptr}
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

Definition at line 27 of file kis_spray_paintop.h.

Constructor & Destructor Documentation

KisSprayPaintOp()

KisSprayPaintOp::KisSprayPaintOp	(	const KisPaintOpSettingsSP	settings,
		KisPainter *	painter,
		KisNodeSP	node,
		KisImageSP	image )

Definition at line 27 of file kis_spray_paintop.cpp.

    : KisPaintOp(painter)
    , m_sprayOpOption(settings.data())
    , m_isPresetValid(true)
    , m_rotationOption(settings.data())
    , m_sizeOption(settings.data())
    , m_opacityOption(settings.data(), node)
    , m_rateOption(settings.data())
    , m_node(node)
    
{
    Q_ASSERT(settings);
    Q_ASSERT(painter);
    Q_UNUSED(image);
 
    m_airbrushData.read(settings.data());
 
    m_brushOption.readOptionSetting(settings, settings->resourcesInterface(), settings->canvasResourcesInterface());
 
    m_colorProperties.read(settings.data());
    // create the actual distribution objects
    m_sprayOpOption.updateDistributions();
    // first load tip properties as shape properties are dependent on diameter/scale/aspect
    m_shapeProperties.read(settings.data());
 
    // TODO: what to do with proportional sizes?
    m_shapeDynamicsProperties.read(settings.data());
 
    if (!m_shapeProperties.enabled && !m_brushOption.brush()) {
        // in case the preset does not contain the definition for KisBrush
        m_isPresetValid = false;
        dbgKrita << "Preset is not valid. Painting is not possible. Use the preset editor to fix current brush engine preset.";
    }
 
    m_sprayBrush.setProperties(&m_sprayOpOption.data, &m_colorProperties,
                               &m_shapeProperties, &m_shapeDynamicsProperties, m_brushOption.brush());
 
    m_sprayBrush.setFixedDab(cachedDab());
 
    // spacing
    if ((m_sprayOpOption.data.diameter * 0.5) > 1) {
        m_ySpacing = m_xSpacing = m_sprayOpOption.data.diameter * 0.5 * m_sprayOpOption.data.spacing;
    }
    else {
        m_ySpacing = m_xSpacing = 1.0;
    }
    m_spacing = m_xSpacing;
}

References KisBrushOptionProperties::brush(), KisPaintOp::cachedDab(), KisSharedPtr< T >::data(), KisSprayOpOption::data, dbgKrita, KisSprayOpOptionData::diameter, KisSprayShapeOptionData::enabled, m_airbrushData, m_brushOption, m_colorProperties, m_isPresetValid, m_shapeDynamicsProperties, m_shapeProperties, m_spacing, m_sprayBrush, m_sprayOpOption, m_xSpacing, m_ySpacing, KisPaintOp::painter, KisAirbrushOptionData::read(), KisColorOptionData::read(), KisSprayShapeDynamicsOptionData::read(), KisSprayShapeOptionData::read(), KisPaintopPropertiesCanvasResourcesBase::readOptionSetting(), SprayBrush::setFixedDab(), SprayBrush::setProperties(), KisSprayOpOptionData::spacing, and KisSprayOpOption::updateDistributions().

~KisSprayPaintOp()

KisSprayPaintOp::~KisSprayPaintOp ( )

override

Definition at line 76 of file kis_spray_paintop.cpp.

{
}

Member Function Documentation

computeSpacing()

KisSpacingInformation KisSprayPaintOp::computeSpacing ( const KisPaintInformation & info, qreal lodScale ) const

private

Definition at line 132 of file kis_spray_paintop.cpp.

{
    return KisPaintOpPluginUtils::effectiveSpacing(1.0, 1.0, true, 0.0, false,
                                                   m_spacing * lodScale, false, 1.0, lodScale,
                                                   &m_airbrushData, nullptr, info);
}

References KisPaintOpPluginUtils::effectiveSpacing(), m_airbrushData, and m_spacing.

paintAt()

KisSpacingInformation KisSprayPaintOp::paintAt ( const KisPaintInformation & info )

overrideprotectedvirtual

The implementation of painting of a dab and updating spacing. This does NOT need to update the timing information.

Implements KisPaintOp.

Definition at line 86 of file kis_spray_paintop.cpp.

{
    if (!painter() || !m_isPresetValid) {
        return KisSpacingInformation(m_spacing);
    }
 
    if (!m_dab) {
        m_dab = source()->createCompositionSourceDevice();
    }
    else {
        m_dab->clear();
    }
 
    qreal rotation = m_rotationOption.apply(info);
    m_opacityOption.apply(painter(), info);
    // Spray Brush is capable of working with zero scale,
    // so no additional checks for 'zero'ness are needed
    const qreal scale = m_sizeOption.apply(info);
    const qreal lodScale = KisLodTransform::lodToScale(painter()->device());
 
 
    m_sprayBrush.paint(m_dab,
                       m_node->paintDevice(),
                       info,
                       rotation,
                       scale, lodScale,
                       painter()->paintColor(),
                       painter()->backgroundColor());
 
    QRect rc = m_dab->extent();
    painter()->bitBlt(rc.topLeft(), m_dab, rc);
    painter()->renderMirrorMask(rc, m_dab);
 
    return computeSpacing(info, lodScale);
}

References KisRotationOption::apply(), KisStandardOption< Data >::apply(), KisOpacityOption::apply(), KisPainter::bitBlt(), KisPaintDevice::clear(), computeSpacing(), KisPaintDevice::createCompositionSourceDevice(), KisPaintDevice::extent(), KisLodTransformBase::lodToScale(), m_dab, m_isPresetValid, m_node, m_opacityOption, m_rotationOption, m_sizeOption, m_spacing, m_sprayBrush, SprayBrush::paint(), KisBaseNode::paintDevice(), KisPaintOp::painter, KisPainter::renderMirrorMask(), and KisPaintOp::source().

prepareLinkedResources()

QList< KoResourceLoadResult > KisSprayPaintOp::prepareLinkedResources ( const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface )

static

Definition at line 80 of file kis_spray_paintop.cpp.

{
    KisBrushOptionProperties brushOption;
    return brushOption.prepareLinkedResources(settings, resourcesInterface);
}

References KisPaintopPropertiesCanvasResourcesBase::prepareLinkedResources().

updateSpacingImpl()

KisSpacingInformation KisSprayPaintOp::updateSpacingImpl ( const KisPaintInformation & info ) const

overrideprotectedvirtual

Implementation of a spacing update

Implements KisPaintOp.

Definition at line 122 of file kis_spray_paintop.cpp.

{
    return computeSpacing(info, KisLodTransform::lodToScale(painter()->device()));
}

References computeSpacing(), KisLodTransformBase::lodToScale(), and KisPaintOp::painter.

updateTimingImpl()

KisTimingInformation KisSprayPaintOp::updateTimingImpl ( const KisPaintInformation & info ) const

overrideprotectedvirtual

Implementation of a timing update. The default implementation always disables timing. This is suitable for paintops that do not support airbrushing.

Reimplemented from KisPaintOp.

Definition at line 127 of file kis_spray_paintop.cpp.

{
    return KisPaintOpPluginUtils::effectiveTiming(&m_airbrushData, &m_rateOption, info);
}

References KisPaintOpPluginUtils::effectiveTiming(), m_airbrushData, and m_rateOption.

Member Data Documentation

m_airbrushData

KisAirbrushOptionData KisSprayPaintOp::m_airbrushData

private

Definition at line 59 of file kis_spray_paintop.h.

m_brushOption

KisBrushOptionProperties KisSprayPaintOp::m_brushOption

private

Definition at line 53 of file kis_spray_paintop.h.

m_colorProperties

KisColorOptionData KisSprayPaintOp::m_colorProperties

private

Definition at line 52 of file kis_spray_paintop.h.

m_dab

KisPaintDeviceSP KisSprayPaintOp::m_dab

private

Definition at line 55 of file kis_spray_paintop.h.

m_isPresetValid

bool KisSprayPaintOp::m_isPresetValid

private

Definition at line 58 of file kis_spray_paintop.h.

m_node

KisNodeSP KisSprayPaintOp::m_node

private

Definition at line 65 of file kis_spray_paintop.h.

m_opacityOption

KisOpacityOption KisSprayPaintOp::m_opacityOption

private

Definition at line 63 of file kis_spray_paintop.h.

m_rateOption

KisRateOption KisSprayPaintOp::m_rateOption

private

Definition at line 64 of file kis_spray_paintop.h.

m_rotationOption

KisRotationOption KisSprayPaintOp::m_rotationOption

private

Definition at line 61 of file kis_spray_paintop.h.

m_shapeDynamicsProperties

KisSprayShapeDynamicsOptionData KisSprayPaintOp::m_shapeDynamicsProperties

private

Definition at line 51 of file kis_spray_paintop.h.

m_shapeProperties

KisSprayShapeOptionData KisSprayPaintOp::m_shapeProperties

private

Definition at line 49 of file kis_spray_paintop.h.

m_sizeOption

KisSizeOption KisSprayPaintOp::m_sizeOption

private

Definition at line 62 of file kis_spray_paintop.h.

m_spacing

qreal KisSprayPaintOp::m_spacing

private

Definition at line 57 of file kis_spray_paintop.h.

m_sprayBrush

SprayBrush KisSprayPaintOp::m_sprayBrush

private

Definition at line 56 of file kis_spray_paintop.h.

m_sprayOpOption

KisSprayOpOption KisSprayPaintOp::m_sprayOpOption

private

Definition at line 50 of file kis_spray_paintop.h.

m_xSpacing

qreal KisSprayPaintOp::m_xSpacing

private

Definition at line 57 of file kis_spray_paintop.h.

m_ySpacing

qreal KisSprayPaintOp::m_ySpacing

private

Definition at line 57 of file kis_spray_paintop.h.

---

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

• plugins/paintops/spray/kis_spray_paintop.h
• plugins/paintops/spray/kis_spray_paintop.cpp