KisFilterOp Class Reference

#include <kis_filterop.h>

Inheritance diagram for KisFilterOp:

Public Member Functions
	KisFilterOp (const KisPaintOpSettingsSP settings, KisPainter *painter, KisNodeSP node, KisImageSP image)
	~KisFilterOp () override
Public Member Functions inherited from KisBrushBasedPaintOp
bool	canPaint () const override
	Reimplemented, false if brush is 0.
bool	checkSizeTooSmall (qreal scale)
KisSpacingInformation	effectiveSpacing (qreal scale) const
KisSpacingInformation	effectiveSpacing (qreal scale, qreal rotation, const KisAirbrushOptionData *airbrushOption, const KisSpacingOption *spacingOption, const KisPaintInformation &pi) const
KisSpacingInformation	effectiveSpacing (qreal scale, qreal rotation, const KisPaintInformation &pi) const
KisSpacingInformation	effectiveSpacing (qreal scale, qreal rotation, const KisSpacingOption &spacingOption, const KisPaintInformation &pi) const
	KisBrushBasedPaintOp (const KisPaintOpSettingsSP settings, KisPainter *painter, KisBrushTextureFlags textureFlags=None)
	~KisBrushBasedPaintOp () override
Public Member Functions inherited from KisPaintOp
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 >	prepareEmbeddedResources (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface)
static QList< KoResourceLoadResult >	prepareLinkedResources (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface)
Static Public Member Functions inherited from KisBrushBasedPaintOp
static QList< KoResourceLoadResult >	prepareEmbeddedResources (const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface)
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
Protected Member Functions inherited from KisPaintOp
KisFixedPaintDeviceSP	cachedDab ()
KisFixedPaintDeviceSP	cachedDab (const KoColorSpace *cs)
KisPainter *	painter () const
KisPaintDeviceSP	source () const
virtual KisTimingInformation	updateTimingImpl (const KisPaintInformation &info) const
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Private Attributes
KisFilterSP	m_filter
KisFilterConfigurationSP	m_filterConfiguration
KisRotationOption	m_rotationOption
KisSizeOption	m_sizeOption
bool	m_smudgeMode
KisPaintDeviceSP	m_tmpDevice

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
Protected Attributes inherited from KisBrushBasedPaintOp
KisBrushSP	m_brush
KisDabCache *	m_dabCache
KisMirrorOption	m_mirrorOption
KisPrecisionOption	m_precisionOption

Detailed Description

Definition at line 23 of file kis_filterop.h.

Constructor & Destructor Documentation

KisFilterOp()

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

Definition at line 40 of file kis_filterop.cpp.

    : KisBrushBasedPaintOp(settings, painter)
    , m_sizeOption(settings.data())
    , m_rotationOption(settings.data())
    , m_filterConfiguration(0)
{
    Q_UNUSED(node);
    Q_UNUSED(image);
    Q_ASSERT(settings);
    Q_ASSERT(painter);
 
    m_tmpDevice = source()->createCompositionSourceDevice();
 
    KisFilterOptionData data;
    data.read(settings.data());
 
    m_filter = KisFilterRegistry::instance()->get(data.filterId);
    if (m_filter) {
        m_filterConfiguration = m_filter->factoryConfiguration(settings->resourcesInterface());
        m_filterConfiguration->fromXML(data.filterConfig);
    }
    m_smudgeMode = data.smudgeMode;
 
    m_rotationOption.applyFanCornersInfo(this);
}

References KisRotationOption::applyFanCornersInfo(), KisPaintDevice::createCompositionSourceDevice(), KisSharedPtr< T >::data(), KisBaseProcessor::factoryConfiguration(), KisFilterOptionData::filterConfig, KisFilterOptionData::filterId, KoGenericRegistry< T >::get(), KisFilterRegistry::instance(), m_filter, m_filterConfiguration, m_rotationOption, m_smudgeMode, m_tmpDevice, KisPaintOp::painter, KisFilterOptionData::read(), KisFilterOptionData::smudgeMode, and KisPaintOp::source().

~KisFilterOp()

KisFilterOp::~KisFilterOp ( )

override

Definition at line 66 of file kis_filterop.cpp.

{
}

Member Function Documentation

paintAt()

KisSpacingInformation KisFilterOp::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 70 of file kis_filterop.cpp.

{
    if (!painter()) {
        return KisSpacingInformation(1.0);
    }
 
    if (!m_filter) {
        return KisSpacingInformation(1.0);
    }
 
    if (!source()) {
        return KisSpacingInformation(1.0);
    }
 
    KisBrushSP brush = m_brush;
    if (!brush) return KisSpacingInformation(1.0);
 
    if (! brush->canPaintFor(info))
        return KisSpacingInformation(1.0);
 
    qreal scale = m_sizeOption.apply(info);
    scale *= KisLodTransform::lodToScale(painter()->device());
    if (checkSizeTooSmall(scale)) return KisSpacingInformation();
    qreal rotation = m_rotationOption.apply(info);
    KisDabShape shape(scale, 1.0, rotation);
 
    static const KoColorSpace *cs = KoColorSpaceRegistry::instance()->alpha8();
    static KoColor color(Qt::black, cs);
 
    QRect dstRect;
    KisFixedPaintDeviceSP dab = m_dabCache->fetchDab(cs, color, info.pos(),
                                                     shape,
                                                     info, 1.0,
                                                     &dstRect);
 
    if (dstRect.isEmpty()) return KisSpacingInformation(1.0);
 
    QRect dabRect = dab->bounds();
 
    // sanity check
    Q_ASSERT(dstRect.size() == dabRect.size());
 
 
    // Filter the paint device
    QRect neededRect = m_filter->neededRect(dstRect, m_filterConfiguration, painter()->device()->defaultBounds()->currentLevelOfDetail());
 
    KisPainter p(m_tmpDevice);
    if (!m_smudgeMode) {
        p.setCompositeOpId(COMPOSITE_COPY);
    }
    p.bitBltOldData(neededRect.topLeft(), source(), neededRect);
 
    KisTransaction transaction(m_tmpDevice);
    m_filter->process(m_tmpDevice, dstRect, m_filterConfiguration, 0);
    transaction.end();
 
    painter()->bitBltWithFixedSelection(dstRect.x(), dstRect.y(),
                                        m_tmpDevice, dab,
                                        0, 0,
                                        dstRect.x(), dstRect.y(),
                                        dabRect.width(), dabRect.height());
 
    painter()->renderMirrorMaskSafe(dstRect, m_tmpDevice, 0, 0, dab,
                                    !m_dabCache->needSeparateOriginal());
 
    return effectiveSpacing(scale, rotation, info);
}

References KoColorSpaceRegistry::alpha8(), KisRotationOption::apply(), KisStandardOption< Data >::apply(), KisPainter::bitBltWithFixedSelection(), KisFixedPaintDevice::bounds(), KisBrushBasedPaintOp::checkSizeTooSmall(), COMPOSITE_COPY, KisPaintOp::dab, KisBrushBasedPaintOp::effectiveSpacing(), KisTransaction::end(), KisDabCache::fetchDab(), KoColorSpaceRegistry::instance(), KisLodTransformBase::lodToScale(), KisBrushBasedPaintOp::m_brush, KisBrushBasedPaintOp::m_dabCache, m_filter, m_filterConfiguration, m_rotationOption, m_sizeOption, m_smudgeMode, m_tmpDevice, KisFilter::neededRect(), KisDabCache::needSeparateOriginal(), p, KisPaintOp::painter, KisPaintInformation::pos(), KisFilter::process(), KisPainter::renderMirrorMaskSafe(), and KisPaintOp::source().

prepareEmbeddedResources()

QList< KoResourceLoadResult > KisFilterOp::prepareEmbeddedResources ( const KisPaintOpSettingsSP settings, KisResourcesInterfaceSP resourcesInterface )

static

Definition at line 162 of file kis_filterop.cpp.

{
    QList<KoResourceLoadResult> resources = KisBrushBasedPaintOp::prepareEmbeddedResources(settings, resourcesInterface);
 
    KisFilterOptionData data;
    data.read(settings.data());
 
    KisFilterSP filter = KisFilterRegistry::instance()->get(data.filterId);
    if (filter) {
        KisFilterConfigurationSP config = filter->factoryConfiguration(settings->resourcesInterface());
        config->fromXML(data.filterConfig);
        resources << config->embeddedResources(resourcesInterface);
    }
 
    return resources;
}

References KisSharedPtr< T >::data(), KisBaseProcessor::factoryConfiguration(), KisFilterOptionData::filterConfig, KisFilterOptionData::filterId, KoGenericRegistry< T >::get(), KisFilterRegistry::instance(), KisBrushBasedPaintOp::prepareEmbeddedResources(), and KisFilterOptionData::read().

prepareLinkedResources()

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

static

Definition at line 145 of file kis_filterop.cpp.

{
    QList<KoResourceLoadResult> resources = KisBrushBasedPaintOp::prepareLinkedResources(settings, resourcesInterface);
 
    KisFilterOptionData data;
    data.read(settings.data());
 
    KisFilterSP filter = KisFilterRegistry::instance()->get(data.filterId);
    if (filter) {
        KisFilterConfigurationSP config = filter->factoryConfiguration(settings->resourcesInterface());
        config->fromXML(data.filterConfig);
        resources << config->linkedResources(resourcesInterface);
    }
 
    return resources;
}

References KisSharedPtr< T >::data(), KisBaseProcessor::factoryConfiguration(), KisFilterOptionData::filterConfig, KisFilterOptionData::filterId, KoGenericRegistry< T >::get(), KisFilterRegistry::instance(), KisBrushBasedPaintOp::prepareLinkedResources(), and KisFilterOptionData::read().

updateSpacingImpl()

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

overrideprotectedvirtual

Implementation of a spacing update

Implements KisPaintOp.

Definition at line 138 of file kis_filterop.cpp.

{
    const qreal scale = m_sizeOption.apply(info) * KisLodTransform::lodToScale(painter()->device());
    const qreal rotation = m_rotationOption.apply(info);
    return effectiveSpacing(scale, rotation, info);
}

References KisRotationOption::apply(), KisStandardOption< Data >::apply(), KisBrushBasedPaintOp::effectiveSpacing(), KisLodTransformBase::lodToScale(), m_rotationOption, m_sizeOption, and KisPaintOp::painter.

Member Data Documentation

m_filter

KisFilterSP KisFilterOp::m_filter

private

Definition at line 45 of file kis_filterop.h.

m_filterConfiguration

KisFilterConfigurationSP KisFilterOp::m_filterConfiguration

private

Definition at line 46 of file kis_filterop.h.

m_rotationOption

KisRotationOption KisFilterOp::m_rotationOption

private

Definition at line 44 of file kis_filterop.h.

m_sizeOption

KisSizeOption KisFilterOp::m_sizeOption

private

Definition at line 43 of file kis_filterop.h.

m_smudgeMode

bool KisFilterOp::m_smudgeMode

private

Definition at line 47 of file kis_filterop.h.

m_tmpDevice

KisPaintDeviceSP KisFilterOp::m_tmpDevice

private

Definition at line 42 of file kis_filterop.h.

---

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

• plugins/paintops/filterop/kis_filterop.h
• plugins/paintops/filterop/kis_filterop.cpp