#include <ToolReferenceImages.h>

Inheritance diagram for ToolReferenceImages:

Public Slots
void	activate (const QSet< KoShape * > &shapes) override

void	addReferenceImage ()

void	addReferenceImageFromLayer ()

void	addReferenceImageFromVisible ()

void	copy () const override

void	cut () override

void	deactivate () override

void	deselect () override

void	loadReferenceImages ()

bool	paste () override

void	pasteReferenceImage ()

void	removeAllReferenceImages ()

void	removeSelectedReferenceImages ()

void	saveReferenceImages ()

bool	selectAll () override

void	slotNodeAdded (KisNodeSP node)

void	slotNodeAdded (KisNodeSP node, KisNodeAdditionFlags flags)

void	slotSelectionChanged ()

Public Slots inherited from DefaultTool
void	activate (const QSet< KoShape * > &shapes) override

void	deactivate () override

Public Slots inherited from KoToolBase
virtual void	activate (const QSet< KoShape * > &shapes)

virtual void	deactivate ()

virtual void	documentResourceChanged (int key, const QVariant &res)

virtual void	repaintDecorations ()

virtual void	requestRedoDuringStroke ()

virtual void	requestStrokeCancellation ()

virtual void	requestStrokeEnd ()

virtual void	requestUndoDuringStroke ()

void	setStatusText (const QString &statusText)

void	updateOptionsWidgetIcons ()

Public Member Functions
void	deleteSelection () override
	reimplemented

bool	hasSelection () override

void	mouseDoubleClickEvent (KoPointerEvent *) override

QMenu *	popupActionsMenu () override

virtual quint32	priority ()

	ToolReferenceImages (KoCanvasBase *canvas)

	~ToolReferenceImages () override

Public Member Functions inherited from DefaultTool
void	copy () const override
	reimplemented

QRectF	decorationsRect () const override

	DefaultTool (KoCanvasBase *canvas, bool connectToSelectedShapesProxy=false)

void	deselect () override
	reimplemented

void	explicitUserStrokeEndRequest () override
	explicitUserStrokeEndRequest is called by the input manager when the user presses Enter key or any equivalent. This callback comes before requestStrokeEnd(), which comes from a different source.

KoFlake::SelectionHandle	handleAt (const QPointF &point, bool *innerHandleMeaning=0)

void	keyPressEvent (QKeyEvent *event) override

void	mouseMoveEvent (KoPointerEvent *event) override

void	mousePressEvent (KoPointerEvent *event) override

void	mouseReleaseEvent (KoPointerEvent *event) override

void	paint (QPainter &painter, const KoViewConverter &converter) override

bool	paste () override
	reimplemented

bool	selectAll () override
	reimplemented

KoToolSelection *	selection () override
	reimplemented

bool	wantsAutoScroll () const override

	~DefaultTool () override

Public Member Functions inherited from KoInteractionTool
void	keyPressEvent (QKeyEvent *event) override

void	keyReleaseEvent (QKeyEvent *event) override

	KoInteractionTool (KoCanvasBase *canvas)

void	mouseMoveEvent (KoPointerEvent *event) override

void	mousePressEvent (KoPointerEvent *event) override

void	mouseReleaseEvent (KoPointerEvent *event) override

void	paint (QPainter &painter, const KoViewConverter &converter) override

	~KoInteractionTool () override

Public Member Functions inherited from KoToolBase
QAction *	action (const QString &name) const

KoCanvasBase *	canvas () const
	Returns the canvas the tool is working on.

QCursor	cursor () const
	return the last emitted cursor

virtual void	customMoveEvent (KoPointerEvent *event)

virtual void	customPressEvent (KoPointerEvent *event)

virtual void	customReleaseEvent (KoPointerEvent *event)

virtual void	cut ()

int	decorationThickness () const
	decorationThickness The minimum thickness for tool decoration lines, this is derived from the screen magnification, thus the HiDPI settings. Note: to use this effectively, also set the pen to isCosmetic(true);

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event, const QPointF &point)

virtual void	dropEvent (QDropEvent *event, const QPointF &point)

KoToolFactoryBase *	factory () const

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

bool	isInTextMode () const

bool	isOpacityPresetMode () const

	KoToolBase (KoCanvasBase *canvas)

bool	maskSyntheticEvents () const

virtual void	mouseTripleClickEvent (KoPointerEvent *event)

QList< QPointer< QWidget > >	optionWidgets ()

virtual KisPopupWidgetInterface *	popupWidget ()

Q_INVOKABLE QString	toolId () const

	~KoToolBase () override

Protected Member Functions
QWidget *	createOptionWidget () override

QList< QPointer< QWidget > >	createOptionWidgets () override

bool	isValidForCurrentLayer () const override

KoSelection *	koSelection () const override

KoShapeManager *	shapeManager () const override

void	updateDistinctiveActions (const QList< KoShape * > &editableShapes) override

Protected Member Functions inherited from DefaultTool
void	addTransformActions (QMenu *menu) const

KoInteractionStrategy *	createStrategy (KoPointerEvent *event) override

Protected Member Functions inherited from KoInteractionTool
void	addInteractionFactory (KoInteractionStrategyFactory *factory)

void	cancelCurrentStrategy ()
	Cancels the current strategy and deletes it.

KoInteractionStrategy *	createStrategyBase (KoPointerEvent *event)

KoInteractionStrategy *	currentStrategy ()

bool	hasInteractionFactory (const QString &id)

	KoInteractionTool (KoInteractionToolPrivate &dd)

void	removeInteractionFactory (const QString &id)

bool	tryUseCustomCursor ()

Protected Member Functions inherited from KoToolBase
int	grabSensitivity () const
	Convenience function to get the current grab sensitivity.

qreal	handleDocRadius () const

QRectF	handleGrabRect (const QPointF &position) const

QRectF	handlePaintRect (const QPointF &position) const

int	handleRadius () const
	Convenience function to get the current handle radius.

bool	isActivated () const

	KoToolBase (KoToolBasePrivate &dd)

KoPointerEvent *	lastDeliveredPointerEvent () const

void	setAbstractResource (KoAbstractCanvasResourceInterfaceSP abstractResource)

void	setConverter (KoDerivedResourceConverterSP converter)

void	setIsOpacityPresetMode (bool value)

void	setMaskSyntheticEvents (bool value)

void	setTextMode (bool value)

QHash< int, KoAbstractCanvasResourceInterfaceSP >	toolAbstractResources ()

QHash< int, KoDerivedResourceConverterSP >	toolConverters ()

void	useCursor (const QCursor &cursor)

Private Member Functions
KisDocument *	document () const

void	setReferenceImageLayer (KisSharedPtr< KisReferenceImagesLayer > layer)

Private Attributes
KisWeakSharedPtr< KisReferenceImagesLayer >	m_layer

ToolReferenceImagesWidget *	m_optionsWidget = nullptr

Friends
class	ToolReferenceImagesWidget

Additional Inherited Members
Public Types inherited from DefaultTool
enum	CanvasResource { HotPosition = 1410100299 }

Signals inherited from DefaultTool
void	meshgradientHandleSelected (KoShapeMeshGradientHandles::Handle)

Signals inherited from KoToolBase
void	activateTool (const QString &id)

void	cursorChanged (const QCursor &cursor)

void	selectionChanged (bool hasSelection)

void	statusTextChanged (const QString &statusText)

void	textModeChanged (bool inTextMode)

Protected Slots inherited from DefaultTool
void	updateActions ()
	Update actions on selection change.

Protected Attributes inherited from DefaultTool
QScopedPointer< QMenu >	m_contextMenu

Protected Attributes inherited from KoToolBase
KoToolBasePrivate *	d_ptr

Detailed Description

Definition at line 26 of file ToolReferenceImages.h.

Constructor & Destructor Documentation

◆ ToolReferenceImages()

ToolReferenceImages::ToolReferenceImages ( KoCanvasBase * canvas )

Definition at line 39 of file ToolReferenceImages.cpp.

    : DefaultTool(canvas, false)
{
    setObjectName("ToolReferenceImages");
}

◆ ~ToolReferenceImages()

ToolReferenceImages::~ToolReferenceImages ( )

override

Definition at line 45 of file ToolReferenceImages.cpp.

46{

47}

Member Function Documentation

◆ activate

void ToolReferenceImages::activate ( const QSet< KoShape * > & shapes )

overrideslot

Definition at line 49 of file ToolReferenceImages.cpp.

{
    DefaultTool::activate(shapes);
 
    auto kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT(kisCanvas);
    connect(kisCanvas->image(), SIGNAL(sigNodeAddedAsync(KisNodeSP, KisNodeAdditionFlags)), this, SLOT(slotNodeAdded(KisNodeSP, KisNodeAdditionFlags)));
    connect(kisCanvas->imageView()->document(), &KisDocument::sigReferenceImagesLayerChanged, this, qOverload<KisNodeSP>(&ToolReferenceImages::slotNodeAdded));
 
    auto referenceImageLayer = document()->referenceImagesLayer();
    if (referenceImageLayer) {
        setReferenceImageLayer(referenceImageLayer);
    }
}

References DefaultTool::activate(), KoToolBase::canvas(), connect(), document(), KIS_ASSERT, KisDocument::referenceImagesLayer(), setReferenceImageLayer(), KisDocument::sigReferenceImagesLayerChanged(), and slotNodeAdded().

◆ addReferenceImage

void ToolReferenceImages::addReferenceImage ( )

slot

Definition at line 99 of file ToolReferenceImages.cpp.

{
    auto kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
 
            KoFileDialog dialog(kisCanvas->viewManager()->mainWindowAsQWidget(), KoFileDialog::OpenFile, "OpenReferenceImage");
    dialog.setCaption(i18n("Select a Reference Image"));
 
    QStringList locations = QStandardPaths::standardLocations(QStandardPaths::PicturesLocation);
    if (!locations.isEmpty()) {
        dialog.setDefaultDir(locations.first());
    }
 
    QString filename = dialog.filename();
    if (filename.isEmpty()) return;
    if (!QFileInfo(filename).exists()) return;
 
    auto *reference = KisReferenceImage::fromFile(filename, *kisCanvas->coordinatesConverter(), canvas()->canvasWidget());
    if (reference) {
        if (document()->referenceImagesLayer()) {
            reference->setZIndex(document()->referenceImagesLayer()->shapes().size());
        }
        canvas()->addCommand(KisReferenceImagesLayer::addReferenceImages(document(), {reference}));
    }
}

References KoCanvasBase::addCommand(), KisReferenceImagesLayer::addReferenceImages(), KoToolBase::canvas(), document(), KisReferenceImage::fromFile(), KIS_ASSERT_RECOVER_RETURN, and KoFileDialog::OpenFile.

◆ addReferenceImageFromLayer

void ToolReferenceImages::addReferenceImageFromLayer ( )

slot

Definition at line 125 of file ToolReferenceImages.cpp.

{
    KisCanvas2* kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
    kisCanvas->viewManager()->nodeManager()->createReferenceImageFromLayer();
}

References KoToolBase::canvas(), KisNodeManager::createReferenceImageFromLayer(), KIS_ASSERT_RECOVER_RETURN, KisViewManager::nodeManager(), and KisCanvas2::viewManager().

◆ addReferenceImageFromVisible

void ToolReferenceImages::addReferenceImageFromVisible ( )

slot

Definition at line 132 of file ToolReferenceImages.cpp.

{
    KisCanvas2* kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
    kisCanvas->viewManager()->nodeManager()->createReferenceImageFromVisible();
}

References KoToolBase::canvas(), KisNodeManager::createReferenceImageFromVisible(), KIS_ASSERT_RECOVER_RETURN, KisViewManager::nodeManager(), and KisCanvas2::viewManager().

◆ copy

void ToolReferenceImages::copy ( ) const

overrideslot

Definition at line 372 of file ToolReferenceImages.cpp.

{
    QList<KoShape *> shapes = koSelection()->selectedShapes();
    if (!shapes.isEmpty()) {
        KoShape* shape = shapes.at(0);
        KisReferenceImage *reference = dynamic_cast<KisReferenceImage*>(shape);
        KIS_SAFE_ASSERT_RECOVER_RETURN(reference);
        QClipboard *cb = QApplication::clipboard();
        cb->setImage(reference->getImage());
    }
}

References KisReferenceImage::getImage(), KIS_SAFE_ASSERT_RECOVER_RETURN, koSelection(), and KoSelection::selectedShapes().

◆ createOptionWidget()

QWidget * ToolReferenceImages::createOptionWidget ( )

overrideprotectedvirtual

Reimplement this if your tool actually has an option widget. Sets the option widget to 0 by default.

Reimplemented from KoToolBase.

Definition at line 279 of file ToolReferenceImages.cpp.

{
    if (!m_optionsWidget) {
        m_optionsWidget = new ToolReferenceImagesWidget(this);
        // See https://bugs.kde.org/show_bug.cgi?id=316896
        QWidget *specialSpacer = new QWidget(m_optionsWidget);
        specialSpacer->setObjectName("SpecialSpacer");
        specialSpacer->setFixedSize(0, 0);
        m_optionsWidget->layout()->addWidget(specialSpacer);
    }
    return m_optionsWidget;
}

References m_optionsWidget, and ToolReferenceImagesWidget.

◆ createOptionWidgets()

QList< QPointer< QWidget > > ToolReferenceImages::createOptionWidgets ( )

overrideprotectedvirtual

Reimplemented from DefaultTool.

Definition at line 273 of file ToolReferenceImages.cpp.

{
    // Instead of inheriting DefaultTool's multi-tab implementation, inherit straight from KoToolBase
    return KoToolBase::createOptionWidgets();
}

References KoToolBase::createOptionWidgets().

◆ cut

void ToolReferenceImages::cut ( )

overrideslot

Definition at line 366 of file ToolReferenceImages.cpp.

{
    copy();
    deleteSelection();
}

References copy(), and deleteSelection().

◆ deactivate

void ToolReferenceImages::deactivate ( )

overrideslot

Definition at line 64 of file ToolReferenceImages.cpp.

{
    DefaultTool::deactivate();
}

References DefaultTool::deactivate().

◆ deleteSelection()

void ToolReferenceImages::deleteSelection ( )

overridevirtual

reimplemented

Reimplemented from DefaultTool.

Definition at line 319 of file ToolReferenceImages.cpp.

{
    auto layer = m_layer.toStrongRef();
    if (!layer) return;
 
    QList<KoShape *> shapes = koSelection()->selectedShapes();
 
    if (!shapes.empty()) {
        canvas()->addCommand(layer->removeReferenceImages(document(), shapes));
    }
}

References KoCanvasBase::addCommand(), KoToolBase::canvas(), koSelection(), m_layer, KoSelection::selectedShapes(), and KisWeakSharedPtr< T >::toStrongRef().

◆ deselect

void ToolReferenceImages::deselect ( )

overrideslot

Definition at line 401 of file ToolReferenceImages.cpp.

{
    koSelection()->deselectAll();
    repaintDecorations();
}

References KoSelection::deselectAll(), koSelection(), and KoToolBase::repaintDecorations().

◆ document()

KisDocument * ToolReferenceImages::document ( ) const

private

Definition at line 407 of file ToolReferenceImages.cpp.

{
    auto kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT(kisCanvas);
    return kisCanvas->imageView()->document();
}

References KoToolBase::canvas(), and KIS_ASSERT.

◆ hasSelection()

bool ToolReferenceImages::hasSelection ( )

overridevirtual

Returns: true if the tool has selected data.

Reimplemented from KoToolBase.

Definition at line 93 of file ToolReferenceImages.cpp.

{
    const KoShapeManager *manager = shapeManager();
    return manager && manager->selection()->count() != 0;
}

References KoSelection::count(), KoShapeManager::selection, and shapeManager().

◆ isValidForCurrentLayer()

bool ToolReferenceImages::isValidForCurrentLayer ( ) const

overrideprotectedvirtual

Reimplemented from DefaultTool.

Definition at line 292 of file ToolReferenceImages.cpp.

{
    return true;
}

◆ koSelection()

KoSelection * ToolReferenceImages::koSelection ( ) const

overrideprotectedvirtual

Reimplemented from DefaultTool.

Definition at line 303 of file ToolReferenceImages.cpp.

{
    auto manager = shapeManager();
    return manager ? manager->selection() : nullptr;
}

References shapeManager().

◆ loadReferenceImages

void ToolReferenceImages::loadReferenceImages ( )

slot

Definition at line 175 of file ToolReferenceImages.cpp.

{
    auto kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
 
            KoFileDialog dialog(kisCanvas->viewManager()->mainWindowAsQWidget(), KoFileDialog::OpenFile, "OpenReferenceImageCollection");
    dialog.setMimeTypeFilters(QStringList() << "application/x-krita-reference-images");
    dialog.setCaption(i18n("Load Reference Images"));
 
    QStringList locations = QStandardPaths::standardLocations(QStandardPaths::PicturesLocation);
    if (!locations.isEmpty()) {
        dialog.setDefaultDir(locations.first());
    }
 
    QString filename = dialog.filename();
    if (filename.isEmpty()) return;
    if (!QFileInfo(filename).exists()) return;
 
    QFile file(filename);
    if (!file.open(QIODevice::ReadOnly)) {
        QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita"), i18n("Could not open '%1'.", filename));
        return;
    }
 
    KisReferenceImageCollection collection;
 
    int currentZIndex = 0;
    if (document()->referenceImagesLayer()) {
        currentZIndex = document()->referenceImagesLayer()->shapes().size();
    }
 
    if (collection.load(&file)) {
        QList<KoShape*> shapes;
        Q_FOREACH(auto *reference, collection.referenceImages()) {
            reference->setZIndex(currentZIndex);
            shapes.append(reference);
            currentZIndex += 1;
        }
 
        canvas()->addCommand(KisReferenceImagesLayer::addReferenceImages(document(), shapes));
    } else {
        QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita"), i18n("Could not load reference images from '%1'.", filename));
    }
    file.close();
}

References KoCanvasBase::addCommand(), KisReferenceImagesLayer::addReferenceImages(), KoToolBase::canvas(), document(), KIS_ASSERT_RECOVER_RETURN, KisReferenceImageCollection::load(), KoFileDialog::OpenFile, KisReferenceImageCollection::referenceImages(), KisDocument::referenceImagesLayer(), and KoShapeContainer::shapes().

◆ mouseDoubleClickEvent()

void ToolReferenceImages::mouseDoubleClickEvent ( KoPointerEvent * event )

inlineoverridevirtual

Called when (one of) the mouse or stylus buttons is double clicked. Implementors should call event->ignore() if they do not actually use the event. Default implementation ignores this event.

Parameters

event state and reason of this mouse or stylus press

Reimplemented from DefaultTool.

Definition at line 38 of file ToolReferenceImages.h.

38{}

◆ paste

bool ToolReferenceImages::paste ( )

overrideslot

Definition at line 384 of file ToolReferenceImages.cpp.

{
    pasteReferenceImage();
    return true;
}

References pasteReferenceImage().

◆ pasteReferenceImage

void ToolReferenceImages::pasteReferenceImage ( )

slot

Definition at line 139 of file ToolReferenceImages.cpp.

{
    KisCanvas2* kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
 
    KisReferenceImage* reference = KisReferenceImage::fromClipboard(*kisCanvas->coordinatesConverter());
    if (reference) {
        if (document()->referenceImagesLayer()) {
            reference->setZIndex(document()->referenceImagesLayer()->shapes().size());
        }
        canvas()->addCommand(KisReferenceImagesLayer::addReferenceImages(document(), {reference}));
    } else {
        if (canvas()->canvasWidget()) {
            QMessageBox::critical(canvas()->canvasWidget(), i18nc("@title:window", "Krita"), i18n("Could not load reference image from clipboard"));
        }
    }
}

References KoCanvasBase::addCommand(), KisReferenceImagesLayer::addReferenceImages(), KoToolBase::canvas(), KisCanvas2::coordinatesConverter, document(), KisReferenceImage::fromClipboard(), KIS_ASSERT_RECOVER_RETURN, and KoShape::setZIndex().

◆ popupActionsMenu()

QMenu * ToolReferenceImages::popupActionsMenu ( )

overridevirtual

Returns: a menu with context-aware actions for the current selection. If the returned value is null, no context menu is shown.

Reimplemented from DefaultTool.

Definition at line 331 of file ToolReferenceImages.cpp.

{
    if (m_contextMenu) {
        m_contextMenu->clear();
        m_contextMenu->addSection(i18n("Reference Image Actions"));
        m_contextMenu->addSeparator();
 
        QMenu *transform = m_contextMenu->addMenu(i18n("Transform"));
 
        transform->addAction(action("object_transform_rotate_90_cw"));
        transform->addAction(action("object_transform_rotate_90_ccw"));
        transform->addAction(action("object_transform_rotate_180"));
        transform->addSeparator();
        transform->addAction(action("object_transform_mirror_horizontally"));
        transform->addAction(action("object_transform_mirror_vertically"));
        transform->addSeparator();
        transform->addAction(action("object_transform_reset"));
 
        m_contextMenu->addSeparator();
 
        m_contextMenu->addAction(action("edit_cut"));
        m_contextMenu->addAction(action("edit_copy"));
        m_contextMenu->addAction(action("edit_paste"));
 
        m_contextMenu->addSeparator();
 
        m_contextMenu->addAction(action("object_order_front"));
        m_contextMenu->addAction(action("object_order_raise"));
        m_contextMenu->addAction(action("object_order_lower"));
        m_contextMenu->addAction(action("object_order_back"));
    }
 
    return m_contextMenu.data();
}

References KoToolBase::action(), and DefaultTool::m_contextMenu.

◆ priority()

virtual quint32 ToolReferenceImages::priority ( )

inlinevirtual

Definition at line 34 of file ToolReferenceImages.h.

                               {
        return 3;
    }

◆ removeAllReferenceImages

void ToolReferenceImages::removeAllReferenceImages ( )

slot

Definition at line 167 of file ToolReferenceImages.cpp.

{
    auto layer = m_layer.toStrongRef();
    if (!layer) return;
 
    canvas()->addCommand(layer->removeReferenceImages(document(), layer->shapes()));
}

References KoCanvasBase::addCommand(), KoToolBase::canvas(), m_layer, and KisWeakSharedPtr< T >::toStrongRef().

◆ removeSelectedReferenceImages

void ToolReferenceImages::removeSelectedReferenceImages ( )

slot

Definition at line 157 of file ToolReferenceImages.cpp.

{
    auto layer = m_layer.toStrongRef();
    if (!layer) return;
    if (!koSelection()) return;
    if (koSelection()->selectedEditableShapes().isEmpty()) return;
 
    canvas()->addCommand(layer->removeReferenceImages(document(), koSelection()->selectedEditableShapes()));
}

References KoCanvasBase::addCommand(), KoToolBase::canvas(), koSelection(), m_layer, and KisWeakSharedPtr< T >::toStrongRef().

◆ saveReferenceImages

void ToolReferenceImages::saveReferenceImages ( )

slot

Definition at line 221 of file ToolReferenceImages.cpp.

{
    KisCursorOverrideLock cursorLock(Qt::BusyCursor);
 
    auto layer = m_layer.toStrongRef();
    if (!layer || layer->shapeCount() == 0) return;
 
    auto kisCanvas = dynamic_cast<KisCanvas2*>(canvas());
    KIS_ASSERT_RECOVER_RETURN(kisCanvas);
 
            KoFileDialog dialog(kisCanvas->viewManager()->mainWindowAsQWidget(), KoFileDialog::SaveFile, "SaveReferenceImageCollection");
    QString mimetype = "application/x-krita-reference-images";
    dialog.setMimeTypeFilters(QStringList() << mimetype, mimetype);
    dialog.setCaption(i18n("Save Reference Images"));
 
    QStringList locations = QStandardPaths::standardLocations(QStandardPaths::PicturesLocation);
    if (!locations.isEmpty()) {
        dialog.setDefaultDir(locations.first());
    }
 
    QString filename = dialog.filename();
    if (filename.isEmpty()) return;
 
    QString fileMime = KisMimeDatabase::mimeTypeForFile(filename, false);
    if (fileMime != "application/x-krita-reference-images") {
        filename.append(filename.endsWith(".") ? "krf" : ".krf");
    }
 
    QFile file(filename);
    if (!file.open(QIODevice::WriteOnly)) {
        QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita"), i18n("Could not open '%1' for saving.", filename));
        return;
    }
 
    KisReferenceImageCollection collection(layer->referenceImages());
    bool ok = collection.save(&file);
    file.close();
 
    if (!ok) {
        QMessageBox::critical(qApp->activeWindow(), i18nc("@title:window", "Krita"), i18n("Failed to save reference images."));
    }
}

References KoToolBase::canvas(), KIS_ASSERT_RECOVER_RETURN, m_layer, KisMimeDatabase::mimeTypeForFile(), KisReferenceImageCollection::save(), KoFileDialog::SaveFile, and KisWeakSharedPtr< T >::toStrongRef().

◆ selectAll

bool ToolReferenceImages::selectAll ( )

overrideslot

Definition at line 390 of file ToolReferenceImages.cpp.

{
    Q_FOREACH(KoShape *shape, shapeManager()->shapes()) {
        if (!shape->isSelectable()) continue;
        koSelection()->select(shape);
    }
    repaintDecorations();
 
    return true;
}

References KoShape::isSelectable(), koSelection(), KoToolBase::repaintDecorations(), KoSelection::select(), and shapeManager().

◆ setReferenceImageLayer()

void ToolReferenceImages::setReferenceImageLayer ( KisSharedPtr< KisReferenceImagesLayer > layer )

private

Definition at line 85 of file ToolReferenceImages.cpp.

{
    m_layer = layer;
    connect(layer.data(), SIGNAL(selectionChanged()), this, SLOT(slotSelectionChanged()));
    connect(layer->shapeManager(), SIGNAL(selectionChanged()), this, SLOT(repaintDecorations()));
    connect(layer->shapeManager(), SIGNAL(selectionContentChanged()), this, SLOT(repaintDecorations()));
}

References connect(), KisSharedPtr< T >::data(), m_layer, KoToolBase::repaintDecorations(), KoToolBase::selectionChanged(), and slotSelectionChanged().

◆ shapeManager()

KoShapeManager * ToolReferenceImages::shapeManager ( ) const

overrideprotectedvirtual

Reimplemented from DefaultTool.

Definition at line 297 of file ToolReferenceImages.cpp.

{
    auto layer = m_layer.toStrongRef();
    return layer ? layer->shapeManager() : nullptr;
}

References m_layer, KisShapeLayer::shapeManager(), and KisWeakSharedPtr< T >::toStrongRef().

◆ slotNodeAdded [1/2]

void ToolReferenceImages::slotNodeAdded ( KisNodeSP node )

slot

Definition at line 69 of file ToolReferenceImages.cpp.

{
    slotNodeAdded(node, KisNodeAdditionFlag::None);
}

References None, and slotNodeAdded().

◆ slotNodeAdded [2/2]

void ToolReferenceImages::slotNodeAdded	(	KisNodeSP	node,
		KisNodeAdditionFlags	flags )

slot

Definition at line 74 of file ToolReferenceImages.cpp.

{
    Q_UNUSED(flags)
 
    auto *referenceImagesLayer = dynamic_cast<KisReferenceImagesLayer*>(node.data());
 
    if (referenceImagesLayer) {
        setReferenceImageLayer(referenceImagesLayer);
    }
}

References KisSharedPtr< T >::data(), and setReferenceImageLayer().

◆ slotSelectionChanged

void ToolReferenceImages::slotSelectionChanged ( )

slot

Definition at line 264 of file ToolReferenceImages.cpp.

{
    auto layer = m_layer.toStrongRef();
    if (!layer) return;
 
    m_optionsWidget->selectionChanged(layer->shapeManager()->selection());
    updateActions();
}

References m_layer, m_optionsWidget, ToolReferenceImagesWidget::selectionChanged(), KisWeakSharedPtr< T >::toStrongRef(), and DefaultTool::updateActions().

◆ updateDistinctiveActions()

void ToolReferenceImages::updateDistinctiveActions ( const QList< KoShape * > & editableShapes )

overrideprotectedvirtual

Enable/disable actions specific to the tool (vector vs. reference images)

Reimplemented from DefaultTool.

Definition at line 309 of file ToolReferenceImages.cpp.

{
    action("object_group")->setEnabled(false);
    action("object_unite")->setEnabled(false);
    action("object_intersect")->setEnabled(false);
    action("object_subtract")->setEnabled(false);
    action("object_split")->setEnabled(false);
    action("object_ungroup")->setEnabled(false);
}

References KoToolBase::action().

Friends And Related Symbol Documentation

◆ ToolReferenceImagesWidget

friend class ToolReferenceImagesWidget

friend

Definition at line 82 of file ToolReferenceImages.h.

Member Data Documentation

◆ m_layer

KisWeakSharedPtr<KisReferenceImagesLayer> ToolReferenceImages::m_layer

private

Definition at line 84 of file ToolReferenceImages.h.

◆ m_optionsWidget

ToolReferenceImagesWidget* ToolReferenceImages::m_optionsWidget = nullptr

private

Definition at line 83 of file ToolReferenceImages.h.

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

plugins/tools/defaulttool/referenceimagestool/ToolReferenceImages.h
plugins/tools/defaulttool/referenceimagestool/ToolReferenceImages.cpp

Public Slots

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ToolReferenceImages()

◆ ~ToolReferenceImages()

Member Function Documentation

◆ activate

◆ addReferenceImage

◆ addReferenceImageFromLayer

◆ addReferenceImageFromVisible

◆ copy

◆ createOptionWidget()

◆ createOptionWidgets()

◆ cut

◆ deactivate

◆ deleteSelection()

◆ deselect

◆ document()

◆ hasSelection()

◆ isValidForCurrentLayer()

◆ koSelection()

◆ loadReferenceImages

◆ mouseDoubleClickEvent()

◆ paste

◆ pasteReferenceImage

◆ popupActionsMenu()

◆ priority()

◆ removeAllReferenceImages

◆ removeSelectedReferenceImages

◆ saveReferenceImages

◆ selectAll

◆ setReferenceImageLayer()

◆ shapeManager()

◆ slotNodeAdded [1/2]

◆ slotNodeAdded [2/2]

◆ slotSelectionChanged

◆ updateDistinctiveActions()

Friends And Related Symbol Documentation

◆ ToolReferenceImagesWidget

Member Data Documentation

◆ m_layer

◆ m_optionsWidget