KisLsDropShadowFilter Class Reference

#include <kis_ls_drop_shadow_filter.h>

Inheritance diagram for KisLsDropShadowFilter:

Public Types
enum	Mode { DropShadow , InnerShadow , OuterGlow , InnerGlow }

Public Member Functions
QRect	changedRect (const QRect &rect, KisPSDLayerStyleSP style, KisLayerStyleFilterEnvironment *env) const override
KisLayerStyleFilter *	clone () const override
	KisLsDropShadowFilter (Mode mode=DropShadow)
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	applyDropShadow (KisPaintDeviceSP srcDevice, KisMultipleProjection *dst, const QRect &applyRect, const psd_layer_effects_context *context, const psd_layer_effects_shadow_base *shadow, KisResourcesInterfaceSP resourcesInterface, KisLayerStyleFilterEnvironment *env) const
const psd_layer_effects_shadow_base *	getShadowStruct (KisPSDLayerStyleSP style) const
	KisLsDropShadowFilter (const KisLsDropShadowFilter &rhs)

Private Attributes
const 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_drop_shadow_filter.h.

Member Enumeration Documentation

Mode

enum KisLsDropShadowFilter::Mode

Enumerator
DropShadow
InnerShadow
OuterGlow
InnerGlow

Definition at line 21 of file kis_ls_drop_shadow_filter.h.

              {
        DropShadow,
        InnerShadow,
        OuterGlow,
        InnerGlow
    };

Constructor & Destructor Documentation

KisLsDropShadowFilter() [1/2]

KisLsDropShadowFilter::KisLsDropShadowFilter

(

Mode

mode = DropShadow

)

Definition at line 35 of file kis_ls_drop_shadow_filter.cpp.

    : KisLayerStyleFilter(KoID("lsdropshadow", i18n("Drop Shadow (style)")))
    , m_mode(mode)
{
}

KisLsDropShadowFilter() [2/2]

KisLsDropShadowFilter::KisLsDropShadowFilter ( const KisLsDropShadowFilter & rhs )

private

Definition at line 41 of file kis_ls_drop_shadow_filter.cpp.

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

Member Function Documentation

applyDropShadow()

void KisLsDropShadowFilter::applyDropShadow ( KisPaintDeviceSP srcDevice, KisMultipleProjection * dst, const QRect & applyRect, const psd_layer_effects_context * context, const psd_layer_effects_shadow_base * shadow, KisResourcesInterfaceSP resourcesInterface, KisLayerStyleFilterEnvironment * env ) const

private

Copy selection which will be erased from the original later

Spread and blur the selection

Contour correction

Noise

Knock-out original outline of the device from the resulting shade

Definition at line 110 of file kis_ls_drop_shadow_filter.cpp.

{
    if (applyRect.isEmpty()) return;
 
    ShadowRectsData d(applyRect, context, shadow, ShadowRectsData::NEED_RECT);
 
    KisCachedSelection::Guard s1(*env->cachedSelection());
    KisSelectionSP baseSelection = s1.selection();
    KisLsUtils::selectionFromAlphaChannel(srcDevice, baseSelection, d.spreadNeedRect);
 
    KisPixelSelectionSP selection = baseSelection->pixelSelection();
 
    //selection->convertToQImage(0, QRect(0,0,300,300)).save("0_selection_initial.png");
 
    if (shadow->invertsSelection()) {
        selection->invert();
    }
 
    KisCachedSelection::Guard s2(*env->cachedSelection());
    KisPixelSelectionSP knockOutSelection;
    if (shadow->knocksOut()) {
        knockOutSelection = s2.selection()->pixelSelection();
        knockOutSelection->makeCloneFromRough(selection, selection->selectedRect());
    }
 
    if (shadow->technique() == psd_technique_precise) {
        KisLsUtils::findEdge(selection, d.blurNeedRect, true);
    }
 
    if (d.spread_size) {
        KisLsUtils::applyGaussianWithTransaction(selection, d.blurNeedRect, d.spread_size);
 
        // TODO: find out why in libpsd we pass false here. If we do so,
        //       the result is fully black, which is not expected
        KisLsUtils::findEdge(selection, d.blurNeedRect, true /*shadow->edgeHidden()*/);
    }
 
    //selection->convertToQImage(0, QRect(0,0,300,300)).save("1_selection_spread.png");
 
    if (d.blur_size) {
        KisLsUtils::applyGaussianWithTransaction(selection, d.noiseNeedRect, d.blur_size);
    }
    //selection->convertToQImage(0, QRect(0,0,300,300)).save("2_selection_blur.png");
 
    if (shadow->range() != KisLsUtils::FULL_PERCENT_RANGE) {
        KisLsUtils::adjustRange(selection, d.noiseNeedRect, shadow->range());
    }
 
    const psd_layer_effects_inner_glow *iglow = 0;
    if ((iglow =
         dynamic_cast<const psd_layer_effects_inner_glow *>(shadow)) &&
        iglow->source() == psd_glow_center) {
 
        selection->invert();
    }
 
    KisLsUtils::applyContourCorrection(selection,
                                       d.noiseNeedRect,
                                       shadow->contourLookupTable(),
                                       shadow->antiAliased(),
                                       shadow->edgeHidden());
 
    //selection->convertToQImage(0, QRect(0,0,300,300)).save("3_selection_contour.png");
 
    if (shadow->noise() > 0) {
        KisLsUtils::applyNoise(selection,
                               d.srcRect,
                               shadow->noise(),
                               context,
                               env);
    }
    //selection->convertToQImage(0, QRect(0,0,300,300)).save("4_selection_noise.png");
 
    if (!d.offset.isNull()) {
        selection->moveTo(selection->offset() + d.offset);
    }
 
    if (shadow->knocksOut()) {
        KIS_ASSERT_RECOVER_RETURN(knockOutSelection);
 
        QRect knockOutRect = !shadow->invertsSelection() ?
            d.srcRect : d.spreadNeedRect;
 
        knockOutRect &= d.dstRect;
 
        KisPainter gc(selection);
        gc.setCompositeOpId(COMPOSITE_ERASE);
        gc.bitBlt(knockOutRect.topLeft(), knockOutSelection, knockOutRect);
    }
    //selection->convertToQImage(0, QRect(0,0,300,300)).save("5_selection_knockout.png");
 
    KisLsUtils::applyFinalSelection(KisMultipleProjection::defaultProjectionId(),
                                    baseSelection,
                                    srcDevice,
                                    dst,
                                    d.srcRect,
                                    d.dstRect,
                                    context,
                                    shadow,
                                    resourcesInterface,
                                    env);
}

References KisLsUtils::adjustRange(), psd_layer_effects_shadow_base::antiAliased(), KisLsUtils::applyContourCorrection(), KisLsUtils::applyFinalSelection(), KisLsUtils::applyGaussianWithTransaction(), KisLsUtils::applyNoise(), KisPainter::bitBlt(), KisLayerStyleFilterEnvironment::cachedSelection(), COMPOSITE_ERASE, psd_layer_effects_shadow_base::contourLookupTable(), KisMultipleProjection::defaultProjectionId(), psd_layer_effects_shadow_base::edgeHidden(), KisLsUtils::findEdge(), KisLsUtils::FULL_PERCENT_RANGE, KisPixelSelection::invert(), psd_layer_effects_shadow_base::invertsSelection(), KIS_ASSERT_RECOVER_RETURN, psd_layer_effects_shadow_base::knocksOut(), KisPixelSelection::moveTo(), ShadowRectsData::NEED_RECT, psd_layer_effects_shadow_base::noise(), KisPaintDevice::offset(), KisSelection::pixelSelection, psd_glow_center, psd_technique_precise, psd_layer_effects_shadow_base::range(), s1, s2, KisPixelSelection::selectedRect(), KisLsUtils::selectionFromAlphaChannel(), KisPainter::setCompositeOpId(), psd_layer_effects_inner_glow::source(), and psd_layer_effects_shadow_base::technique().

changedRect()

QRect KisLsDropShadowFilter::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 279 of file kis_ls_drop_shadow_filter.cpp.

{
    const psd_layer_effects_shadow_base *shadowStruct = getShadowStruct(style);
    if (!shadowStruct->effectEnabled()) return rect;
 
    KisLsUtils::LodWrapper<psd_layer_effects_shadow_base> w(env->currentLevelOfDetail(), shadowStruct);
    ShadowRectsData d(rect, style->context(), w.config, ShadowRectsData::CHANGE_RECT);
    return style->context()->keep_original ?
        d.finalChangeRect() : rect | d.finalChangeRect();
}

References ShadowRectsData::CHANGE_RECT, KisLayerStyleFilterEnvironment::currentLevelOfDetail(), psd_layer_effects_shadow_base::effectEnabled(), and getShadowStruct().

clone()

KisLayerStyleFilter * KisLsDropShadowFilter::clone ( ) const

overridevirtual

Implements KisLayerStyleFilter.

Definition at line 47 of file kis_ls_drop_shadow_filter.cpp.

{
    return new KisLsDropShadowFilter(*this);
}

References KisLsDropShadowFilter().

getShadowStruct()

const psd_layer_effects_shadow_base * KisLsDropShadowFilter::getShadowStruct ( KisPSDLayerStyleSP style ) const

private

Definition at line 235 of file kis_ls_drop_shadow_filter.cpp.

{
    const psd_layer_effects_shadow_base *config = 0;
 
    if (m_mode == DropShadow) {
        config = style->dropShadow();
    } else if (m_mode == InnerShadow) {
        config = style->innerShadow();
    } else if (m_mode == OuterGlow) {
        config = style->outerGlow();
    } else if (m_mode == InnerGlow) {
        config = style->innerGlow();
    }
 
    return config;
}

References InnerShadow, m_mode, and OuterGlow.

neededRect()

QRect KisLsDropShadowFilter::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 269 of file kis_ls_drop_shadow_filter.cpp.

{
    const psd_layer_effects_shadow_base *shadowStruct = getShadowStruct(style);
    if (!shadowStruct->effectEnabled()) return rect;
 
    KisLsUtils::LodWrapper<psd_layer_effects_shadow_base> w(env->currentLevelOfDetail(), shadowStruct);
    ShadowRectsData d(rect, style->context(), w.config, ShadowRectsData::NEED_RECT);
    return rect | d.finalNeedRect();
}

References KisLayerStyleFilterEnvironment::currentLevelOfDetail(), psd_layer_effects_shadow_base::effectEnabled(), getShadowStruct(), and ShadowRectsData::NEED_RECT.

processDirectly()

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

overridevirtual

Implements KisLayerStyleFilter.

Definition at line 252 of file kis_ls_drop_shadow_filter.cpp.

{
    Q_UNUSED(blower);
    KIS_ASSERT_RECOVER_RETURN(style);
 
    const psd_layer_effects_shadow_base *config = getShadowStruct(style);
    if (!KisLsUtils::checkEffectEnabled(config, dst)) return;
 
    KisLsUtils::LodWrapper<psd_layer_effects_shadow_base> w(env->currentLevelOfDetail(), config);
    applyDropShadow(src, dst, applyRect, style->context(), w.config, style->resourcesInterface(), env);
}

References applyDropShadow(), KisLsUtils::checkEffectEnabled(), KisLayerStyleFilterEnvironment::currentLevelOfDetail(), getShadowStruct(), and KIS_ASSERT_RECOVER_RETURN.

Member Data Documentation

m_mode

const Mode KisLsDropShadowFilter::m_mode

private

Definition at line 54 of file kis_ls_drop_shadow_filter.h.

---

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

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