KisShapeController Class Reference

#include <kis_shape_controller.h>

Inheritance diagram for KisShapeController:

Classes
struct	Private

Signals
void	currentLayerChanged (const KoShapeLayer *)
void	selectionChanged ()
void	selectionContentChanged ()
Signals inherited from KisDummiesFacadeBase
void	sigActivateNode (KisNodeSP node)
void	sigBeginInsertDummy (KisNodeDummy *parent, int index, const QString &metaObjectType)
void	sigBeginRemoveDummy (KisNodeDummy *dummy)
void	sigDummyChanged (KisNodeDummy *dummy)
void	sigEndInsertDummy (KisNodeDummy *dummy)
void	sigEndRemoveDummy ()

Public Member Functions
KoShapeContainer *	createParentForShapes (const QList< KoShape * > shapes, bool forceNewLayer, KUndo2Command *parentCommand) override
QRectF	documentRectInPixels () const override
int	dummiesCount () const override
KisNodeDummy *	dummyForNode (KisNodeSP layer) const override
bool	hasDummyForNode (KisNodeSP node) const override
	KisShapeController (KisNameServer *nameServer, KUndo2Stack *undoStack, QObject *parent=0)
qreal	pixelsPerInch () const override
KisNodeDummy *	rootDummy () const override
void	setImage (KisImageWSP image)
virtual void	setImage (KisImageWSP image, KisNodeSP activeNode)
void	setImage (KisImageWSP image, KisNodeSP activeNode) override
void	setInitialShapeForCanvas (KisCanvas2 *canvas)
KoShapeLayer *	shapeForNode (KisNodeSP layer) const
	~KisShapeController () override
Public Member Functions inherited from KisDummiesFacadeBase
	KisDummiesFacadeBase (QObject *parent=0)
KisNodeSP	lastActivatedNode () const
void	setImage (KisImageWSP image)
	~KisDummiesFacadeBase () override
Public Member Functions inherited from KoShapeControllerBase
QRectF	documentRect () const
	KoShapeControllerBase ()
virtual KoDocumentResourceManager *	resourceManager () const
virtual	~KoShapeControllerBase ()

Private Slots
void	slotUpdateDocumentResolution ()
void	slotUpdateDocumentSize ()

Private Member Functions
void	addNodeImpl (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis) override
void	removeNodeImpl (KisNodeSP node) override

Private Attributes
Private *const	m_d

Additional Inherited Members
Protected Member Functions inherited from KisDummiesFacadeBase
KisImageWSP	image () const

Detailed Description

KisShapeController keeps track of new layers, shapes, masks and selections – everything that needs to be wrapped as a shape for the tools to work on.

Definition at line 28 of file kis_shape_controller.h.

Constructor & Destructor Documentation

KisShapeController()

KisShapeController::KisShapeController	(	KisNameServer *	nameServer,
		KUndo2Stack *	undoStack,
		QObject *	parent = 0 )

Definition at line 60 of file kis_shape_controller.cpp.

    : KisDummiesFacadeBase(parent)
    , m_d(new Private())
{
    m_d->nameServer = nameServer;
    resourceManager()->setUndoStack(undoStack);
}

References m_d, KisShapeController::Private::nameServer, KoShapeControllerBase::resourceManager(), and KoDocumentResourceManager::setUndoStack().

~KisShapeController()

KisShapeController::~KisShapeController ( )

override

Definition at line 69 of file kis_shape_controller.cpp.

{
    KisNodeDummy *node = m_d->shapesGraph.rootDummy();
    if (node) {
        m_d->shapesGraph.removeNode(node->node());
    }
 
    delete m_d;
}

References m_d, KisNodeDummy::node(), KisNodeShapesGraph::removeNode(), KisNodeShapesGraph::rootDummy(), and KisShapeController::Private::shapesGraph.

Member Function Documentation

addNodeImpl()

void KisShapeController::addNodeImpl ( KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis )

overrideprivatevirtual

Forward signals for global shape manager

See also

comment in the constructor of KisCanvas2

Implements KisDummiesFacadeBase.

Definition at line 98 of file kis_shape_controller.cpp.

{
    KisNodeShape *newShape =
        m_d->shapesGraph.addNode(node, parent, aboveThis);
    // XXX: what are we going to do with this shape?
    Q_UNUSED(newShape);
 
    KisShapeLayer *shapeLayer = dynamic_cast<KisShapeLayer*>(node.data());
    if (shapeLayer) {
        connect(shapeLayer, SIGNAL(selectionChanged()),
                SIGNAL(selectionChanged()));
        connect(shapeLayer->shapeManager(), SIGNAL(selectionContentChanged()),
                SIGNAL(selectionContentChanged()));
        connect(shapeLayer, SIGNAL(currentLayerChanged(const KoShapeLayer*)),
                SIGNAL(currentLayerChanged(const KoShapeLayer*)));
    }
}

References KisNodeShapesGraph::addNode(), connect(), currentLayerChanged(), KisSharedPtr< T >::data(), m_d, selectionChanged(), selectionContentChanged(), KisShapeLayer::shapeManager(), and KisShapeController::Private::shapesGraph.

createParentForShapes()

KoShapeContainer * KisShapeController::createParentForShapes ( const QList< KoShape * > shapes, bool forceNewLayer, KUndo2Command * parentCommand )

overridevirtual

When shapes are dropped to the canvas, the document should decide, where to which parent to put them. In some cases the document should even create a special layer for the new shapes.

Returns

the proposed parent for shapes

Parameters

parentCommand

the command, which should be executed before the proposed parent will be added to the document (if new layer should be created)

Reimplemented from KoShapeControllerBase.

Definition at line 153 of file kis_shape_controller.cpp.

{
    KoShapeContainer *resultParent = 0;
    KisCommandUtils::CompositeCommand *resultCommand =
        new KisCommandUtils::CompositeCommand(parentCommand);
 
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!shapes.isEmpty(), resultParent);
    Q_FOREACH (KoShape *shape, shapes) {
        KIS_SAFE_ASSERT_RECOVER_BREAK(!shape->parent());
    }
 
    KisCanvas2 *canvas = dynamic_cast<KisCanvas2*>(KoToolManager::instance()->activeCanvasController()->canvas());
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(canvas, resultParent);
 
    const bool baseBelongsToSelection = belongsToShapeSelection(shapes.first());
    bool allSameBelongsToShapeSelection = true;
 
    Q_FOREACH (KoShape *shape, shapes) {
        allSameBelongsToShapeSelection &= belongsToShapeSelection(shape) == baseBelongsToSelection;
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!baseBelongsToSelection || allSameBelongsToShapeSelection, resultParent);
 
    if (baseBelongsToSelection && allSameBelongsToShapeSelection) {
        KisSelectionSP selection = canvas->viewManager()->selection();
        if (selection) {
            KisSelectionComponent* shapeSelectionComponent = selection->shapeSelection();
 
            if (!shapeSelectionComponent) {
                shapeSelectionComponent = new KisShapeSelection(this, selection);
                resultCommand->addCommand(selection->convertToVectorSelection(shapeSelectionComponent));
            }
 
            KisShapeSelection * shapeSelection = static_cast<KisShapeSelection*>(shapeSelectionComponent);
            resultParent = shapeSelection;
        }
    } else {
        KisShapeLayer *shapeLayer =
                dynamic_cast<KisShapeLayer*>(
                    canvas->selectedShapesProxy()->selection()->activeLayer());
 
        if (!shapeLayer || forceNewLayer) {
            shapeLayer = new KisShapeLayer(this, image(),
                                           i18n("Vector Layer %1", m_d->nameServer->number()),
                                           OPACITY_OPAQUE_U8);
 
            resultCommand->addCommand(
                        new KisImageLayerAddCommand(image(),
                                                    shapeLayer,
                                                    image()->rootLayer(),
                                                    image()->rootLayer()->childCount()));
        }
 
        resultParent = shapeLayer;
    }
 
    return resultParent;
}

References KoToolManager::activeCanvasController(), KoSelection::activeLayer(), KisCommandUtils::CompositeCommand::addCommand(), belongsToShapeSelection(), KoCanvasController::canvas(), KisSelection::convertToVectorSelection(), KisDummiesFacadeBase::image(), KoToolManager::instance(), KIS_SAFE_ASSERT_RECOVER_BREAK, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_d, KisShapeController::Private::nameServer, KisNameServer::number(), OPACITY_OPAQUE_U8, KoShape::parent(), KisCanvas2::selectedShapesProxy, KisViewManager::selection(), KisSelectedShapesProxy::selection(), KisSelection::shapeSelection, and KisCanvas2::viewManager().

currentLayerChanged

void KisShapeController::currentLayerChanged ( const KoShapeLayer * )

signal

documentRectInPixels()

QRectF KisShapeController::documentRectInPixels ( ) const

overridevirtual

The size of the document measured in rasterized pixels. This information is needed for loading SVG documents that use 'px' as the default unit.

Implements KoShapeControllerBase.

Definition at line 212 of file kis_shape_controller.cpp.

{
    KisImageSP image = this->image();
    return image ? image->bounds() : QRect(0, 0, 666, 777);
}

References KisImage::bounds(), and KisDummiesFacadeBase::image().

dummiesCount()

int KisShapeController::dummiesCount ( ) const

overridevirtual

Implements KisDummiesFacadeBase.

Definition at line 145 of file kis_shape_controller.cpp.

{
    return m_d->shapesGraph.shapesCount();
}

References m_d, KisNodeShapesGraph::shapesCount(), and KisShapeController::Private::shapesGraph.

dummyForNode()

KisNodeDummy * KisShapeController::dummyForNode ( KisNodeSP layer ) const

overridevirtual

Implements KisDummiesFacadeBase.

Definition at line 135 of file kis_shape_controller.cpp.

{
    return m_d->shapesGraph.nodeToDummy(node);
}

References m_d, KisNodeShapesGraph::nodeToDummy(), and KisShapeController::Private::shapesGraph.

hasDummyForNode()

bool KisShapeController::hasDummyForNode ( KisNodeSP node ) const

overridevirtual

Implements KisDummiesFacadeBase.

Definition at line 130 of file kis_shape_controller.cpp.

{
    return m_d->shapesGraph.containsNode(node);
}

References KisNodeShapesGraph::containsNode(), m_d, and KisShapeController::Private::shapesGraph.

pixelsPerInch()

qreal KisShapeController::pixelsPerInch ( ) const

overridevirtual

Resolution of the rasterized representation of the document. Used to load SVG documents correctly.

Implements KoShapeControllerBase.

Definition at line 218 of file kis_shape_controller.cpp.

{
    KisImageSP image = this->image();
    return image ? image->xRes() * 72.0 : 72.0;
}

References KisDummiesFacadeBase::image(), and KisImage::xRes().

removeNodeImpl()

void KisShapeController::removeNodeImpl ( KisNodeSP node )

overrideprivatevirtual

Implements KisDummiesFacadeBase.

Definition at line 120 of file kis_shape_controller.cpp.

{
    KisShapeLayer *shapeLayer = dynamic_cast<KisShapeLayer*>(node.data());
    if (shapeLayer) {
        shapeLayer->disconnect(this);
    }
 
    m_d->shapesGraph.removeNode(node);
}

References KisSharedPtr< T >::data(), m_d, KisNodeShapesGraph::removeNode(), and KisShapeController::Private::shapesGraph.

rootDummy()

KisNodeDummy * KisShapeController::rootDummy ( ) const

overridevirtual

Return the root dummy of the graph. Since the call to KisDummiesFacadeBase::setImage() causes and asynchronous update of the dummies graph, it may cause rootDummy() to be null at some moments, which is a valid state.

Implements KisDummiesFacadeBase.

Definition at line 140 of file kis_shape_controller.cpp.

{
    return m_d->shapesGraph.rootDummy();
}

References m_d, KisNodeShapesGraph::rootDummy(), and KisShapeController::Private::shapesGraph.

selectionChanged

void KisShapeController::selectionChanged ( )

signal

These three signals are forwarded from the local shape manager of KisShapeLayer. This is done because we switch KoShapeManager and therefore KoSelection in KisCanvas2, so we need to connect local managers to the UI as well.

See also

comment in the constructor of KisCanvas2

selectionContentChanged

void KisShapeController::selectionContentChanged ( )

signal

setImage() [1/3]

void KisDummiesFacadeBase::setImage

(

KisImageWSP

image

)

Definition at line 34 of file kis_dummies_facade_base.cpp.

{
    setImage(image, nullptr);
}

setImage() [2/3]

void KisDummiesFacadeBase::setImage ( KisImageWSP image, KisNodeSP activeNode )

virtual

Reimplemented from KisDummiesFacadeBase.

Definition at line 35 of file kis_dummies_facade_base.cpp.

{
    if (m_d->image) {
        Q_EMIT sigActivateNode(0);
        m_d->lastActivatedNode = 0;
        m_d->image->disconnect(this);
        m_d->image->disconnect(&m_d->nodeChangedConnection);
        m_d->image->disconnect(&m_d->activateNodeConnection);
 
        KisNodeList nodesToRemove;
 
        {
            QMutexLocker l(&m_d->pendingNodeSetLock);
            std::swap(nodesToRemove, m_d->pendingNodeSet);
            m_d->pendingNodeSet.clear();
        }
 
        for (auto it = std::make_reverse_iterator(nodesToRemove.end());
             it != std::make_reverse_iterator(nodesToRemove.begin());
             ++it) {
 
            m_d->removeNodeConnection.start(*it);
        }
    }
 
    m_d->image = image;
 
    if (image) {
        slotNodeAdded(image->root(), KisNodeAdditionFlag::None);
 
        connect(image, SIGNAL(sigNodeAddedAsync(KisNodeSP, KisNodeAdditionFlags)),
                SLOT(slotNodeAdded(KisNodeSP, KisNodeAdditionFlags)), Qt::DirectConnection);
        connect(image, SIGNAL(sigRemoveNodeAsync(KisNodeSP)),
                SLOT(slotRemoveNode(KisNodeSP)), Qt::DirectConnection);
        connect(image, SIGNAL(sigLayersChangedAsync()),
                SLOT(slotLayersChanged()), Qt::DirectConnection);
 
        m_d->nodeChangedConnection.connectInputSignal(image, &KisImage::sigNodeChanged);
        m_d->activateNodeConnection.connectInputSignal(image, &KisImage::sigNodeAddedAsync);
 
        if (!activeNode) {
            activeNode = findFirstLayer(image->root());
        }
 
        m_d->activateNodeConnection.start(activeNode, KisNodeAdditionFlag::None);
    }
}

setImage() [3/3]

void KisShapeController::setImage ( KisImageWSP image, KisNodeSP activeNode )

overridevirtual

Reimplemented from KisDummiesFacadeBase.

Definition at line 241 of file kis_shape_controller.cpp.

{
    m_d->imageConnections.clear();
 
    if (image) {
        m_d->imageConnections.addConnection(image, SIGNAL(sigResolutionChanged(double, double)), this, SLOT(slotUpdateDocumentResolution()));
        m_d->imageConnections.addConnection(image, SIGNAL(sigSizeChanged(QPointF, QPointF)), this, SLOT(slotUpdateDocumentSize()));
    }
 
    KisDummiesFacadeBase::setImage(image, activeNode);
 
    slotUpdateDocumentResolution();
    slotUpdateDocumentSize();
}

References KisSignalAutoConnectionsStore::addConnection(), KisSignalAutoConnectionsStore::clear(), KisDummiesFacadeBase::image(), KisShapeController::Private::imageConnections, m_d, KisDummiesFacadeBase::setImage(), slotUpdateDocumentResolution(), and slotUpdateDocumentSize().

setInitialShapeForCanvas()

void KisShapeController::setInitialShapeForCanvas

(

KisCanvas2 *

canvas

)

Definition at line 224 of file kis_shape_controller.cpp.

{
    if (!image()) return;
 
    KisNodeSP rootNode = image()->root();
 
    if (m_d->shapesGraph.containsNode(rootNode)) {
        Q_ASSERT(canvas);
        Q_ASSERT(canvas->shapeManager());
        KoSelection *selection = canvas->shapeManager()->selection();
        if (selection && m_d->shapesGraph.nodeToShape(rootNode)) {
            selection->select(m_d->shapesGraph.nodeToShape(rootNode));
            KoToolManager::instance()->switchToolRequested(KoToolManager::instance()->preferredToolForSelection(selection->selectedShapes()));
        }
    }
}

References KisNodeShapesGraph::containsNode(), KisDummiesFacadeBase::image(), KoToolManager::instance(), m_d, KisNodeShapesGraph::nodeToShape(), KisNodeFacade::root, KoSelection::select(), KoSelection::selectedShapes(), KoShapeManager::selection, KisCanvas2::shapeManager, KisShapeController::Private::shapesGraph, and KoToolManager::switchToolRequested().

shapeForNode()

KoShapeLayer * KisShapeController::shapeForNode

(

KisNodeSP

layer

)

const

Definition at line 256 of file kis_shape_controller.cpp.

{
    if (node) {
        return m_d->shapesGraph.nodeToShape(node);
    }
    return 0;
}

References m_d, KisNodeShapesGraph::nodeToShape(), and KisShapeController::Private::shapesGraph.

slotUpdateDocumentResolution

void KisShapeController::slotUpdateDocumentResolution ( )

privateslot

Definition at line 79 of file kis_shape_controller.cpp.

{
    KisImageSP image = this->image();
 
    if (image) {
        const qreal pixelsPerInch = image->xRes() * 72.0;
        resourceManager()->setResource(KoDocumentResourceManager::DocumentResolution, pixelsPerInch);
    }
}

References KoDocumentResourceManager::DocumentResolution, KisDummiesFacadeBase::image(), pixelsPerInch(), KoShapeControllerBase::resourceManager(), KoDocumentResourceManager::setResource(), and KisImage::xRes().

slotUpdateDocumentSize

void KisShapeController::slotUpdateDocumentSize ( )

privateslot

Definition at line 89 of file kis_shape_controller.cpp.

{
    KisImageSP image = this->image();
 
    if (image) {
        resourceManager()->setResource(KoDocumentResourceManager::DocumentRectInPixels, image->bounds());
    }
}

References KisImage::bounds(), KoDocumentResourceManager::DocumentRectInPixels, KisDummiesFacadeBase::image(), KoShapeControllerBase::resourceManager(), and KoDocumentResourceManager::setResource().

Member Data Documentation

m_d

Private* const KisShapeController::m_d

private

Definition at line 86 of file kis_shape_controller.h.

---

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

• libs/ui/flake/kis_shape_controller.h
• libs/ui/flake/kis_shape_controller.cpp