Shape Class Reference

The Shape class The shape class is a wrapper around Krita's vector objects. More...

#include <Shape.h>

Inheritance diagram for Shape:

Classes
struct	Private

Public Slots
QTransform	absoluteTransformation () const
	transformation the 2D transformation matrix of the shape including all grandparent transforms.
QRectF	boundingBox () const
	boundingBox the bounding box of the shape in points
void	deselect ()
	deselect deselects the shape.
bool	geometryProtected () const
	geometryProtected
bool	isSelected ()
	isSelected
QString	name () const
	name
Shape *	parentShape () const
	parentShape
QPointF	position () const
	position the position of the shape in points.
bool	remove ()
	remove delete the shape.
void	select ()
	select selects the shape.
bool	selectable () const
	selectable
void	setGeometryProtected (bool protect)
	setGeometryProtected
void	setName (const QString &name)
	setName
void	setPosition (QPointF point)
	setPosition set the position of the shape.
void	setSelectable (bool selectable)
	setSelectable
void	setTransformation (QTransform matrix)
	setTransformation set the 2D transformation matrix of the shape.
void	setVisible (bool visible)
	setVisible
void	setZIndex (int zindex)
	setZIndex
QString	toSvg (bool prependStyles=false, bool stripTextMode=true)
	toSvg convert the shape to svg, will not include style definitions.
QTransform	transformation () const
	transformation the 2D transformation matrix of the shape.
virtual QString	type () const
	type
void	update ()
	update queue the shape update.
void	updateAbsolute (QRectF box)
	updateAbsolute queue the shape update in the specified rectangle.
bool	visible () const
	visible
int	zIndex () const
	zIndex

Public Member Functions
bool	operator!= (const Shape &other) const
bool	operator== (const Shape &other) const
	Shape (KoShape *shape, QObject *parent=0)
	~Shape ()

Private Member Functions
KoShape *	shape ()

Private Attributes
Private *const	d

Friends
class	GroupShape
class	VectorLayer

Detailed Description

The Shape class The shape class is a wrapper around Krita's vector objects.

Some example code to parse through interesting information in a given vector layer with shapes.

import sys
from krita import *
 
doc = Application.activeDocument()
 
root = doc.rootNode()
 
for layer in root.childNodes():
    print (str(layer.type())+" "+str(layer.name()))
    if (str(layer.type())=="vectorlayer"):
        for shape in layer.shapes():
            print(shape.name())
            print(shape.toSvg())

Definition at line 37 of file Shape.h.

Constructor & Destructor Documentation

Shape()

Shape::Shape ( KoShape * shape, QObject * parent = 0 )

explicit

Definition at line 31 of file Shape.cpp.

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

References d, Shape::Private::shape, and shape().

~Shape()

Shape::~Shape

(

)

Definition at line 38 of file Shape.cpp.

{
    delete d;
}

References d.

Member Function Documentation

absoluteTransformation

QTransform Shape::absoluteTransformation ( ) const

slot

transformation the 2D transformation matrix of the shape including all grandparent transforms.

Returns

the 2D transformation matrix.

Definition at line 133 of file Shape.cpp.

{
    return d->shape->absoluteTransformation();
}

References KoShape::absoluteTransformation(), d, and Shape::Private::shape.

boundingBox

QRectF Shape::boundingBox ( ) const

slot

boundingBox the bounding box of the shape in points

Returns

RectF containing the bounding box.

Definition at line 108 of file Shape.cpp.

{
    return d->shape->boundingRect();
}

References KoShape::boundingRect(), d, and Shape::Private::shape.

deselect

void Shape::deselect ( )

slot

deselect deselects the shape.

Definition at line 203 of file Shape.cpp.

{
    if (!d->shape) return;
 
    KisView *activeView = KisPart::instance()->currentMainwindow()->activeView();
    KoSelection *selection = activeView->canvasBase()->shapeManager()->selection();
 
    selection->deselect(d->shape);
}

References KisMainWindow::activeView, KisView::canvasBase(), KisPart::currentMainwindow(), d, KoSelection::deselect(), KisPart::instance(), KoShapeManager::selection, Shape::Private::shape, and KisCanvas2::shapeManager.

geometryProtected

bool Shape::geometryProtected ( ) const

slot

geometryProtected

Returns

whether the shape is protected from user changing the shape geometry.

Definition at line 88 of file Shape.cpp.

{
    return d->shape->isGeometryProtected();
}

References d, KoShape::isGeometryProtected(), and Shape::Private::shape.

isSelected

bool Shape::isSelected ( )

slot

isSelected

Returns

whether the shape is selected.

Definition at line 213 of file Shape.cpp.

{
    if (!d->shape) return false;
 
    KisView *activeView = KisPart::instance()->currentMainwindow()->activeView();
    KoSelection *selection = activeView->canvasBase()->shapeManager()->selection();
 
    return selection->isSelected(d->shape);
}

References KisMainWindow::activeView, KisView::canvasBase(), KisPart::currentMainwindow(), d, KisPart::instance(), KoSelection::isSelected(), KoShapeManager::selection, Shape::Private::shape, and KisCanvas2::shapeManager.

name

QString Shape::name ( ) const

slot

name

Returns

the name of the shape

Definition at line 53 of file Shape.cpp.

{
    return d->shape->name();
}

References d, KoShape::name(), and Shape::Private::shape.

operator!=()

bool Shape::operator!=

(

const Shape &

other

)

const

Definition at line 48 of file Shape.cpp.

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

References operator==().

operator==()

bool Shape::operator==

(

const Shape &

other

)

const

Definition at line 43 of file Shape.cpp.

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

References d, and Shape::Private::shape.

parentShape

Shape * Shape::parentShape ( ) const

slot

parentShape

Returns

the parent GroupShape of the current shape.

Definition at line 223 of file Shape.cpp.

{
    if (!d->shape) return 0;
    if (!d->shape->parent()) return 0;
 
    if (dynamic_cast<KoShapeGroup*>(d->shape->parent())) {
        return new GroupShape(dynamic_cast<KoShapeGroup*>(d->shape->parent()));
    } else {
        return 0;
    }
}

References d, GroupShape, KoShape::parent(), and Shape::Private::shape.

position

QPointF Shape::position ( ) const

slot

position the position of the shape in points.

Returns

the position of the shape in points.

Definition at line 113 of file Shape.cpp.

{
    return d->shape->position();
}

References d, KoShape::position(), and Shape::Private::shape.

remove

bool Shape::remove ( )

slot

remove delete the shape.

Definition at line 148 of file Shape.cpp.

{
    if (!d->shape) return false;
    if (!d->shape->parent()) return false;
 
    bool removeStatus = false;
    Document *document = Krita::instance()->activeDocument();
 
    if (KisPart::instance()->viewCount(document->document()) > 0) {
        for (QPointer<KisView> view : KisPart::instance()->views()) {
            if (view && view->document() == document->document()) {
                KisProcessingApplicator::runSingleCommandStroke(view->image(), view->canvasBase()->shapeController()->removeShape(d->shape));
                view->image()->waitForDone();
                removeStatus = true;
                break;
            }
        }
    }
 
    delete document;
 
    return removeStatus;
}

References Krita::activeDocument(), d, Krita::instance(), KisPart::instance(), KoShape::parent(), KisProcessingApplicator::runSingleCommandStroke(), Shape::Private::shape, and KisPart::views.

select

void Shape::select ( )

slot

select selects the shape.

Definition at line 193 of file Shape.cpp.

{
    if (!d->shape) return;
 
    KisView *activeView = KisPart::instance()->currentMainwindow()->activeView();
    KoSelection *selection = activeView->canvasBase()->shapeManager()->selection();
 
    selection->select(d->shape);
}

References KisMainWindow::activeView, KisView::canvasBase(), KisPart::currentMainwindow(), d, KisPart::instance(), KoSelection::select(), KoShapeManager::selection, Shape::Private::shape, and KisCanvas2::shapeManager.

selectable

bool Shape::selectable ( ) const

slot

selectable

Returns

whether the shape is user selectable.

Definition at line 78 of file Shape.cpp.

{
    return d->shape->isSelectable();
}

References d, KoShape::isSelectable(), and Shape::Private::shape.

setGeometryProtected

void Shape::setGeometryProtected ( bool protect )

slot

setGeometryProtected

Parameters

protect

whether the shape should be geometry protected from the user.

Definition at line 93 of file Shape.cpp.

{
    d->shape->setGeometryProtected(protect);
}

References d, KoShape::setGeometryProtected(), and Shape::Private::shape.

setName

void Shape::setName ( const QString & name )

slot

setName

Parameters

name	which name the shape should have.

Definition at line 58 of file Shape.cpp.

{
    d->shape->setName(name);
}

References d, name(), KoShape::setName(), and Shape::Private::shape.

setPosition

void Shape::setPosition ( QPointF point )

slot

setPosition set the position of the shape.

Parameters

point

the new position in points

Definition at line 118 of file Shape.cpp.

{
    d->shape->setPosition(point);
}

References d, KoShape::setPosition(), and Shape::Private::shape.

setSelectable

void Shape::setSelectable ( bool selectable )

slot

setSelectable

Parameters

selectable

whether the shape should be user selectable.

Definition at line 83 of file Shape.cpp.

{
    d->shape->setSelectable(selectable);
}

References d, selectable(), KoShape::setSelectable(), and Shape::Private::shape.

setTransformation

void Shape::setTransformation ( QTransform matrix )

slot

setTransformation set the 2D transformation matrix of the shape.

Parameters

matrix

the new 2D transformation matrix.

Definition at line 128 of file Shape.cpp.

{
    d->shape->setTransformation(matrix);
}

References d, KoShape::setTransformation(), and Shape::Private::shape.

setVisible

void Shape::setVisible ( bool visible )

slot

setVisible

Parameters

visible

whether the shape should be visible.

Definition at line 103 of file Shape.cpp.

{
    d->shape->setVisible(visible);
}

References d, KoShape::setVisible(), Shape::Private::shape, and visible().

setZIndex

void Shape::setZIndex ( int zindex )

slot

setZIndex

Parameters

zindex

set the shape zindex value.

Definition at line 73 of file Shape.cpp.

{
    d->shape->setZIndex(zindex);
}

References d, KoShape::setZIndex(), and Shape::Private::shape.

shape()

KoShape * Shape::shape ( )

private

Definition at line 236 of file Shape.cpp.

{
    return d->shape;
}

References d, and Shape::Private::shape.

toSvg

QString Shape::toSvg ( bool prependStyles = false, bool stripTextMode = true )

slot

toSvg convert the shape to svg, will not include style definitions.

Parameters

prependStyles	prepend the style data. Default: false
stripTextMode	enable strip text mode. Default: true

Returns

the svg in a string.

Definition at line 172 of file Shape.cpp.

{
    QBuffer shapesBuffer;
    QBuffer stylesBuffer;
 
    shapesBuffer.open(QIODevice::WriteOnly);
    stylesBuffer.open(QIODevice::WriteOnly);
 
    {
        SvgSavingContext savingContext(shapesBuffer, stylesBuffer);
        savingContext.setStrippedTextMode(stripTextMode);
        SvgWriter writer({d->shape});
        writer.saveDetached(savingContext);
    }
 
    shapesBuffer.close();
    stylesBuffer.close();
 
    return (prependStyles ? QString::fromUtf8(stylesBuffer.data()):"") + QString::fromUtf8(shapesBuffer.data());
}

References d, SvgWriter::saveDetached(), SvgSavingContext::setStrippedTextMode(), and Shape::Private::shape.

transformation

QTransform Shape::transformation ( ) const

slot

transformation the 2D transformation matrix of the shape.

Returns

the 2D transformation matrix.

Definition at line 123 of file Shape.cpp.

{
    return d->shape->transformation();
}

References d, Shape::Private::shape, and KoShape::transformation().

type

QString Shape::type ( ) const

virtualslot

type

Returns

the type of shape.

Definition at line 63 of file Shape.cpp.

{
    return d->shape->shapeId();
}

References d, Shape::Private::shape, and KoShape::shapeId().

update

void Shape::update ( )

slot

update queue the shape update.

Definition at line 138 of file Shape.cpp.

{
    return d->shape->update();
}

References d, Shape::Private::shape, and KoShape::update().

updateAbsolute

void Shape::updateAbsolute ( QRectF box )

slot

updateAbsolute queue the shape update in the specified rectangle.

Parameters

box	the RectF rectangle to update.

Definition at line 143 of file Shape.cpp.

{
    return d->shape->updateAbsolute(box);
}

References d, Shape::Private::shape, and KoShape::updateAbsolute().

visible

bool Shape::visible ( ) const

slot

visible

Returns

whether the shape is visible.

Definition at line 98 of file Shape.cpp.

{
    return d->shape->isVisible();
}

References d, KoShape::isVisible(), and Shape::Private::shape.

zIndex

int Shape::zIndex ( ) const

slot

zIndex

Returns

the zindex of the shape.

Definition at line 68 of file Shape.cpp.

{
    return d->shape->zIndex();
}

References d, Shape::Private::shape, and KoShape::zIndex().

Friends And Related Symbol Documentation

GroupShape

friend class GroupShape

friend

Definition at line 202 of file Shape.h.

VectorLayer

friend class VectorLayer

friend

Definition at line 203 of file Shape.h.

Member Data Documentation

d

Private* const Shape::d

private

Definition at line 206 of file Shape.h.

---

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

• libs/libkis/Shape.h
• libs/libkis/Shape.cpp