Selection Class Reference

#include <Selection.h>

Inheritance diagram for Selection:

Public Slots
void	add (Selection *selection)
void	border (int xRadius, int yRadius)
void	clear ()
void	contract (int value)
void	copy (Node *node)
	copy copies the area defined by the selection from the node to the clipboard.
void	cut (Node *node)
	cut erases the area defined by the selection from the node and puts a copy on the clipboard.
void	dilate ()
Selection *	duplicate () const
void	erode ()
void	feather (int radius)
void	grow (int xradius, int yradius)
int	height () const
void	intersect (Selection *selection)
void	invert ()
void	move (int x, int y)
void	paste (Node *destination, int x, int y)
	paste pastes the content of the clipboard to the given node, limited by the area of the current selection.
QByteArray	pixelData (int x, int y, int w, int h) const
	pixelData reads the given rectangle from the Selection's mask and returns it as a byte array. The pixel data starts top-left, and is ordered row-first.
void	replace (Selection *selection)
void	resize (int w, int h)
void	select (int x, int y, int w, int h, int value)
void	selectAll (Node *node, int value)
void	setPixelData (QByteArray value, int x, int y, int w, int h)
	setPixelData writes the given bytes, of which there must be enough, into the Selection.
void	shrink (int xRadius, int yRadius, bool edgeLock)
void	smooth ()
void	subtract (Selection *selection)
void	symmetricdifference (Selection *selection)
int	width () const
int	x () const
int	y () const

Public Member Functions
bool	operator!= (const Selection &other) const
bool	operator== (const Selection &other) const
	Selection (KisSelectionSP selection, QObject *parent=0)
	Selection (QObject *parent=0)
	~Selection () override

Private Member Functions
KisSelectionSP	selection () const

Private Attributes
Private *const	d

Friends
class	Document
class	FillLayer
class	FilterLayer
class	FilterMask
class	SelectionMask
class	TransparencyMask

Detailed Description

Selection represents a selection on Krita. A selection is not necessarily associated with a particular Node or Image.

from krita import *
 
d = Application.activeDocument()
n = d.activeNode()
r = n.bounds() 
s = Selection()
s.select(r.width() / 3, r.height() / 3, r.width() / 3, r.height() / 3, 255)
s.cut(n)

Definition at line 30 of file Selection.h.

Constructor & Destructor Documentation

Selection() [1/2]

Selection::Selection	(	KisSelectionSP	selection,
		QObject *	parent = 0 )

For internal use only.

Definition at line 28 of file Selection.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->selection = selection;
}

References d, krita::Selection::Private::selection, and selection().

Selection() [2/2]

Selection::Selection ( QObject * parent = 0 )

explicit

Create a new, empty selection object.

Definition at line 36 of file Selection.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->selection = new KisSelection();
}

References d, and krita::Selection::Private::selection.

~Selection()

Selection::~Selection ( )

override

Definition at line 43 of file Selection.cpp.

{
    delete d;
}

References d.

Member Function Documentation

add

void Selection::add ( Selection * selection )

slot

Add the given selection's selected pixels to the current selection.

Definition at line 255 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->applySelection(selection->selection()->pixelSelection(), SELECTION_ADD);
}

References KisPixelSelection::applySelection(), d, KisSelection::pixelSelection, krita::Selection::Private::selection, selection(), and SELECTION_ADD.

border

void Selection::border ( int xRadius, int yRadius )

slot

Border the selection with the given radius.

Definition at line 181 of file Selection.cpp.

{
    if (!d->selection) return;
    KisBorderSelectionFilter sf(xRadius, yRadius, true);
    QRect rc = sf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    sf.process(d->selection->pixelSelection(), rc);
}

References KisBorderSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisBorderSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

clear

void Selection::clear ( )

slot

Make the selection entirely unselected.

Definition at line 103 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->clear();
}

References KisSelection::clear(), d, and krita::Selection::Private::selection.

contract

void Selection::contract ( int value )

slot

Make the selection's width and height smaller by the given value. This will not move the selection's top-left position.

Definition at line 109 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->select(QRect(x(), y(), width() - value, height() - value));
}

References d, height(), KisSelection::pixelSelection, KisPixelSelection::select(), krita::Selection::Private::selection, value(), width(), x(), and y().

copy

void Selection::copy ( Node * node )

slot

copy copies the area defined by the selection from the node to the clipboard.

Parameters

node	the node from where the pixels will be copied.

Definition at line 115 of file Selection.cpp.

{
    if (!node) return;
    if (!d->selection) return;
    if (node->node()->exactBounds().isEmpty()) return;
    if (!node->node()->hasEditablePaintDevice()) return;
 
    KisImageSP image = node->node()->image();
    if (!image) return;
 
    KisPaintDeviceSP dev(new KisPaintDevice(*node->node()->paintDevice()));
    KisToolUtils::trimDeviceForClipboard(image, dev, d->selection);
 
    KisNodeSP newNode = new KisPaintLayer(image, "selection", OPACITY_OPAQUE_U8, dev);
    KisNodeList nodes{newNode};
 
    KisImageSP tempImage = KisToolUtils::buildImageForClipboard(image, nodes);
    KisClipboard::instance()->setLayers(nodes, tempImage, d->selection->selectedExactRect());
}

References KisToolUtils::buildImageForClipboard(), d, KisBaseNode::exactBounds(), KisBaseNode::hasEditablePaintDevice(), KisBaseNode::image, KisClipboard::instance(), Node::node(), OPACITY_OPAQUE_U8, KisBaseNode::paintDevice(), KisSelection::selectedExactRect(), krita::Selection::Private::selection, KisClipboard::setLayers(), and KisToolUtils::trimDeviceForClipboard().

cut

void Selection::cut ( Node * node )

slot

cut erases the area defined by the selection from the node and puts a copy on the clipboard.

Parameters

node	the node from which the selection will be cut.

Definition at line 135 of file Selection.cpp.

{
    if (!node) return;
    if (!d->selection) return;
    if (node->node()->exactBounds().isEmpty()) return;
    if (!node->node()->hasEditablePaintDevice()) return;
    KisPaintDeviceSP dev = node->node()->paintDevice();
    copy(node);
    dev->clearSelection(d->selection);
    node->node()->setDirty(d->selection->selectedExactRect());
}

References KisPaintDevice::clearSelection(), copy(), d, KisBaseNode::exactBounds(), KisBaseNode::hasEditablePaintDevice(), Node::node(), KisBaseNode::paintDevice(), KisSelection::selectedExactRect(), krita::Selection::Private::selection, and KisNode::setDirty().

dilate

void Selection::dilate ( )

slot

Dilate the selection with a radius of 1 pixel.

Definition at line 173 of file Selection.cpp.

{
    if (!d->selection) return;
    KisDilateSelectionFilter dsf;
    QRect rc = dsf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    dsf.process(d->selection->pixelSelection(), rc);
}

References KisDilateSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisDilateSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

duplicate

Selection * Selection::duplicate ( ) const

slot

Returns

a duplicate of the selection

Definition at line 58 of file Selection.cpp.

{
    return new Selection(d->selection ? new KisSelection(*d->selection)
                         : new KisSelection());
}

References d, krita::Selection::Private::selection, and Selection().

erode

void Selection::erode ( )

slot

Erode the selection with a radius of 1 pixel.

Definition at line 165 of file Selection.cpp.

{
    if (!d->selection) return;
    KisErodeSelectionFilter esf;
    QRect rc = esf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    esf.process(d->selection->pixelSelection(), rc);
}

References KisErodeSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisErodeSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

feather

void Selection::feather ( int radius )

slot

Feather the selection with the given radius.

Definition at line 189 of file Selection.cpp.

{
    if (!d->selection) return;
    KisFeatherSelectionFilter fsf(radius);
    QRect rc = fsf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    fsf.process(d->selection->pixelSelection(), rc);
}

References KisFeatherSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisFeatherSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

grow

void Selection::grow ( int xradius, int yradius )

slot

Grow the selection with the given radius.

Definition at line 197 of file Selection.cpp.

{
    if (!d->selection) return;
    KisGrowSelectionFilter gsf(xradius, yradius);
    QRect rc = gsf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    gsf.process(d->selection->pixelSelection(), rc);
}

References KisGrowSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisGrowSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

height

int Selection::height ( ) const

slot

Returns

the height of the selection

Definition at line 70 of file Selection.cpp.

{
    if (!d->selection) return 0;
    return d->selection->selectedExactRect().height();
}

References d, KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

intersect

void Selection::intersect ( Selection * selection )

slot

Intersect the given selection with this selection.

Definition at line 267 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->applySelection(selection->selection()->pixelSelection(), SELECTION_INTERSECT);
}

References KisPixelSelection::applySelection(), d, KisSelection::pixelSelection, krita::Selection::Private::selection, selection(), and SELECTION_INTERSECT.

invert

void Selection::invert ( )

slot

Invert the selection.

Definition at line 223 of file Selection.cpp.

{
    if (!d->selection) return;
    KisInvertSelectionFilter sf;
    QRect rc = sf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    sf.process(d->selection->pixelSelection(), rc);
}

References KisInvertSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisInvertSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

move

void Selection::move ( int x, int y )

slot

Move the selection's top-left corner to the given coordinates.

Definition at line 96 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->moveTo(QPoint(x, y));
}

References d, KisPixelSelection::moveTo(), KisSelection::pixelSelection, krita::Selection::Private::selection, x(), and y().

operator!=()

bool Selection::operator!=

(

const Selection &

other

)

const

Definition at line 53 of file Selection.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool Selection::operator==

(

const Selection &

other

)

const

Definition at line 48 of file Selection.cpp.

{
    return (d->selection == other.d->selection);
}

References d, and krita::Selection::Private::selection.

paste

void Selection::paste ( Node * destination, int x, int y )

slot

paste pastes the content of the clipboard to the given node, limited by the area of the current selection.

Parameters

destination	the node where the pixels will be written
x	the x position at which the clip will be written
y	the y position at which the clip will be written

Definition at line 147 of file Selection.cpp.

{
    if (!destination) return;
    if (!d->selection) return;
    if (!KisClipboard::instance()->hasClip()) return;
 
    KisDefaultBoundsBaseSP defaultBounds = destination->node()->paintDevice()->defaultBounds();
    KisPaintDeviceSP src = KisClipboard::instance()->clip(defaultBounds, false);
    KisPaintDeviceSP dst = destination->node()->paintDevice();
    if (!dst || !src) return;
    KisPainter::copyAreaOptimized(QPoint(x, y),
                                  src,
                                  dst,
                                  src->exactBounds(),
                                  d->selection);
    destination->node()->setDirty();
}

References KisClipboard::clip, KisPainter::copyAreaOptimized(), d, KisPaintDevice::defaultBounds(), KisClipboard::instance(), Node::node(), KisBaseNode::paintDevice(), krita::Selection::Private::selection, KisNode::setDirty(), x(), and y().

pixelData

QByteArray Selection::pixelData ( int x, int y, int w, int h ) const

slot

pixelData reads the given rectangle from the Selection's mask and returns it as a byte array. The pixel data starts top-left, and is ordered row-first.

The byte array will contain one byte for every pixel, representing the selectedness. 0 is totally unselected, 255 is fully selected.

You can read outside the Selection's boundaries; those pixels will be unselected.

The byte array is a copy of the original selection data.

Parameters

x	x position from where to start reading
y	y position from where to start reading
w	row length to read
h	number of rows to read

Returns

a QByteArray with the pixel data. The byte array may be empty.

Definition at line 280 of file Selection.cpp.

{
    QByteArray ba;
    if (!d->selection) return ba;
    KisPaintDeviceSP dev = d->selection->projection();
    quint8 *data = new quint8[w * h];
    dev->readBytes(data, x, y, w, h);
    ba = QByteArray((const char*)data, (int)(w * h));
    delete[] data;
    return ba;
}

References d, KisSelection::projection(), KisPaintDevice::readBytes(), krita::Selection::Private::selection, x(), and y().

replace

void Selection::replace ( Selection * selection )

slot

Replace the current selection's selection with the one of the given selection.

Definition at line 249 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->applySelection(selection->selection()->pixelSelection(), SELECTION_REPLACE);
}

References KisPixelSelection::applySelection(), d, KisSelection::pixelSelection, krita::Selection::Private::selection, selection(), and SELECTION_REPLACE.

resize

void Selection::resize ( int w, int h )

slot

Resize the selection to the given width and height. The top-left position will not be moved.

Definition at line 231 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->select(QRect(x(), y(), w, h));
}

References d, KisSelection::pixelSelection, KisPixelSelection::select(), krita::Selection::Private::selection, x(), and y().

select

void Selection::select ( int x, int y, int w, int h, int value )

slot

Select the given area. The value can be between 0 and 255; 0 is totally unselected, 255 is totally selected.

Definition at line 237 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->select(QRect(x, y, w, h), value);
}

References d, KisSelection::pixelSelection, KisPixelSelection::select(), krita::Selection::Private::selection, value(), x(), and y().

selectAll

void Selection::selectAll ( Node * node, int value )

slot

Select all pixels in the given node. The value can be between 0 and 255; 0 is totally unselected, 255 is totally selected.

Definition at line 243 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->select(node->node()->exactBounds(), value);
}

References d, KisBaseNode::exactBounds(), Node::node(), KisSelection::pixelSelection, KisPixelSelection::select(), krita::Selection::Private::selection, and value().

selection()

KisSelectionSP Selection::selection ( ) const

private

Definition at line 300 of file Selection.cpp.

{
    return d->selection;
}

References d, and krita::Selection::Private::selection.

setPixelData

void Selection::setPixelData ( QByteArray value, int x, int y, int w, int h )

slot

setPixelData writes the given bytes, of which there must be enough, into the Selection.

Parameters

value	the byte array representing the pixels. There must be enough bytes available. Krita will take the raw pointer from the QByteArray and start reading, not stopping before (w * h) bytes are read.
x	the x position to start writing from
y	the y position to start writing from
w	the width of each row
h	the number of rows to write

Definition at line 292 of file Selection.cpp.

{
    if (!d->selection) return;
    KisPixelSelectionSP dev = d->selection->pixelSelection();
    if (!dev) return;
    dev->writeBytes((const quint8*)value.constData(), x, y, w, h);
}

References d, KisSelection::pixelSelection, krita::Selection::Private::selection, value(), KisPaintDevice::writeBytes(), x(), and y().

shrink

void Selection::shrink ( int xRadius, int yRadius, bool edgeLock )

slot

Shrink the selection with the given radius.

Definition at line 206 of file Selection.cpp.

{
    if (!d->selection) return;
    KisShrinkSelectionFilter sf(xRadius, yRadius, edgeLock);
    QRect rc = sf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    sf.process(d->selection->pixelSelection(), rc);
}

References KisShrinkSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisShrinkSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

smooth

void Selection::smooth ( )

slot

Smooth the selection.

Definition at line 214 of file Selection.cpp.

{
    if (!d->selection) return;
    KisSmoothSelectionFilter sf;
    QRect rc = sf.changeRect(d->selection->selectedExactRect(), d->selection->pixelSelection()->defaultBounds());
    sf.process(d->selection->pixelSelection(), rc);
}

References KisSmoothSelectionFilter::changeRect(), d, KisPaintDevice::defaultBounds(), KisSelection::pixelSelection, KisSmoothSelectionFilter::process(), KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

subtract

void Selection::subtract ( Selection * selection )

slot

Subtract the given selection's selected pixels from the current selection.

Definition at line 261 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->applySelection(selection->selection()->pixelSelection(), SELECTION_SUBTRACT);
}

References KisPixelSelection::applySelection(), d, KisSelection::pixelSelection, krita::Selection::Private::selection, selection(), and SELECTION_SUBTRACT.

symmetricdifference

void Selection::symmetricdifference ( Selection * selection )

slot

Intersect with the inverse of the given selection with this selection.

Definition at line 273 of file Selection.cpp.

{
    if (!d->selection) return;
    d->selection->pixelSelection()->applySelection(selection->selection()->pixelSelection(), SELECTION_SYMMETRICDIFFERENCE);
}

References KisPixelSelection::applySelection(), d, KisSelection::pixelSelection, krita::Selection::Private::selection, selection(), and SELECTION_SYMMETRICDIFFERENCE.

width

int Selection::width ( ) const

slot

Returns

the width of the selection

Definition at line 64 of file Selection.cpp.

{
    if (!d->selection) return 0;
    return d->selection->selectedExactRect().width();
}

References d, KisSelection::selectedExactRect(), and krita::Selection::Private::selection.

x

int Selection::x ( ) const

slot

Returns

the left-hand position of the selection.

Definition at line 76 of file Selection.cpp.

{
    if (!d->selection) return 0;
    int xPos = d->selection->x();
    if (d->selection->hasNonEmptyPixelSelection()) {
        xPos = d->selection->selectedExactRect().x();
    }
    return xPos;
}

References d, KisSelection::hasNonEmptyPixelSelection(), KisSelection::selectedExactRect(), krita::Selection::Private::selection, and KisSelection::x().

y

int Selection::y ( ) const

slot

Returns

the top position of the selection.

Definition at line 86 of file Selection.cpp.

{
    if (!d->selection) return 0;
    int yPos = d->selection->y();
    if (d->selection->hasNonEmptyPixelSelection()) {
        yPos = d->selection->selectedExactRect().y();
    }
    return yPos;
}

References d, KisSelection::hasNonEmptyPixelSelection(), KisSelection::selectedExactRect(), krita::Selection::Private::selection, and KisSelection::y().

Friends And Related Symbol Documentation

Document

friend class Document

friend

Definition at line 231 of file Selection.h.

FillLayer

friend class FillLayer

friend

Definition at line 233 of file Selection.h.

FilterLayer

friend class FilterLayer

friend

Definition at line 232 of file Selection.h.

FilterMask

friend class FilterMask

friend

Definition at line 236 of file Selection.h.

SelectionMask

friend class SelectionMask

friend

Definition at line 234 of file Selection.h.

TransparencyMask

friend class TransparencyMask

friend

Definition at line 235 of file Selection.h.

Member Data Documentation

d

Private* const Selection::d

private

Definition at line 241 of file Selection.h.

---

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

• libs/libkis/Selection.h
• libs/libkis/Selection.cpp