KisMaskManager Class Reference

#include <kis_mask_manager.h>

Inheritance diagram for KisMaskManager:

Public Member Functions
	KisMaskManager (KisViewManager *view)
void	setView (QPointer< KisView >view)
	~KisMaskManager () override

Private Member Functions
void	activateMask (KisMaskSP mask)
KisPaintDeviceSP	activeDevice ()
KisMaskSP	activeMask ()
void	adjustMaskPosition (KisNodeSP node, KisNodeSP activeNode, bool avoidActiveNode, KisNodeSP &parent, KisNodeSP &above)
KisNodeSP	createColorizeMask (KisNodeSP activeNode)
KisNodeSP	createFastColorOverlayMask (KisNodeSP activeNode)
KisNodeSP	createFilterMask (KisNodeSP activeNode, KisPaintDeviceSP copyFrom, bool quiet, bool convertActiveNode)
void	createMaskCommon (KisMaskSP mask, KisNodeSP activeNode, KisPaintDeviceSP copyFrom, const KUndo2MagicString &macroName, const QString &nodeType, const QString &nodeName, bool suppressSelection, bool avoidActiveNode, bool updateImage=true)
QString	createMaskNameCommon (KisNodeSP targetNode, const QString &nodeType, const QString &desiredName)
KisNodeSP	createSelectionMask (KisNodeSP activeNode, KisPaintDeviceSP copyFrom, bool convertActiveNode)
KisNodeSP	createTransformMask (KisNodeSP activeNode)
KisNodeSP	createTransparencyMask (KisNodeSP activeNode, KisPaintDeviceSP copyFrom, bool convertActiveNode)
void	maskProperties ()
void	masksUpdated ()
void	setup (KisKActionCollection *actionCollection, KisActionManager *actionManager)
void	updateGUI ()

Private Attributes
KisNodeCommandsAdapter *	m_commandsAdapter
QPointer< KisView >	m_imageView
KisViewManager *	m_view

Friends
class	KisNodeManager

Detailed Description

Handle the gui for manipulating masks.

Definition at line 25 of file kis_mask_manager.h.

Constructor & Destructor Documentation

KisMaskManager()

KisMaskManager::KisMaskManager

(

KisViewManager *

view

)

Definition at line 48 of file kis_mask_manager.cc.

    : m_view(view)
    , m_imageView(0)
    , m_commandsAdapter(new KisNodeCommandsAdapter(m_view))
{
}

~KisMaskManager()

KisMaskManager::~KisMaskManager ( )

inlineoverride

Definition at line 34 of file kis_mask_manager.h.

{}

Member Function Documentation

activateMask()

void KisMaskManager::activateMask ( KisMaskSP mask )

private

Activate a new mask. There can be only one mask active per view; and if the mask is active, it becomes the paint device.

Definition at line 87 of file kis_mask_manager.cc.

{
    Q_UNUSED(mask);
}

activeDevice()

KisPaintDeviceSP KisMaskManager::activeDevice ( )

private

Returns

the paint device associated with the currently active mask, if there is one.

Definition at line 81 of file kis_mask_manager.cc.

{
    KisMaskSP mask = activeMask();
    return mask ? mask->paintDevice() : 0;
}

References activeMask().

activeMask()

KisMaskSP KisMaskManager::activeMask ( )

private

Returns

the active mask, if there is one

Definition at line 73 of file kis_mask_manager.cc.

{
    if (m_imageView) {
        return m_imageView->currentMask();
    }
    return 0;
}

References m_imageView.

adjustMaskPosition()

void KisMaskManager::adjustMaskPosition ( KisNodeSP node, KisNodeSP activeNode, bool avoidActiveNode, KisNodeSP & parent, KisNodeSP & above )

private

Definition at line 97 of file kis_mask_manager.cc.

{
    Q_ASSERT(node);
    Q_ASSERT(activeNode);
 
    if (!avoidActiveNode && activeNode->allowAsChild(node)) {
        parent = activeNode;
        above = activeNode->lastChild();
    } else if (activeNode->parent() && activeNode->parent()->allowAsChild(node)
               && activeNode->parent()->parent() /* we don't want to add masks to root */) {
        parent = activeNode->parent();
        above = activeNode;
    } else {
        KisNodeSP t = activeNode;
        while ((t = t->nextSibling())) {
            if (t->allowAsChild(node)) {
                parent = t;
                above = t->lastChild();
                break;
            }
        }
 
        if (!t) {
            t = activeNode;
            while ((t = t->prevSibling())) {
                if (t->allowAsChild(node)) {
                    parent = t;
                    above = t->lastChild();
                    break;
                }
            }
        }
 
        if (!t && activeNode->parent()) {
            adjustMaskPosition(node, activeNode->parent(), true, parent, above);
        } else if (!t) {
            KisImageWSP image = m_view->image();
            KisLayerSP layer = new KisPaintLayer(image.data(), image->nextLayerName(), OPACITY_OPAQUE_U8, image->colorSpace());
            m_commandsAdapter->addNode(layer, activeNode, 0);
 
            parent = layer;
            above = 0;
        }
    }
}

References KisNodeCommandsAdapter::addNode(), adjustMaskPosition(), KisNode::allowAsChild(), KisImage::colorSpace(), KisWeakSharedPtr< T >::data(), KisViewManager::image(), KisNode::lastChild(), m_commandsAdapter, m_view, KisImage::nextLayerName(), KisNode::nextSibling(), OPACITY_OPAQUE_U8, KisNode::parent, and KisNode::prevSibling().

createColorizeMask()

KisNodeSP KisMaskManager::createColorizeMask ( KisNodeSP activeNode )

private

Definition at line 276 of file kis_mask_manager.cc.

{
    if (!m_view->nodeManager()->canModifyLayer(activeNode)) return 0;
 
    KisColorizeMaskSP mask = new KisColorizeMask(m_view->image(), "");
    createMaskCommon(mask, activeNode, 0, kundo2_i18n("Add Colorize Mask"), "KisColorizeMask", i18n("Colorize Mask"), true, false);
    mask->initializeCompositeOp();
    delete mask->setColorSpace(mask->parent()->colorSpace());
    return mask;
}

References KisNodeManager::canModifyLayer(), KisBaseNode::colorSpace(), createMaskCommon(), KisViewManager::image(), KisColorizeMask::initializeCompositeOp(), kundo2_i18n(), m_view, KisViewManager::nodeManager(), KisNode::parent, and KisColorizeMask::setColorSpace().

createFastColorOverlayMask()

KisNodeSP KisMaskManager::createFastColorOverlayMask ( KisNodeSP activeNode )

private

Definition at line 297 of file kis_mask_manager.cc.

{
    if (!m_view->nodeManager()->canModifyLayer(activeNode)) return 0;
 
    KisLayerSP activeLayer = qobject_cast<KisLayer*>(activeNode.data());
    Q_ASSERT(activeLayer);
 
    KisFilterConfigurationSP filter =
        KisFilterRegistry::instance()->value("fastcoloroverlay")->defaultConfiguration(KisGlobalResourcesInterface::instance());
    if (!filter) return nullptr;
 
    m_commandsAdapter->beginMacro(kundo2_i18n("Add Fast Color Overlay"));
 
    KisFilterMaskSP mask = new KisFilterMask(m_view->image(), "");
    mask->initSelection(activeLayer);
    mask->setName(createMaskNameCommon(activeLayer, "KisFilterMask", i18n("Color Overlay Mask")));
    mask->setFilter(filter->cloneWithResourcesSnapshot());
 
    KisImageLayerAddCommand::Flags flags =
        KisImageLayerAddCommand::DoUndoUpdates |
        KisImageLayerAddCommand::DoRedoUpdates;
 
    if (activeLayer->childCount() == 0) {
        m_commandsAdapter->addExtraCommand(
                    new KisLayerCollapseCommand(
                        activeNode, true));
 
        flags |= KisImageLayerAddCommand::DontActivateOnAddition;
    };
 
    m_commandsAdapter->addNode(mask, activeLayer, activeLayer->lastChild(), flags);
 
    m_commandsAdapter->endMacro();
 
    return mask;
}

References KisNodeCommandsAdapter::addExtraCommand(), KisNodeCommandsAdapter::addNode(), KisNodeCommandsAdapter::beginMacro(), KisNodeManager::canModifyLayer(), KisNode::childCount(), createMaskNameCommon(), KisSharedPtr< T >::data(), KisBaseProcessor::defaultConfiguration(), KisImageLayerAddCommand::DontActivateOnAddition, KisImageLayerAddCommand::DoRedoUpdates, KisImageLayerAddCommand::DoUndoUpdates, KisNodeCommandsAdapter::endMacro(), KisViewManager::image(), KisFilterRegistry::instance(), KisGlobalResourcesInterface::instance(), kundo2_i18n(), KisNode::lastChild(), m_commandsAdapter, m_view, KisViewManager::nodeManager(), and KoGenericRegistry< T >::value().

createFilterMask()

KisNodeSP KisMaskManager::createFilterMask ( KisNodeSP activeNode, KisPaintDeviceSP copyFrom, bool quiet, bool convertActiveNode )

private

FIXME: We'll use layer's original for creation of a thumbnail. Actually, we can't use it's projection as newly created mask may be going to be inserted in the middle of the masks stack

Definition at line 225 of file kis_mask_manager.cc.

{
    if (!m_view->nodeManager()->canModifyLayer(activeNode)) return 0;
 
    KisFilterMaskSP mask = new KisFilterMask(m_view->image(), "");
    createMaskCommon(mask, activeNode, copyFrom, kundo2_i18n("Add Filter Mask"), "KisFilterMask", i18n("Filter Mask"), false, convertActiveNode);
 
    if (convertActiveNode) {
        m_commandsAdapter->removeNode(activeNode);
    }
 
    KisPaintDeviceSP originalDevice = mask->parent()->original();
 
 
    KisDlgAdjustmentLayer dialog(mask, mask.data(), originalDevice,
                                 mask->name(), i18n("New Filter Mask"),
                                 m_view, qApp->activeWindow());
 
    // If we are supposed to not disturb the user, don't start asking them about things.
    if(quiet) {
        KisFilterConfigurationSP filter = KisFilterRegistry::instance()->values().first()->defaultConfiguration(KisGlobalResourcesInterface::instance());
        if (filter) {
            mask->setFilter(filter->cloneWithResourcesSnapshot());
            mask->setName(mask->name());
        }
        return mask;
    }
 
    if (dialog.exec() == QDialog::Accepted) {
        KisFilterConfigurationSP filter = dialog.filterConfiguration();
        if (filter) {
            QString name = dialog.layerName();
            mask->setFilter(filter->cloneWithResourcesSnapshot());
            mask->setName(name);
        }
 
        return mask;
 
    } else {
        m_commandsAdapter->undoLastCommand();
    }
 
    return 0;
}

References KisNodeManager::canModifyLayer(), createMaskCommon(), KisSharedPtr< T >::data(), KisViewManager::image(), KisFilterRegistry::instance(), KisGlobalResourcesInterface::instance(), kundo2_i18n(), m_commandsAdapter, m_view, KisViewManager::nodeManager(), KisNodeCommandsAdapter::removeNode(), KisNodeCommandsAdapter::undoLastCommand(), and KoGenericRegistry< T >::values().

createMaskCommon()

void KisMaskManager::createMaskCommon ( KisMaskSP mask, KisNodeSP activeNode, KisPaintDeviceSP copyFrom, const KUndo2MagicString & macroName, const QString & nodeType, const QString & nodeName, bool suppressSelection, bool avoidActiveNode, bool updateImage = true )

private

Definition at line 143 of file kis_mask_manager.cc.

{
    m_commandsAdapter->beginMacro(macroName);
 
    KisNodeSP parent;
    KisNodeSP above;
    adjustMaskPosition(mask, activeNode, avoidActiveNode, parent, above);
 
    KisLayerSP parentLayer = qobject_cast<KisLayer*>(parent.data());
    Q_ASSERT(parentLayer);
 
    bool shouldDeselectGlobalSelection = false;
 
    if (!suppressSelection) {
        if (copyFrom) {
            mask->initSelection(copyFrom, parentLayer);
        } else {
            mask->initSelection(m_view->selection(), parentLayer);
            shouldDeselectGlobalSelection = m_view->selection();
        }
    }
 
    mask->setName( createMaskNameCommon(parentLayer, nodeType, nodeName) );
 
    KisImageLayerAddCommand::Flags flags =
        updateImage ?
            KisImageLayerAddCommand::DoUndoUpdates | KisImageLayerAddCommand::DoRedoUpdates :
            KisImageLayerAddCommand::None;
 
    m_commandsAdapter->addNode(mask, parentLayer, above, flags);
 
    if (shouldDeselectGlobalSelection) {
        m_commandsAdapter->addExtraCommand(new KisDeselectGlobalSelectionCommand(m_imageView->image()));
    }
 
    m_commandsAdapter->endMacro();
 
    masksUpdated();
}

References KisNodeCommandsAdapter::addExtraCommand(), KisNodeCommandsAdapter::addNode(), adjustMaskPosition(), KisNodeCommandsAdapter::beginMacro(), createMaskNameCommon(), KisImageLayerAddCommand::DoRedoUpdates, KisImageLayerAddCommand::DoUndoUpdates, KisNodeCommandsAdapter::endMacro(), m_commandsAdapter, m_imageView, m_view, masksUpdated(), nodeType(), KisImageLayerAddCommand::None, and KisViewManager::selection().

createMaskNameCommon()

QString KisMaskManager::createMaskNameCommon ( KisNodeSP targetNode, const QString & nodeType, const QString & desiredName )

private

Definition at line 191 of file kis_mask_manager.cc.

{
    QList<KisNodeSP> masks = targetNode->childNodes(QStringList(nodeType),KoProperties());
    int number = masks.count() + 1;
    return desiredName + QString(" ") + QString::number(number);
}

References KisNode::childNodes(), and nodeType().

createSelectionMask()

KisNodeSP KisMaskManager::createSelectionMask ( KisNodeSP activeNode, KisPaintDeviceSP copyFrom, bool convertActiveNode )

private

Definition at line 198 of file kis_mask_manager.cc.

{
    if (!m_view->nodeManager()->canModifyLayer(activeNode)) return 0;
 
    KisSelectionMaskSP mask = new KisSelectionMask(m_view->image());
 
    createMaskCommon(mask, activeNode, copyFrom, kundo2_i18n("Add Selection Mask"), "KisSelectionMask", i18n("Selection"), false, convertActiveNode, false);
    mask->setActive(true);
    if (convertActiveNode) {
        m_commandsAdapter->removeNode(activeNode);
    }
    return mask;
}

References KisNodeManager::canModifyLayer(), createMaskCommon(), KisViewManager::image(), kundo2_i18n(), m_commandsAdapter, m_view, KisViewManager::nodeManager(), KisNodeCommandsAdapter::removeNode(), and KisSelectionMask::setActive().

createTransformMask()

KisNodeSP KisMaskManager::createTransformMask ( KisNodeSP activeNode )

private

Definition at line 288 of file kis_mask_manager.cc.

{
    if (!m_view->nodeManager()->canModifyLayer(activeNode)) return 0;
 
    KisTransformMaskSP mask = new KisTransformMask(m_view->image(), "");
    createMaskCommon(mask, activeNode, 0, kundo2_i18n("Add Transform Mask"), "KisTransformMask", i18n("Transform Mask"), true, false);
    return mask;
}

References KisNodeManager::canModifyLayer(), createMaskCommon(), KisViewManager::image(), kundo2_i18n(), m_view, and KisViewManager::nodeManager().

createTransparencyMask()

KisNodeSP KisMaskManager::createTransparencyMask ( KisNodeSP activeNode, KisPaintDeviceSP copyFrom, bool convertActiveNode )

private

Definition at line 212 of file kis_mask_manager.cc.

{
    if (!m_view->nodeManager()->canModifyLayer(activeNode)) return 0;
 
    KisMaskSP mask = new KisTransparencyMask(m_view->image(), "");
    createMaskCommon(mask, activeNode, copyFrom, kundo2_i18n("Add Transparency Mask"), "KisTransparencyMask", i18n("Transparency Mask"), false, convertActiveNode);
    if (convertActiveNode) {
        m_commandsAdapter->removeNode(activeNode);
    }
    return mask;
}

References KisNodeManager::canModifyLayer(), createMaskCommon(), KisViewManager::image(), kundo2_i18n(), m_commandsAdapter, m_view, KisViewManager::nodeManager(), and KisNodeCommandsAdapter::removeNode().

maskProperties()

void KisMaskManager::maskProperties ( )

private

Show the mask properties dialog

Definition at line 334 of file kis_mask_manager.cc.

{
    if (!activeMask()) return;
 
    if (!m_view->nodeManager()->canModifyLayer(activeMask())) return;
 
    if (activeMask()->inherits("KisFilterMask")) {
        KisFilterMask *mask = static_cast<KisFilterMask*>(activeMask().data());
 
        KisLayerSP layer = qobject_cast<KisLayer*>(mask->parent().data());
        if (! layer)
            return;
 
 
        KisPaintDeviceSP dev = layer->original();
        if (!dev) {
            return;
        }
 
        KisDlgAdjustmentLayer dlg(mask, mask, dev, mask->name(),
                                  i18n("Filter Mask Properties"), m_view,
                                  m_view->mainWindowAsQWidget(), mask->filter());
 
        KisFilterConfigurationSP configBefore(mask->filter());
        Q_ASSERT(configBefore);
        QString xmlBefore = configBefore->toXML();
 
        if (dlg.exec() == QDialog::Accepted) {
 
            KisFilterConfigurationSP configAfter(dlg.filterConfiguration());
            Q_ASSERT(configAfter);
            QString xmlAfter = configAfter->toXML();
 
            KUndo2Command *cmd = nullptr;
 
            if(xmlBefore != xmlAfter) {
                cmd = KisCommandUtils::composeCommands(cmd,
                    new KisChangeFilterCmd(mask,
                                           configBefore->cloneWithResourcesSnapshot(),
                                           configAfter->cloneWithResourcesSnapshot()));
            }
 
            if (mask->name() != dlg.layerName()) {
                cmd = KisCommandUtils::composeCommands(cmd,
                    new KisNodeRenameCommand(mask, mask->name(), dlg.layerName()));
            }
 
            if (cmd) {
                m_view->undoAdapter()->addCommand(cmd);
                m_view->document()->setModified(true);
            }
        }
        else {
            KisFilterConfigurationSP configAfter(dlg.filterConfiguration());
            Q_ASSERT(configAfter);
            QString xmlAfter = configAfter->toXML();
 
            if(xmlBefore != xmlAfter) {
                mask->setFilter(configBefore->cloneWithResourcesSnapshot());
                mask->setDirty();
            }
        }
 
    } else {
        // Not much to show for transparency or selection masks?
    }
}

References activeMask(), KisUndoAdapter::addCommand(), KisNodeManager::canModifyLayer(), KisCommandUtils::composeCommands(), KisSharedPtr< T >::data(), KisWeakSharedPtr< T >::data(), KisViewManager::document(), KisNodeFilterInterface::filter(), KisDlgAdjustmentLayer::filterConfiguration(), KisDlgAdjustmentLayer::layerName(), m_view, KisViewManager::mainWindowAsQWidget(), KisBaseNode::name(), KisViewManager::nodeManager(), KisLayer::original(), KisNode::parent, KisNode::setDirty(), KisFilterMask::setFilter(), KisDocument::setModified(), and KisViewManager::undoAdapter().

masksUpdated()

void KisMaskManager::masksUpdated ( )

private

called whenever the mask stack is updated to enable/disable all menu items

Definition at line 92 of file kis_mask_manager.cc.

{
    m_view->updateGUI();
}

References m_view, and KisViewManager::updateGUI().

setup()

void KisMaskManager::setup ( KisKActionCollection * actionCollection, KisActionManager * actionManager )

private

Definition at line 60 of file kis_mask_manager.cc.

{
    Q_UNUSED(actionCollection);
    Q_UNUSED(actionManager);
}

setView()

void KisMaskManager::setView

(

QPointer< KisView >

view

)

Definition at line 55 of file kis_mask_manager.cc.

{
    m_imageView = imageView;
}

References m_imageView.

updateGUI()

void KisMaskManager::updateGUI ( )

private

Definition at line 66 of file kis_mask_manager.cc.

{
    // XXX: enable/disable menu items according to whether there's a mask selected currently
    // XXX: disable the selection mask item if there's already a selection mask
    // YYY: doesn't KisAction do that already?
}

Friends And Related Symbol Documentation

KisNodeManager

friend class KisNodeManager

friend

Definition at line 39 of file kis_mask_manager.h.

Member Data Documentation

m_commandsAdapter

KisNodeCommandsAdapter* KisMaskManager::m_commandsAdapter

private

Definition at line 86 of file kis_mask_manager.h.

m_imageView

QPointer<KisView> KisMaskManager::m_imageView

private

Definition at line 85 of file kis_mask_manager.h.

m_view

KisViewManager* KisMaskManager::m_view

private

Definition at line 84 of file kis_mask_manager.h.

---

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

• libs/ui/kis_mask_manager.h
• libs/ui/kis_mask_manager.cc