KisLsOverlayFilter Class Reference

#include <kis_ls_overlay_filter.h>

Inheritance diagram for KisLsOverlayFilter:

Public Types
enum	Mode { Color , Gradient , Pattern }

Public Member Functions
QRect	changedRect (const QRect &rect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment *env) const override
KisLayerStyleFilter *	clone () const override
	KisLsOverlayFilter (Mode mode)
QRect	neededRect (const QRect &rect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment *env) const override
void	processDirectly (KisPaintDeviceSP src, KisMultipleProjection *dst, KisLayerStyleKnockoutBlower *blower, const QRect &applyRect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment *env) const override
Public Member Functions inherited from KisLayerStyleFilter
QString	id () const
	KisLayerStyleFilter (const KoID &id)
virtual	~KisLayerStyleFilter ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Private Member Functions
void	applyOverlay (KisPaintDeviceSP srcDevice, KisMultipleProjection *dst, const QRect &applyRect, const psd_layer_effects_overlay_base *config, KisResourcesInterfaceSP resourcesInterface, KisLayerStyleFilterEnvironment *env) const
const psd_layer_effects_overlay_base *	getOverlayStruct (KisPSDLayerStyleSP style) const
	KisLsOverlayFilter (const KisLsOverlayFilter &rhs)

Private Attributes
Mode	m_mode

Additional Inherited Members
Public Attributes inherited from KisLayerStyleFilter
KoID	id
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame
Protected Member Functions inherited from KisLayerStyleFilter
	KisLayerStyleFilter (const KisLayerStyleFilter &rhs)
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Definition at line 17 of file kis_ls_overlay_filter.h.

Member Enumeration Documentation

Mode

enum KisLsOverlayFilter::Mode

Enumerator
Color
Gradient
Pattern

Definition at line 20 of file kis_ls_overlay_filter.h.

              {
        Color,
        Gradient,
        Pattern
    };

Constructor & Destructor Documentation

KisLsOverlayFilter() [1/2]

KisLsOverlayFilter::KisLsOverlayFilter

(

Mode

mode

)

Definition at line 37 of file kis_ls_overlay_filter.cpp.

    : KisLayerStyleFilter(KoID("lsoverlay", i18n("Overlay (style)"))),
      m_mode(mode)
{
}

KisLsOverlayFilter() [2/2]

KisLsOverlayFilter::KisLsOverlayFilter ( const KisLsOverlayFilter & rhs )

private

Definition at line 43 of file kis_ls_overlay_filter.cpp.

    : KisLayerStyleFilter(rhs),
      m_mode(rhs.m_mode)
{
}

Member Function Documentation

applyOverlay()

void KisLsOverlayFilter::applyOverlay ( KisPaintDeviceSP srcDevice, KisMultipleProjection * dst, const QRect & applyRect, const psd_layer_effects_overlay_base * config, KisResourcesInterfaceSP resourcesInterface, KisLayerStyleFilterEnvironment * env ) const

private

Definition at line 54 of file kis_ls_overlay_filter.cpp.

{
    if (applyRect.isEmpty()) return;
 
    const QString compositeOp = config->blendMode();
    const quint8 opacityU8 = quint8(qRound(255.0 / 100.0 * config->opacity()));
 
    KisPaintDeviceSP dstDevice = dst->getProjection(KisMultipleProjection::defaultProjectionId(),
                                                    compositeOp,
                                                    opacityU8,
                                                    QBitArray(),
                                                    srcDevice);
 
    KisLsUtils::fillOverlayDevice(dstDevice, applyRect, config, resourcesInterface, env);
}

References psd_layer_effects_shadow_base::blendMode(), KisMultipleProjection::defaultProjectionId(), KisLsUtils::fillOverlayDevice(), KisMultipleProjection::getProjection(), and psd_layer_effects_shadow_base::opacity().

changedRect()

QRect KisLsOverlayFilter::changedRect ( const QRect & rect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment * env ) const

overridevirtual

Similar to neededRect: some filters will alter a lot of pixels that are near to each other at the same time. So when you changed a single rectangle in a device, the actual rectangle that will feel the influence of this change might be bigger. Use this function to determine that rect.

Implements KisLayerStyleFilter.

Definition at line 115 of file kis_ls_overlay_filter.cpp.

{
    Q_UNUSED(style);
    Q_UNUSED(env);
    return rect;
}

clone()

KisLayerStyleFilter * KisLsOverlayFilter::clone ( ) const

overridevirtual

Implements KisLayerStyleFilter.

Definition at line 49 of file kis_ls_overlay_filter.cpp.

{
    return new KisLsOverlayFilter(*this);
}

References KisLsOverlayFilter().

getOverlayStruct()

const psd_layer_effects_overlay_base * KisLsOverlayFilter::getOverlayStruct ( KisPSDLayerStyleSP style ) const

private

Definition at line 76 of file kis_ls_overlay_filter.cpp.

{
    const psd_layer_effects_overlay_base *config = 0;
 
    if (m_mode == Color) {
        config = style->colorOverlay();
    } else if (m_mode == Gradient) {
        config = style->gradientOverlay();
    } else if (m_mode == Pattern) {
        config = style->patternOverlay();
    }
 
    return config;
}

References Gradient, m_mode, and Pattern.

neededRect()

QRect KisLsOverlayFilter::neededRect ( const QRect & rect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment * env ) const

overridevirtual

Some filters need pixels outside the current processing rect to compute the new value (for instance, convolution filters)

Implements KisLayerStyleFilter.

Definition at line 108 of file kis_ls_overlay_filter.cpp.

{
    Q_UNUSED(style);
    Q_UNUSED(env);
    return rect;
}

processDirectly()

void KisLsOverlayFilter::processDirectly ( KisPaintDeviceSP src, KisMultipleProjection * dst, KisLayerStyleKnockoutBlower * blower, const QRect & applyRect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment * env ) const

overridevirtual

Implements KisLayerStyleFilter.

Definition at line 91 of file kis_ls_overlay_filter.cpp.

{
    Q_UNUSED(env);
    Q_UNUSED(blower);
    KIS_ASSERT_RECOVER_RETURN(style);
 
    const psd_layer_effects_overlay_base *config = getOverlayStruct(style);
    if (!KisLsUtils::checkEffectEnabled(config, dst)) return;
 
    applyOverlay(src, dst, applyRect, config, style->resourcesInterface(), env);
}

References applyOverlay(), KisLsUtils::checkEffectEnabled(), getOverlayStruct(), and KIS_ASSERT_RECOVER_RETURN.

Member Data Documentation

m_mode

Mode KisLsOverlayFilter::m_mode

private

Definition at line 53 of file kis_ls_overlay_filter.h.

---

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

• libs/image/layerstyles/kis_ls_overlay_filter.h
• libs/image/layerstyles/kis_ls_overlay_filter.cpp