#include <KoShape.h>

Inheritance diagram for KoShape:

Classes
class	Private

struct	ShapeChangeListener

class	SharedData

Public Types
enum	ChangeType { PositionChanged , RotationChanged , ScaleChanged , ShearChanged , SizeChanged , GenericMatrixChange , KeepAspectRatioChange , ParentChanged , Deleted , StrokeChanged , BackgroundChanged , ShadowChanged , BorderChanged , ParameterChanged , ContentChanged , TextRunAroundChanged , ChildChanged , ConnectionPointChanged , ClipPathChanged , ClipMaskChanged , TransparencyChanged }
	Used by shapeChanged() to select which change was made. More...

enum	ChildZOrderPolicy { ChildZDefault , ChildZParentChild = ChildZDefault , ChildZPassThrough }
	Used by compareShapeZIndex() to order shapes. More...

enum	PaintOrder { Fill , Stroke , Markers }

enum	RunThroughLevel { Background , Foreground }

enum	TextRunAroundContour { ContourBox , ContourFull , ContourOutside }
	The behavior text should do when intersecting this shape. More...

enum	TextRunAroundSide { BiggestRunAroundSide , LeftRunAroundSide , RightRunAroundSide , EnoughRunAroundSide , BothRunAroundSide , NoRunAround , RunThrough }
	The behavior text should do when intersecting this shape. More...

Public Member Functions
QRectF	absoluteOutlineRect () const

QPointF	absolutePosition (KoFlake::AnchorPosition anchor=KoFlake::Center) const

QTransform	absoluteTransformation () const

bool	addDependee (KoShape *shape)

QString	additionalAttribute (const QString &name) const

void	addShapeChangeListener (ShapeChangeListener *listener)

KoShapeAnchor *	anchor () const

void	applyAbsoluteTransformation (const QTransform &matrix)

void	applyTransformation (const QTransform &matrix)

virtual QSharedPointer< KoShapeBackground >	background () const

virtual QRectF	boundingRect () const
	Get the bounding box of the shape.

virtual ChildZOrderPolicy	childZOrderPolicy ()

KoClipMask *	clipMask () const
	Returns the currently set clip mask or 0 if there is no clip mask set.

KoClipPath *	clipPath () const
	Returns the currently set clip path or 0 if there is no clip path set.

virtual KoShape *	cloneShape () const
	creates a deep copy of the shape or shape's subtree

KoShape *	cloneShapeAndBakeAbsoluteTransform () const
	creates a deep copy of the shape/shapes tree and bakes the absolute transform of `this` into the resulting shape.

void	copySettings (const KoShape *shape)

QList< KoShape * >	dependees () const
	Returns list of shapes depending on this shape.

QPointF	documentToShape (const QPointF &point) const
	Transforms point from document coordinates to shape coordinates.

QRectF	documentToShape (const QRectF &rect) const
	Transform rect from document coordinates to shape coordinates.

KoFilterEffectStack *	filterEffectStack () const

bool	hasAdditionalAttribute (const QString &name) const

bool	hasCommonParent (const KoShape *shape) const

bool	hasDependee (KoShape *shape) const
	Returns if the given shape is dependent on this shape.

virtual bool	hasTransparency () const

virtual bool	hitTest (const QPointF &position) const
	Check if the shape is hit on position.

QString	hyperLink () const

bool	inheritBackground () const
	inheritBackground shows if the shape inherits background from its parent

bool	inheritPaintOrder () const
	inheritPaintOrder

bool	inheritsTransformFromAny (const QList< KoShape * > ancestorsInQuestion) const
	inheritsTransformFromAny checks if the shape inherits transformation from any of the shapes listed in `ancestorsInQuestion`. The inheritance is checked in recursive way.

bool	inheritStroke () const
	inheritStroke shows if the shape inherits the stroke from its parent

bool	isContentProtected () const

bool	isGeometryProtected () const

bool	isPrintable () const

bool	isSelectable () const

virtual bool	isShapeEditable (bool recursive=true) const
	checks recursively if the shape or one of its parents is not visible or locked

bool	isVisible (bool recursive=true) const

bool	keepAspectRatio () const

	KoShape ()
	Constructor.

qreal	minimumHeight () const

QString	name () const

void	notifyChanged ()

virtual QPainterPath	outline () const

virtual QRectF	outlineRect () const

virtual void	paint (QPainter &painter) const =0
	Paint the shape fill The class extending this one is responsible for painting itself. `painter` is expected to be preconfigured to work in "document" pixels.

virtual void	paintMarkers (QPainter &painter) const
	paintStroke paints the shape's markers

virtual QVector< PaintOrder >	paintOrder () const
	paintOrder

virtual void	paintStroke (QPainter &painter) const
	paintStroke paints the shape's stroked outline

KoShapeContainer *	parent () const

QPointF	position () const
	Get the position of the shape in pt.

void	removeAdditionalAttribute (const QString &name)

void	removeAdditionalStyleAttribute (const char *name)

void	removeDependee (KoShape *shape)

void	removeShapeChangeListener (ShapeChangeListener *listener)

void	rotate (qreal angle)
	Rotate the shape (relative)

qreal	rotation () const

int	runThrough () const

void	scale (qreal sx, qreal sy)
	Scale the shape using the zero-point which is the top-left corner.

void	setAbsolutePosition (const QPointF &newPosition, KoFlake::AnchorPosition anchor=KoFlake::Center)

void	setAdditionalAttribute (const QString &name, const QString &value)

void	setAdditionalStyleAttribute (const char *name, const QString &value)

void	setAnchor (KoShapeAnchor *anchor)

virtual void	setBackground (QSharedPointer< KoShapeBackground > background)

void	setClipMask (KoClipMask *clipMask)
	Sets a new clip mask, removing the old one. The mask is owned by the shape.

void	setClipPath (KoClipPath *clipPath)
	Sets a new clip path, removing the old one.

void	setContentProtected (bool protect)

void	setFilterEffectStack (KoFilterEffectStack *filterEffectStack)
	Sets the new filter effect stack, removing the old one.

void	setGeometryProtected (bool on)

void	setHyperLink (const QString &hyperLink)

void	setInheritBackground (bool value)
	setInheritBackground marks a shape as inheriting the background from the parent shape. NOTE: The currently selected background is destroyed.

void	setInheritPaintOrder (bool value)
	setInheritPaintOrder set inherit paint order.

void	setInheritStroke (bool value)
	setInheritStroke marks a shape as inheriting the stroke from the parent shape. NOTE: The currently selected stroke is destroyed.

void	setKeepAspectRatio (bool keepAspect)

void	setMinimumHeight (qreal height)

void	setName (const QString &name)

virtual void	setPaintOrder (PaintOrder first, PaintOrder second)
	setPaintOrder set the paint order. As there's only three entries in any given paintorder, you only need to have the first and second entry to set it.

void	setParent (KoShapeContainer *parent)

virtual void	setPosition (const QPointF &position)
	Set the position of the shape in pt.

void	setPrintable (bool on)

virtual void	setResolution (qreal xRes, qreal yRes)

virtual void	setRunThrough (short int runThrough)

void	setSelectable (bool selectable)

void	setShadow (KoShapeShadow *shadow)
	Sets the new shadow, removing the old one.

void	setShapeId (const QString &id)

virtual void	setSize (const QSizeF &size)
	Resize the shape.

virtual void	setStroke (KoShapeStrokeModelSP stroke)

void	setTextRunAroundContour (TextRunAroundContour contour)

void	setTextRunAroundDistanceBottom (qreal distance)

void	setTextRunAroundDistanceLeft (qreal distance)

void	setTextRunAroundDistanceRight (qreal distance)

void	setTextRunAroundDistanceTop (qreal distance)

void	setTextRunAroundSide (TextRunAroundSide side, RunThroughLevel runThrough=Background)

void	setTextRunAroundThreshold (qreal threshold)

void	setToolDelegates (const QSet< KoShape * > &delegates)

void	setTransformation (const QTransform &matrix)

void	setTransparency (qreal transparency)

void	setUserData (KoShapeUserData *userData)

void	setVisible (bool on)

void	setZIndex (qint16 zIndex)

KoShapeShadow *	shadow () const
	Returns the currently set shadow or 0 if there is no shadow set.

virtual QPainterPath	shadowOutline () const

QString	shapeId () const

QPointF	shapeToDocument (const QPointF &point) const
	Transforms point from shape coordinates to document coordinates.

QRectF	shapeToDocument (const QRectF &rect) const
	Transforms rect from shape coordinates to document coordinates.

void	shear (qreal sx, qreal sy)
	Shear the shape The shape will be sheared using the zero-point which is the top-left corner.

virtual QSizeF	size () const
	Get the size of the shape in pt.

virtual KoSnapData	snapData () const
	Returns additional snap data the shape wants to have snapping to.

virtual KoShapeStrokeModelSP	stroke () const

KoInsets	strokeInsets () const

TextRunAroundContour	textRunAroundContour () const

qreal	textRunAroundDistanceBottom () const

qreal	textRunAroundDistanceLeft () const

qreal	textRunAroundDistanceRight () const

qreal	textRunAroundDistanceTop () const

TextRunAroundSide	textRunAroundSide () const

qreal	textRunAroundThreshold () const

QSet< KoShape * >	toolDelegates () const

QTransform	transformation () const
	Returns the shapes local transformation matrix.

qreal	transparency (bool recursive=false) const

virtual void	update () const

virtual void	updateAbsolute (const QRectF &rect) const

KoShapeUserData *	userData () const

virtual void	waitUntilReady (bool asynchronous=true) const

qint16	zIndex () const

virtual	~KoShape ()
	Destructor.

Static Public Member Functions
static QRectF	absoluteOutlineRect (const QList< KoShape * > &shapes)

static QRectF	boundingRect (const QList< KoShape * > &shapes)

static bool	compareShapeZIndex (KoShape s1, KoShape s2)

static KisHandlePainterHelper	createHandlePainterHelperDocument (QPainter painter, KoShape shape, qreal handleRadius, int decorationThickness)

static KisHandlePainterHelper	createHandlePainterHelperView (QPainter painter, KoShape shape, const KoViewConverter &converter, qreal handleRadius=0.0, int decorationThickness=1)

static QVector< PaintOrder >	defaultPaintOrder ()
	default paint order as per SVG specification

static QList< KoShape * >	linearizeSubtree (const QList< KoShape * > &shapes)

static QList< KoShape * >	linearizeSubtreeSorted (const QList< KoShape * > &shapes)

Static Public Attributes
static const qint16	maxZIndex = std::numeric_limits<qint16>::max()

static const qint16	minZIndex = std::numeric_limits<qint16>::min()

Protected Member Functions
	KoShape (const KoShape &rhs)

QList< ShapeChangeListener * >	listeners () const

void	setSizeImpl (const QSizeF &size) const

virtual void	shapeChanged (ChangeType type, KoShape *shape=0)

void	shapeChangedPriv (KoShape::ChangeType type)

QTransform	transform () const
	return the current matrix that contains the rotation/scale/position of this shape

Private Member Functions
void	addShapeManager (KoShapeManager *manager)

void	removeShapeManager (KoShapeManager *manager)

Private Attributes
QScopedPointer< Private >	d

QSharedDataPointer< SharedData >	s

Friends
class	KoShapeManager

Detailed Description

Base class for all flake shapes. Shapes extend this class to allow themselves to be manipulated. This class just represents a graphical shape in the document and can be manipulated by some default tools in this library.

Due to the limited responsibility of this class, the extending object can have any data backend and is responsible for painting itself.

We strongly suggest that any extending class will use a Model View Controller (MVC) design where the View part is all in this class, as well as the one that inherits from this one. This allows the data that rests in the model to be reused in different parts of the document. For example by having two flake objects that show that same data. Or each showing a section of it.

The KoShape data is completely in postscript-points (pt) (see KoUnit for conversion methods to and from points). This image will explain the real-world use of the shape and its options.
The Rotation center can be returned with absolutePosition()

Flake objects can be created in three ways:

a simple new KoDerivedFlake(),
through an associated tool,
through a factory

Shape interaction notifications

We had several notification methods that allow your shape to be notified of changes in other shapes positions or rotation etc.

The most general is KoShape::shapeChanged().
a virtual method that you can use to check various changed to your shape made by tools or otherwise.
for shape hierarchies the parent may receive a notification when a child was modified. This is done though KoShapeContainerModel::childChanged()
any shape that is at a similar position as another shape there is collision detection. You can register your shape to be sensitive to any changes like moving or whatever to other shapes that intersect yours. Such changes will then be notified to your shape using the method from (1) You should call KoShape::setCollisionDetection(bool) to enable this.

Definition at line 91 of file KoShape.h.

Member Enumeration Documentation

◆ ChangeType

enum KoShape::ChangeType

Used by shapeChanged() to select which change was made.

Enumerator
PositionChanged	used after a setPosition()
RotationChanged	used after a setRotation()
ScaleChanged	used after a scale()
ShearChanged	used after a shear()
SizeChanged	used after a setSize()
GenericMatrixChange	used after the matrix was changed without knowing which property explicitly changed
KeepAspectRatioChange	used after setKeepAspectRatio()
ParentChanged	used after a setParent()
Deleted	the shape was deleted
StrokeChanged	the shapes stroke has changed
BackgroundChanged	the shapes background has changed
ShadowChanged	the shapes shadow has changed
BorderChanged	the shapes border has changed
ParameterChanged	the shapes parameter has changed (KoParameterShape only)
ContentChanged	the content of the shape changed e.g. a new image inside a pixmap/text change inside a textshape
TextRunAroundChanged	used after a setTextRunAroundSide()
ChildChanged	a child of a container was changed/removed. This is propagated to all parents
ConnectionPointChanged	a connection point has changed
ClipPathChanged	the shapes clip path has changed
ClipMaskChanged	the shapes clip path has changed
TransparencyChanged	the shapetransparency value has changed

Definition at line 95 of file KoShape.h.

                    {
        PositionChanged, 
        RotationChanged, 
        ScaleChanged,   
        ShearChanged,   
        SizeChanged,    
        GenericMatrixChange,    
        KeepAspectRatioChange, 
        ParentChanged,   
        Deleted, 
        StrokeChanged, 
        BackgroundChanged, 
        ShadowChanged, 
        BorderChanged, 
        ParameterChanged, 
        ContentChanged, 
        TextRunAroundChanged, 
        ChildChanged, 
        ConnectionPointChanged, 
        ClipPathChanged, 
        ClipMaskChanged, 
        TransparencyChanged 
    };

◆ ChildZOrderPolicy

enum KoShape::ChildZOrderPolicy

Used by compareShapeZIndex() to order shapes.

Enumerator
ChildZDefault
ChildZParentChild	normal parent/child ordering
ChildZPassThrough	children are considered equal to this shape

Definition at line 656 of file KoShape.h.

                           {
        ChildZDefault,
        ChildZParentChild = ChildZDefault, 
        ChildZPassThrough 
    };

◆ PaintOrder

enum KoShape::PaintOrder

Enumerator
Fill
Stroke
Markers

Definition at line 145 of file KoShape.h.

                    {
        Fill,
        Stroke,
        Markers
    };

◆ RunThroughLevel

enum KoShape::RunThroughLevel

TODO

Enumerator
Background
Foreground

Definition at line 140 of file KoShape.h.

                         {
        Background,
        Foreground
    };

◆ TextRunAroundContour

enum KoShape::TextRunAroundContour

The behavior text should do when intersecting this shape.

Enumerator

ContourBox

ContourFull

Run other text around a bounding rect of the outline.

Run other text around also on the inside

ContourOutside

Run other text around only on the outside.

Definition at line 131 of file KoShape.h.

                              {
        ContourBox,     
        ContourFull,   
        ContourOutside   
    };

◆ TextRunAroundSide

enum KoShape::TextRunAroundSide

The behavior text should do when intersecting this shape.

Enumerator
BiggestRunAroundSide	Run other text around the side that has the most space.
LeftRunAroundSide	Run other text around the left side of the frame.
RightRunAroundSide	Run other text around the right side of the frame.
EnoughRunAroundSide	Run other text dynamically around both sides of the shape, provided there is sufficient space left.
BothRunAroundSide	Run other text around both sides of the shape.
NoRunAround	The text will be completely avoiding the frame by keeping the horizontal space that this frame occupies blank.
RunThrough	The text will completely ignore the frame and layout as if it was not there.

Definition at line 120 of file KoShape.h.

                           {
        BiggestRunAroundSide,   
        LeftRunAroundSide,      
        RightRunAroundSide,     
        EnoughRunAroundSide,      
        BothRunAroundSide,      
        NoRunAround,            
        RunThrough              
    };

Constructor & Destructor Documentation

◆ KoShape() [1/2]

KoShape::KoShape ( )

Constructor.

Definition at line 163 of file KoShape.cpp.

    : d(new Private()),
      s(new SharedData)
{
    notifyChanged();
}

References notifyChanged().

◆ ~KoShape()

KoShape::~KoShape ( )

virtual

Destructor.

The shape must have already been detached from all the parents and shape managers. Otherwise we might accidentally request some RTTI information, which is not available anymore (we are in d-tor).

TL;DR: fix the code that caused this destruction without unparenting instead of trying to remove these assert!

Definition at line 176 of file KoShape.cpp.

{
    shapeChangedPriv(Deleted);
    d->listeners.clear();
    KIS_SAFE_ASSERT_RECOVER (!d->parent) {
        d->parent->removeShape(this);
    }
 
    KIS_SAFE_ASSERT_RECOVER (d->shapeManagers.isEmpty()) {
        Q_FOREACH (KoShapeManager *manager, d->shapeManagers) {
            manager->shapeInterface()->notifyShapeDestructed(this);
        }
        d->shapeManagers.clear();
    }
}

References d, Deleted, KIS_SAFE_ASSERT_RECOVER, KoShapeManager::ShapeInterface::notifyShapeDestructed(), shapeChangedPriv(), and KoShapeManager::shapeInterface.

◆ KoShape() [2/2]

KoShape::KoShape ( const KoShape & rhs )

protected

Definition at line 170 of file KoShape.cpp.

    : d(new Private()),
      s(rhs.s)
{
}

Member Function Documentation

◆ absoluteOutlineRect() [1/2]

QRectF KoShape::absoluteOutlineRect ( ) const

Returns: the bounding rect of the outline of the shape measured in absolute coordinate system. Please note that in contrast to boundingRect() this rect doesn't include the stroke and other insets.

Definition at line 368 of file KoShape.cpp.

{
    return absoluteTransformation().map(outline()).boundingRect();
}

References absoluteTransformation(), and outline().

◆ absoluteOutlineRect() [2/2]

QRectF KoShape::absoluteOutlineRect ( const QList< KoShape * > & shapes )

static

Same as a member function, but applies to a list of shapes and returns a united rect.

Definition at line 373 of file KoShape.cpp.

{
    QRectF absoluteOutlineRect;
    Q_FOREACH (KoShape *shape, shapes) {
        absoluteOutlineRect |= shape->absoluteOutlineRect();
    }
    return absoluteOutlineRect;
}

References absoluteOutlineRect().

◆ absolutePosition()

QPointF KoShape::absolutePosition ( KoFlake::AnchorPosition anchor = KoFlake::Center ) const

Return the position of this shape regardless of rotation/skew/scaling and regardless of this shape having a parent (being in a group) or not.

Parameters

anchor The place on the (unaltered) shape that you want the position of.

Returns: the point that is the absolute, centered position of this shape.

Definition at line 653 of file KoShape.cpp.

{
    const QRectF rc = outlineRect();
 
    QPointF point = rc.topLeft();
 
    bool valid = false;
    QPointF anchoredPoint = KoFlake::anchorToPoint(anchor, rc, &valid);
    if (valid) {
        point = anchoredPoint;
    }
 
    return absoluteTransformation().map(point);
}

References absoluteTransformation(), anchor(), KoFlake::anchorToPoint(), and outlineRect().

◆ absoluteTransformation()

QTransform KoShape::absoluteTransformation ( ) const

Create a matrix that describes all the transformations done on this shape.

The absolute transformation is the combined transformation of this shape and all its parents and grandparents.

Definition at line 382 of file KoShape.cpp.

{
    QTransform matrix;
    // apply parents matrix to inherit any transformations done there.
    KoShapeContainer * container = d->parent;
    if (container) {
        if (container->inheritsTransform(this)) {
            matrix = container->absoluteTransformation();
        } else {
            QSizeF containerSize = container->size();
            QPointF containerPos = container->absolutePosition() - QPointF(0.5 * containerSize.width(), 0.5 * containerSize.height());
            matrix.translate(containerPos.x(), containerPos.y());
        }
    }
 
    return s->localMatrix * matrix;
}

References absolutePosition(), absoluteTransformation(), d, KoShapeContainer::inheritsTransform(), parent(), s, and size().

◆ addDependee()

bool KoShape::addDependee ( KoShape * shape )

Adds a shape which depends on this shape. Making a shape dependent on this one means it will get shapeChanged() called on each update of this shape.

If this shape already depends on the given shape, establishing the dependency is refused to prevent circular dependencies.

Parameters

shape the shape which depends on this shape

Returns: true if dependency could be established, otherwise false

See also: removeDependee(), hasDependee()

Definition at line 1221 of file KoShape.cpp.

{
    if (! shape)
        return false;
 
    // refuse to establish a circular dependency
    if (shape->hasDependee(this))
        return false;
 
    if (! d->dependees.contains(shape))
        d->dependees.append(shape);
 
    return true;
}

References d, and hasDependee().

◆ additionalAttribute()

QString KoShape::additionalAttribute ( const QString & name ) const

Get additional attribute

Parameters

name	The name of the attribute in the following form prefix:tag e.g. presentation:placeholder

Returns: The value of the attribute if it exists or a null string if not found.

Definition at line 1279 of file KoShape.cpp.

{
    return s->additionalAttributes.value(name);
}

References name(), and s.

◆ addShapeChangeListener()

void KoShape::addShapeChangeListener ( KoShape::ShapeChangeListener * listener )

Definition at line 1360 of file KoShape.cpp.

{
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(!d->listeners.contains(listener));
    listener->registerShape(this);
    d->listeners.append(listener);
}

References d, KIS_SAFE_ASSERT_RECOVER_RETURN, and KoShape::ShapeChangeListener::registerShape().

◆ addShapeManager()

void KoShape::addShapeManager ( KoShapeManager * manager )

private

Definition at line 148 of file KoShape.cpp.

{
    d->shapeManagers.insert(manager);
}

References d.

◆ anchor()

KoShapeAnchor * KoShape::anchor ( ) const

Return the KoShapeAnchor, or 0

◆ applyAbsoluteTransformation()

void KoShape::applyAbsoluteTransformation ( const QTransform & matrix )

Applies a transformation to this shape.

The transformation given is relative to the global coordinate system, i.e. the document. This is a convenience function to apply a global transformation to this shape.

See also: applyTransformation

Parameters

matrix the transformation matrix to apply

Definition at line 400 of file KoShape.cpp.

{
    QTransform globalMatrix = absoluteTransformation();
    // the transformation is relative to the global coordinate system
    // but we want to change the local matrix, so convert the matrix
    // to be relative to the local coordinate system
    QTransform transformMatrix = globalMatrix * matrix * globalMatrix.inverted();
    applyTransformation(transformMatrix);
}

References absoluteTransformation(), and applyTransformation().

◆ applyTransformation()

void KoShape::applyTransformation ( const QTransform & matrix )

Applies a transformation to this shape.

The transformation given is relative to the shape coordinate system.

Parameters

matrix the transformation matrix to apply

Definition at line 410 of file KoShape.cpp.

{
    s->localMatrix = matrix * s->localMatrix;
    notifyChanged();
    shapeChangedPriv(GenericMatrixChange);
}

References GenericMatrixChange, notifyChanged(), s, and shapeChangedPriv().

◆ background()

QSharedPointer< KoShapeBackground > KoShape::background ( ) const

virtual

Return the brush used to paint the background of this shape with. A QBrush can have a plain color, be fully transparent or have a complex fill. setting such a brush will allow the shape to fill itself using that brush and will be able to tell if its transparent or not.

Returns: the background-brush

Reimplemented in KoSvgTextShape.

Definition at line 926 of file KoShape.cpp.

{
 
    QSharedPointer<KoShapeBackground> bg;
 
    if (!s->inheritBackground) {
        bg = s->fill;
    } else if (parent()) {
        bg = parent()->background();
    }
 
    return bg;
}

References background(), parent(), and s.

◆ boundingRect() [1/2]

QRectF KoShape::boundingRect ( ) const

virtual

Get the bounding box of the shape.

This includes the line width and the shadow of the shape

Returns: the bounding box of the shape

Reimplemented in KoPathShape, KoSelection, KoShapeGroup, KoShapeLayer, KoSvgTextShape, and KisNodeShape.

Definition at line 335 of file KoShape.cpp.

{
 
    QTransform transform = absoluteTransformation();
    QRectF bb = outlineRect();
    if (s->stroke) {
        KoInsets insets;
        s->stroke->strokeInsets(this, insets);
        bb.adjust(-insets.left, -insets.top, insets.right, insets.bottom);
    }
    bb = transform.mapRect(bb);
    if (s->shadow) {
        KoInsets insets;
        s->shadow->insets(insets);
        bb.adjust(-insets.left, -insets.top, insets.right, insets.bottom);
    }
    if (s->filterEffectStack) {
        QRectF clipRect = s->filterEffectStack->clipRectForBoundingRect(outlineRect());
        bb |= transform.mapRect(clipRect);
    }
 
    return bb;
}

References absoluteTransformation(), KoInsets::bottom, KoInsets::left, outlineRect(), KoInsets::right, s, KoInsets::top, and transform().

◆ boundingRect() [2/2]

QRectF KoShape::boundingRect ( const QList< KoShape * > & shapes )

static

Get the united bounding box of a group of shapes. This is a utility function used in many places in Krita.

Definition at line 359 of file KoShape.cpp.

{
    QRectF boundingRect;
    Q_FOREACH (KoShape *shape, shapes) {
        boundingRect |= shape->boundingRect();
    }
    return boundingRect;
}

References boundingRect().

◆ childZOrderPolicy()

KoShape::ChildZOrderPolicy KoShape::childZOrderPolicy ( )

virtual

Returns if during compareShapeZIndex() how this shape portrays the values of its children. The default behaviour is to let this shape's z values take the place of its children's values, so you get a parent/child relationship. The children are naturally still ordered relatively to their z values

But for special cases (like Calligra's TextShape) it can be overloaded to return ChildZPassThrough which means the children keep their own z values

Returns: the z order policy of this shape

Definition at line 429 of file KoShape.cpp.

{
    return ChildZDefault;
}

References ChildZDefault.

◆ clipMask()

KoClipMask * KoShape::clipMask ( ) const

Returns the currently set clip mask or 0 if there is no clip mask set.

Definition at line 1140 of file KoShape.cpp.

{
    return s->clipMask.data();
}

References s.

◆ clipPath()

KoClipPath * KoShape::clipPath ( ) const

Returns the currently set clip path or 0 if there is no clip path set.

Definition at line 1128 of file KoShape.cpp.

{
    return s->clipPath.data();
}

References KoClipPath::clipPath, and s.

◆ cloneShape()

KoShape * KoShape::cloneShape ( ) const

virtual

creates a deep copy of the shape or shape's subtree

Returns: a cloned shape

Reimplemented in KoPathShape, KoShapeGroup, KoSvgTextShape, KisReferenceImage, ImageShape, EllipseShape, EnhancedPathShape, RectangleShape, SpiralShape, StarShape, and KarbonCalligraphicShape.

Definition at line 200 of file KoShape.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(0 && "not implemented!");
    qWarning() << shapeId() << "cannot be cloned";
    return 0;
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, and shapeId().

◆ cloneShapeAndBakeAbsoluteTransform()

KoShape * KoShape::cloneShapeAndBakeAbsoluteTransform ( ) const

creates a deep copy of the shape/shapes tree and bakes the absolute transform of this into the resulting shape.

After cloning clonedShape->transformation() is equal to this->absoluteTransformation(), even though the new shape has no parents.

This is just a convenience wrapper for cloneShape()

Returns: cloned shape

The shape is cloned without its parent's transformation, so we should adjust it manually.

Definition at line 207 of file KoShape.cpp.

{
    KoShape *clonedShape = this->cloneShape();
 
    KoShape *oldParentShape = this->parent();
    if (oldParentShape && !oldParentShape->absoluteTransformation().isIdentity()) {
        clonedShape->applyAbsoluteTransformation(oldParentShape->absoluteTransformation());
    }
 
    return clonedShape;
}

References absoluteTransformation(), applyAbsoluteTransformation(), cloneShape(), and parent().

◆ compareShapeZIndex()

bool KoShape::compareShapeZIndex	(	KoShape *	s1,
		KoShape *	s2 )

static

This is a method used to sort a list using the STL sorting methods.

Parameters

s1	the first shape
s2	the second shape

WARNING: Our definition of zIndex is not yet compatible with SVG2's definition. In SVG stacking context of groups with the same zIndex are merged, while in Krita the contents of groups is never merged. One group will always below than the other. Therefore, when zIndex of two groups inside the same parent coincide, the resulting painting order in Krita is UNDEFINED.

To avoid this trouble we use KoShapeReorderCommand::mergeInShape() inside KoShapeCreateCommand.

The algorithm below doesn't correctly handle the case when the two pointers actually point to the same shape. So just check it in advance to guarantee strict weak ordering relation requirement

Definition at line 434 of file KoShape.cpp.

{
    if (s1 == s2) return false;
 
 
    // First sort according to runThrough which is sort of a master level
    KoShape *parentShapeS1 = s1->parent();
    KoShape *parentShapeS2 = s2->parent();
    int runThrough1 = s1->runThrough();
    int runThrough2 = s2->runThrough();
    while (parentShapeS1) {
        if (parentShapeS1->childZOrderPolicy() == KoShape::ChildZParentChild) {
            runThrough1 = parentShapeS1->runThrough();
        } else {
            runThrough1 = runThrough1 + parentShapeS1->runThrough();
        }
        parentShapeS1 = parentShapeS1->parent();
    }
 
    while (parentShapeS2) {
        if (parentShapeS2->childZOrderPolicy() == KoShape::ChildZParentChild) {
            runThrough2 = parentShapeS2->runThrough();
        } else {
            runThrough2 = runThrough2 + parentShapeS2->runThrough();
        }
        parentShapeS2 = parentShapeS2->parent();
    }
 
    if (runThrough1 > runThrough2) {
        return false;
    }
    if (runThrough1 < runThrough2) {
        return true;
    }
 
    // If on the same runThrough level then the zIndex is all that matters.
    //
    // We basically walk up through the parents until we find a common base parent
    // To do that we need two loops where the inner loop walks up through the parents
    // of s2 every time we step up one parent level on s1
    //
    // We don't update the index value until after we have seen that it's not a common base
    // That way we ensure that two children of a common base are sorted according to their respective
    // z value
    bool foundCommonParent = false;
    int index1 = s1->zIndex();
    int index2 = s2->zIndex();
    parentShapeS1 = s1;
    parentShapeS2 = s2;
    while (parentShapeS1 && !foundCommonParent) {
        parentShapeS2 = s2;
        index2 = parentShapeS2->zIndex();
        while (parentShapeS2) {
            if (parentShapeS2 == parentShapeS1) {
                foundCommonParent = true;
                break;
            }
            if (parentShapeS2->childZOrderPolicy() == KoShape::ChildZParentChild) {
                index2 = parentShapeS2->zIndex();
            }
            parentShapeS2 = parentShapeS2->parent();
        }
 
        if (!foundCommonParent) {
            if (parentShapeS1->childZOrderPolicy() == KoShape::ChildZParentChild) {
                index1 = parentShapeS1->zIndex();
            }
            parentShapeS1 = parentShapeS1->parent();
        }
    }
 
    // If the one shape is a parent/child of the other then sort so.
    if (s1 == parentShapeS2) {
        return true;
    }
    if (s2 == parentShapeS1) {
        return false;
    }
 
    // If we went that far then the z-Index is used for sorting.
    return index1 < index2;
}

References childZOrderPolicy(), ChildZParentChild, parent(), runThrough(), s1, s2, and zIndex().

◆ copySettings()

void KoShape::copySettings ( const KoShape * shape )

Copy all the settings from the parameter shape and apply them to this shape. Settings like the position and rotation to visible and locked. The parent is a notable exclusion.

Parameters

shape the shape to use as original

Definition at line 679 of file KoShape.cpp.

{
    s->size = shape->size();
    s->zIndex = shape->zIndex();
    s->visible = shape->isVisible(false);
 
    // Ensure printable is true by default
    if (!s->visible)
        s->printable = true;
    else
        s->printable = shape->isPrintable();
 
    s->geometryProtected = shape->isGeometryProtected();
    s->protectContent = shape->isContentProtected();
    s->selectable = shape->isSelectable();
    s->keepAspect = shape->keepAspectRatio();
    s->localMatrix = shape->s->localMatrix;
}

References isContentProtected(), isGeometryProtected(), isPrintable(), isSelectable(), isVisible(), keepAspectRatio(), s, size(), and zIndex().

◆ createHandlePainterHelperDocument()

KisHandlePainterHelper KoShape::createHandlePainterHelperDocument	(	QPainter *	painter,
		KoShape *	shape,
		qreal	handleRadius,
		int	decorationThickness )

static

Definition at line 1189 of file KoShape.cpp.

{
    const QTransform originalPainterTransform = painter->transform();
 
    painter->setTransform(shape->absoluteTransformation() *
                          painter->transform());
 
    // move c-tor
    return KisHandlePainterHelper(painter, originalPainterTransform, handleRadius, decorationThickness);
}

References absoluteTransformation().

◆ createHandlePainterHelperView()

KisHandlePainterHelper KoShape::createHandlePainterHelperView	(	QPainter *	painter,
		KoShape *	shape,
		const KoViewConverter &	converter,
		qreal	handleRadius = 0.0,
		int	decorationThickness = 1 )

static

A convenience method that creates a handles helper with applying transformations at the same time. Please note that you shouldn't save/restore additionally. All the work on restoring original painter's transformations is done by the helper.

Definition at line 1177 of file KoShape.cpp.

{
    const QTransform originalPainterTransform = painter->transform();
 
    painter->setTransform(shape->absoluteTransformation() *
                          converter.documentToView() *
                          painter->transform());
 
    // move c-tor
    return KisHandlePainterHelper(painter, originalPainterTransform, handleRadius, decorationThickness);
}

References absoluteTransformation(), and KoViewConverter::documentToView().

◆ defaultPaintOrder()

QVector< KoShape::PaintOrder > KoShape::defaultPaintOrder ( )

static

default paint order as per SVG specification

Returns: constant value of {Fill, Stroke, Markers}

Definition at line 784 of file KoShape.cpp.

{
    static QVector<PaintOrder> order = {Fill, Stroke, Markers};
    return order;
}

References Fill, Markers, and Stroke.

◆ dependees()

QList< KoShape * > KoShape::dependees ( ) const

Returns list of shapes depending on this shape.

Definition at line 1248 of file KoShape.cpp.

{
    return d->dependees;
}

References d.

◆ documentToShape() [1/2]

QPointF KoShape::documentToShape ( const QPointF & point ) const

Transforms point from document coordinates to shape coordinates.

Parameters

point in document coordinates

Returns: point in shape coordinates

Definition at line 1211 of file KoShape.cpp.

{
    return absoluteTransformation().inverted().map(point);
}

References absoluteTransformation().

◆ documentToShape() [2/2]

QRectF KoShape::documentToShape ( const QRectF & rect ) const

Transform rect from document coordinates to shape coordinates.

Parameters

rect	in document coordinates

Returns: rect in shape coordinates

Definition at line 1216 of file KoShape.cpp.

{
    return absoluteTransformation().inverted().mapRect(rect);
}

References absoluteTransformation().

◆ filterEffectStack()

KoFilterEffectStack * KoShape::filterEffectStack ( ) const

Returns the filter effect stack of the shape

Returns: the list of filter effects applied on the shape when rendering.

Definition at line 1294 of file KoShape.cpp.

{
    return s->filterEffectStack;
}

References s.

◆ hasAdditionalAttribute()

bool KoShape::hasAdditionalAttribute ( const QString & name ) const

Check if additional attribute is set

Parameters

name	The name of the attribute in the following form prefix:tag e.g. presentation:placeholder

Returns: true if there is a attribute with prefix:tag set, false otherwise

Definition at line 1274 of file KoShape.cpp.

{
    return s->additionalAttributes.contains(name);
}

References name(), and s.

◆ hasCommonParent()

bool KoShape::hasCommonParent ( const KoShape * shape ) const

Returns: true if this shape has a common parent with shape

Definition at line 581 of file KoShape.cpp.

{
    const KoShape *thisShape = this;
    while (thisShape) {
 
        const KoShape *otherShape = shape;
        while (otherShape) {
            if (thisShape == otherShape) {
                return true;
            }
            otherShape = otherShape->parent();
        }
 
        thisShape = thisShape->parent();
    }
 
    return false;
}

References parent().

◆ hasDependee()

bool KoShape::hasDependee ( KoShape * shape ) const

Returns if the given shape is dependent on this shape.

Definition at line 1243 of file KoShape.cpp.

{
    return d->dependees.contains(shape);
}

References d.

◆ hasTransparency()

bool KoShape::hasTransparency ( ) const

virtual

Returns true if there is some transparency, false if the shape is fully opaque. The default implementation will just return if the background has some transparency, you should override it and always return true if your shape is not square.

Returns: if the shape is (partly) transparent.

Definition at line 715 of file KoShape.cpp.

{
    QSharedPointer<KoShapeBackground> bg = background();
 
    return !bg || bg->hasTransparency() || s->transparency > 0.0;
}

References background(), and s.

◆ hitTest()

bool KoShape::hitTest ( const QPointF & position ) const

virtual

Check if the shape is hit on position.

Parameters

position the position where the user clicked.

Returns: true when it hits.

Reimplemented in KoPathShape, KoSelection, KoShapeGroup, and KoShapeLayer.

Definition at line 308 of file KoShape.cpp.

{
    if (d->parent && d->parent->isClipped(this) && !d->parent->hitTest(position))
        return false;
 
    QPointF point = absoluteTransformation().inverted().map(position);
    QRectF bb = outlineRect();
 
    if (s->stroke) {
        KoInsets insets;
        s->stroke->strokeInsets(this, insets);
        bb.adjust(-insets.left, -insets.top, insets.right, insets.bottom);
    }
    if (bb.contains(point))
        return true;
 
    // if there is no shadow we can as well just leave
    if (! s->shadow)
        return false;
 
    // the shadow has an offset to the shape, so we simply
    // check if the position minus the shadow offset hits the shape
    point = absoluteTransformation().inverted().map(position - s->shadow->offset());
 
    return bb.contains(point);
}

References absoluteTransformation(), KoInsets::bottom, d, KoInsets::left, outlineRect(), position(), KoInsets::right, s, and KoInsets::top.

◆ hyperLink()

QString KoShape::hyperLink ( ) const

Return the hyperlink for this shape.

Definition at line 1320 of file KoShape.cpp.

{
    return s->hyperLink;
}

References s.

◆ inheritBackground()

bool KoShape::inheritBackground ( ) const

inheritBackground shows if the shape inherits background from its parent

Returns: true if the shape inherits the fill

Definition at line 949 of file KoShape.cpp.

{
    return s->inheritBackground;
}

References s.

◆ inheritPaintOrder()

bool KoShape::inheritPaintOrder ( ) const

inheritPaintOrder

Returns: whether the paint order is inherited. By default it is.

Definition at line 795 of file KoShape.cpp.

{
    return s->inheritPaintOrder;
}

References s.

◆ inheritsTransformFromAny()

bool KoShape::inheritsTransformFromAny ( const QList< KoShape * > ancestorsInQuestion ) const

inheritsTransformFromAny checks if the shape inherits transformation from any of the shapes listed in ancestorsInQuestion. The inheritance is checked in recursive way.

Returns: true if there is a (transitive) transformation-wise parent found in ancestorsInQuestion

Definition at line 559 of file KoShape.cpp.

{
    bool result = false;
 
    KoShape *shape = const_cast<KoShape*>(this);
    while (shape) {
        KoShapeContainer *parent = shape->parent();
        if (parent && !parent->inheritsTransform(shape)) {
            break;
        }
 
        if (ancestorsInQuestion.contains(shape)) {
            result = true;
            break;
        }
 
        shape = parent;
    }
 
    return result;
}

References KoShapeContainer::inheritsTransform(), and parent().

◆ inheritStroke()

bool KoShape::inheritStroke ( ) const

inheritStroke shows if the shape inherits the stroke from its parent

Returns: true if the shape inherits the stroke style

Definition at line 1098 of file KoShape.cpp.

{
    return s->inheritStroke;
}

References s.

◆ isContentProtected()

bool KoShape::isContentProtected ( ) const

Returns current content protection state of this shape. Content protection is a hint for tools to disallow the user editing the content.

Returns: current content protection state of this shape.

See also: isGeometryProtected(), isSelectable(), isVisible()

Definition at line 1034 of file KoShape.cpp.

{
    return s->protectContent;
}

References s.

◆ isGeometryProtected()

bool KoShape::isGeometryProtected ( ) const

Returns current geometry protection state of this shape. The geometry being protected means the user can not change shape or position of the shape. This includes any matrix operation such as rotation.

Returns: current geometry protection state of this shape.

See also: isContentProtected(), isSelectable(), isVisible()

Definition at line 1024 of file KoShape.cpp.

{
    return s->geometryProtected;
}

References s.

◆ isPrintable()

bool KoShape::isPrintable ( ) const

Returns the current printable state of this shape.

A shape can be visible but not printable, not printable and not visible or visible and printable, but not invisible and still printable.

Returns: current printable state of this shape.

Definition at line 1001 of file KoShape.cpp.

{
    if (s->visible)
        return s->printable;
    else
        return false;
}

References s.

◆ isSelectable()

bool KoShape::isSelectable ( ) const

Returns if this shape can be selected by the user.

Returns: true only when the object is selectable.

See also: isGeometryProtected(), isContentProtected(), isVisible()

Definition at line 1014 of file KoShape.cpp.

{
    return s->selectable;
}

References s.

◆ isShapeEditable()

bool KoShape::isShapeEditable ( bool recursive = true ) const

virtual

checks recursively if the shape or one of its parents is not visible or locked

Reimplemented in KisShapeLayer.

Definition at line 1165 of file KoShape.cpp.

{
    if (!s->visible || s->geometryProtected)
        return false;
 
    if (recursive && d->parent) {
        return d->parent->isShapeEditable(true);
    }
 
    return true;
}

References d, and s.

◆ isVisible()

bool KoShape::isVisible ( bool recursive = true ) const

Returns current visibility state of this shape. Being visible means being painted, as well as being used for things like guidelines or searches.

Parameters

recursive when true, checks visibility recursively

Returns: current visibility state of this shape.

See also: isGeometryProtected(), isContentProtected(), isSelectable()

Definition at line 979 of file KoShape.cpp.

{
    if (!recursive)
        return s->visible;
 
    if (!s->visible)
        return false;
 
    KoShapeContainer * parentShape = parent();
 
    if (parentShape) {
        return parentShape->isVisible(true);
    }
 
    return true;
}

References isVisible(), parent(), and s.

◆ keepAspectRatio()

bool KoShape::keepAspectRatio ( ) const

Setting the shape to keep its aspect-ratio has the effect that user-scaling will keep the width/height ratio intact so as not to distort shapes that rely on that ratio.

Returns: whether to keep aspect ratio of this shape

Definition at line 1052 of file KoShape.cpp.

{
    return s->keepAspect;
}

References s.

◆ linearizeSubtree()

QList< KoShape * > KoShape::linearizeSubtree ( const QList< KoShape * > & shapes )

static

Definition at line 1381 of file KoShape.cpp.

{
    QList<KoShape *> result;
 
    Q_FOREACH (KoShape *shape, shapes) {
        result << shape;
 
        KoShapeContainer *container = dynamic_cast<KoShapeContainer*>(shape);
        if (container) {
            result << linearizeSubtree(container->shapes());
        }
    }
 
    return result;
}

References linearizeSubtree(), and KoShapeContainer::shapes().

◆ linearizeSubtreeSorted()

QList< KoShape * > KoShape::linearizeSubtreeSorted ( const QList< KoShape * > & shapes )

static

Definition at line 1397 of file KoShape.cpp.

{
    QList<KoShape*> sortedShapes = shapes;
    std::sort(sortedShapes.begin(), sortedShapes.end(), KoShape::compareShapeZIndex);
 
    QList<KoShape *> result;
 
    Q_FOREACH (KoShape *shape, sortedShapes) {
        result << shape;
 
        KoShapeContainer *container = dynamic_cast<KoShapeContainer*>(shape);
        if (container) {
            result << linearizeSubtreeSorted(container->shapes());
        }
    }
 
    return result;
}

References compareShapeZIndex(), linearizeSubtreeSorted(), and KoShapeContainer::shapes().

◆ listeners()

QList< KoShape::ShapeChangeListener * > KoShape::listeners ( ) const

protected

Definition at line 1376 of file KoShape.cpp.

{
    return d->listeners;
}

References d.

◆ minimumHeight()

qreal KoShape::minimumHeight ( ) const

Return the minimum height of the shape.

Returns: the minimum height of the shape. Default is 0.0.

◆ name()

QString KoShape::name ( ) const

Returns the name of the shape.

Returns: the shapes name

Definition at line 1150 of file KoShape.cpp.

{
    return s->name;
}

References s.

◆ notifyChanged()

void KoShape::notifyChanged ( )

Update the position of the shape in the tree of the KoShapeManager.

Definition at line 698 of file KoShape.cpp.

{
    Q_FOREACH (KoShapeManager * manager, d->shapeManagers) {
        manager->notifyShapeChanged(this);
    }
}

References d, and KoShapeManager::notifyShapeChanged().

◆ outline()

QPainterPath KoShape::outline ( ) const

virtual

returns the outline of the shape in the form of a path. The outline returned will always be relative to the position() of the shape, so moving the shape will not alter the result. The outline is used to draw the stroke on, for example.

Returns: the outline of the shape in the form of a path.

Reimplemented in KoPathShape, and KoSvgTextShape.

Definition at line 630 of file KoShape.cpp.

{
    QPainterPath path;
    path.addRect(outlineRect());
    return path;
}

References outlineRect().

◆ outlineRect()

QRectF KoShape::outlineRect ( ) const

virtual

returns the outline of the shape in the form of a rect. The outlineRect returned will always be relative to the position() of the shape, so moving the shape will not alter the result. The outline is used to calculate the boundingRect.

Returns: the outline of the shape in the form of a rect.

Reimplemented in KoPathShape, KoSelection, KoShapeGroup, and KoSvgTextShape.

Definition at line 637 of file KoShape.cpp.

{
    const QSizeF s = size();
    return QRectF(QPointF(0, 0), QSizeF(qMax(s.width(),  qreal(0.0001)),
                                        qMax(s.height(), qreal(0.0001))));
}

References s, and size().

◆ paint()

virtual void KoShape::paint ( QPainter & painter ) const

pure virtual

Paint the shape fill The class extending this one is responsible for painting itself. painter is expected to be preconfigured to work in "document" pixels.

Parameters

painter used for painting the shape

Implemented in KisReferenceImage, KoPathShape, KoSelection, KoShapeContainer, KoSvgTextShape, KisNodeShape, and ImageShape.

◆ paintMarkers()

void KoShape::paintMarkers ( QPainter & painter ) const

virtual

paintStroke paints the shape's markers

Parameters

painter used for painting the shape

See also: applyConversion()

Definition at line 230 of file KoShape.cpp.

{
    if (stroke()) {
        stroke()->paintMarkers(this, painter);
    }
}

References stroke().

◆ paintOrder()

QVector< KoShape::PaintOrder > KoShape::paintOrder ( ) const

virtual

paintOrder

Returns: vector of paint orders, will always be 3 big and contain a fill, stroke and marker entry.

Reimplemented in KoSvgTextShape.

Definition at line 773 of file KoShape.cpp.

{
    QVector<PaintOrder> order = defaultPaintOrder();
    if (!s->inheritPaintOrder) {
        order = s->paintOrder;
    } else if (parent()) {
        order = parent()->paintOrder();
    }
    return order;
}

References defaultPaintOrder(), paintOrder(), parent(), and s.

◆ paintStroke()

void KoShape::paintStroke ( QPainter & painter ) const

virtual

paintStroke paints the shape's stroked outline

Parameters

painter used for painting the shape

See also: applyConversion()

Reimplemented in KoSvgTextShape.

Definition at line 223 of file KoShape.cpp.

{
    if (stroke()) {
        stroke()->paint(this, painter);
    }
}

References stroke().

◆ parent()

KoShapeContainer * KoShape::parent ( ) const

Returns the parent, or 0 if there is no parent.

Returns: the parent, or 0 if there is no parent.

Definition at line 1039 of file KoShape.cpp.

{
    return d->parent;
}

References d, and parent().

◆ position()

QPointF KoShape::position ( ) const

Get the position of the shape in pt.

Returns: the position of the shape

Definition at line 825 of file KoShape.cpp.

{
    QPointF center = outlineRect().center();
    return s->localMatrix.map(center) - center;
}

References outlineRect(), and s.

◆ removeAdditionalAttribute()

void KoShape::removeAdditionalAttribute ( const QString & name )

Remove additional attribute

Parameters

name	The name of the attribute in the following form prefix:tag e.g. presentation:placeholder

Definition at line 1269 of file KoShape.cpp.

{
    s->additionalAttributes.remove(name);
}

References name(), and s.

◆ removeAdditionalStyleAttribute()

void KoShape::removeAdditionalStyleAttribute ( const char * name )

Definition at line 1289 of file KoShape.cpp.

{
    s->additionalStyleAttributes.remove(name);
}

References name(), and s.

◆ removeDependee()

void KoShape::removeDependee ( KoShape * shape )

Removes as shape depending on this shape.

See also: addDependee(), hasDependee()

Definition at line 1236 of file KoShape.cpp.

{
    int index = d->dependees.indexOf(shape);
    if (index >= 0)
        d->dependees.removeAt(index);
}

References d.

◆ removeShapeChangeListener()

void KoShape::removeShapeChangeListener ( KoShape::ShapeChangeListener * listener )

Definition at line 1368 of file KoShape.cpp.

{
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(d->listeners.contains(listener));
    d->listeners.removeAll(listener);
    listener->unregisterShape(this);
}

References d, KIS_SAFE_ASSERT_RECOVER_RETURN, and KoShape::ShapeChangeListener::unregisterShape().

◆ removeShapeManager()

void KoShape::removeShapeManager ( KoShapeManager * manager )

private

Definition at line 153 of file KoShape.cpp.

{
    d->shapeManagers.remove(manager);
}

References d.

◆ rotate()

void KoShape::rotate ( qreal angle )

Rotate the shape (relative)

The shape will be rotated from the current rotation using the center of the shape using the size()

Parameters

angle change the angle of rotation increasing it with 'angle' degrees

Definition at line 250 of file KoShape.cpp.

{
    QPointF center = s->localMatrix.map(QPointF(0.5 * size().width(), 0.5 * size().height()));
    QTransform rotateMatrix;
    rotateMatrix.translate(center.x(), center.y());
    rotateMatrix.rotate(angle);
    rotateMatrix.translate(-center.x(), -center.y());
    s->localMatrix = s->localMatrix * rotateMatrix;
 
    notifyChanged();
    shapeChangedPriv(RotationChanged);
}

References notifyChanged(), RotationChanged, s, shapeChangedPriv(), and size().

◆ rotation()

qreal KoShape::rotation ( ) const

Return the current rotation in degrees. It returns NaN if the shape has a shearing or scaling transformation applied.

Definition at line 800 of file KoShape.cpp.

{
    // try to extract the rotation angle out of the local matrix
    // if it is a pure rotation matrix
 
    // check if the matrix has shearing mixed in
    if (fabs(fabs(s->localMatrix.m12()) - fabs(s->localMatrix.m21())) > 1e-10)
        return std::numeric_limits<qreal>::quiet_NaN();
    // check if the matrix has scaling mixed in
    if (fabs(s->localMatrix.m11() - s->localMatrix.m22()) > 1e-10)
        return std::numeric_limits<qreal>::quiet_NaN();
 
    // calculate the angle from the matrix elements
    qreal angle = atan2(-s->localMatrix.m21(), s->localMatrix.m11()) * 180.0 / M_PI;
    if (angle < 0.0)
        angle += 360.0;
 
    return angle;
}

References M_PI, and s.

◆ runThrough()

int KoShape::runThrough ( ) const

Retrieve the run through property of this shape. The run through property is used to determine if the shape is behind, inside or before text.

Returns: the run through of this shape.

Definition at line 962 of file KoShape.cpp.

{
    return s->runThrough;
}

References s.

◆ scale()

void KoShape::scale	(	qreal	sx,
		qreal	sy )

Scale the shape using the zero-point which is the top-left corner.

See also: position()

Parameters

sx	scale in x direction
sy	scale in y direction

Definition at line 237 of file KoShape.cpp.

{
    QPointF pos = position();
    QTransform scaleMatrix;
    scaleMatrix.translate(pos.x(), pos.y());
    scaleMatrix.scale(sx, sy);
    scaleMatrix.translate(-pos.x(), -pos.y());
    s->localMatrix = s->localMatrix * scaleMatrix;
 
    notifyChanged();
    shapeChangedPriv(ScaleChanged);
}

References notifyChanged(), position(), s, ScaleChanged, and shapeChangedPriv().

◆ setAbsolutePosition()

void KoShape::setAbsolutePosition	(	const QPointF &	newPosition,
		KoFlake::AnchorPosition	anchor = KoFlake::Center )

Move this shape to an absolute position where the end location will be the same regardless of the shape's rotation/skew/scaling and regardless of this shape having a parent (being in a group) or not.
The newPosition is going to be the center of the shape. This has the convenient effect that:

shape->setAbsolutePosition(QPointF(0,0));
shape->rotate(45);

Will result in the same visual position of the shape as the opposite:

shape->rotate(45);
shape->setAbsolutePosition(QPointF(0,0));

Parameters

newPosition	the new absolute center of the shape.
anchor	The place on the (unaltered) shape that you set the position of.

Definition at line 668 of file KoShape.cpp.

{
    QPointF currentAbsPosition = absolutePosition(anchor);
    QPointF translate = newPosition - currentAbsPosition;
    QTransform translateMatrix;
    translateMatrix.translate(translate.x(), translate.y());
    applyAbsoluteTransformation(translateMatrix);
    notifyChanged();
    shapeChangedPriv(PositionChanged);
}

References absolutePosition(), anchor(), applyAbsoluteTransformation(), notifyChanged(), PositionChanged, and shapeChangedPriv().

◆ setAdditionalAttribute()

void KoShape::setAdditionalAttribute	(	const QString &	name,
		const QString &	value )

Set additional attribute

This can be used to attach additional attributes to a shape for attributes that are application specific like presentation:placeholder

Parameters

name	The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
value	The value of the attribute

Definition at line 1264 of file KoShape.cpp.

{
    s->additionalAttributes.insert(name, value);
}

References name(), s, and value().

◆ setAdditionalStyleAttribute()

void KoShape::setAdditionalStyleAttribute	(	const char *	name,
		const QString &	value )

Definition at line 1284 of file KoShape.cpp.

{
    s->additionalStyleAttributes.insert(name, value);
}

References name(), s, and value().

◆ setAnchor()

void KoShape::setAnchor ( KoShapeAnchor * anchor )

Set the KoShapeAnchor

◆ setBackground()

void KoShape::setBackground ( QSharedPointer< KoShapeBackground > background )

virtual

Set the background of the shape. A shape background can be a plain color, a gradient, a pattern, be fully transparent or have a complex fill. Setting such a background will allow the shape to be filled and will be able to tell if it is transparent or not.

If the shape inherited the background from its parent, its stops inheriting it, that is inheritBackground property resets to false.

Parameters

background the new shape background.

Reimplemented in KoSvgTextShape.

Definition at line 918 of file KoShape.cpp.

{
    s->inheritBackground = false;
    s->fill = fill;
    shapeChangedPriv(BackgroundChanged);
    notifyChanged();
}

References BackgroundChanged, notifyChanged(), s, and shapeChangedPriv().

◆ setClipMask()

void KoShape::setClipMask ( KoClipMask * clipMask )

Sets a new clip mask, removing the old one. The mask is owned by the shape.

Definition at line 1133 of file KoShape.cpp.

{
    s->clipMask.reset(clipMask);
    shapeChangedPriv(ClipMaskChanged);
    notifyChanged();
}

References clipMask(), ClipMaskChanged, notifyChanged(), s, and shapeChangedPriv().

◆ setClipPath()

void KoShape::setClipPath ( KoClipPath * clipPath )

Sets a new clip path, removing the old one.

Definition at line 1121 of file KoShape.cpp.

{
    s->clipPath.reset(clipPath);
    shapeChangedPriv(ClipPathChanged);
    notifyChanged();
}

References clipPath(), ClipPathChanged, notifyChanged(), s, and shapeChangedPriv().

◆ setContentProtected()

void KoShape::setContentProtected ( bool protect )

Marks the shape to have its content protected against editing. Content protection is a hint for tools to disallow the user editing the content.

Parameters

protect when true set the shapes content to be protected from user modification.

See also: setGeometryProtected(), setSelectable(), setVisible()

Definition at line 1029 of file KoShape.cpp.

{
    s->protectContent = protect;
}

References s.

◆ setFilterEffectStack()

void KoShape::setFilterEffectStack ( KoFilterEffectStack * filterEffectStack )

Sets the new filter effect stack, removing the old one.

Definition at line 1299 of file KoShape.cpp.

{
    if (s->filterEffectStack)
        s->filterEffectStack->deref();
    s->filterEffectStack = filterEffectStack;
    if (s->filterEffectStack) {
        s->filterEffectStack->ref();
    }
    notifyChanged();
}

References KoFilterEffectStack::deref(), filterEffectStack(), notifyChanged(), KoFilterEffectStack::ref(), and s.

◆ setGeometryProtected()

void KoShape::setGeometryProtected ( bool on )

Tells the shape to have its position/rotation and size protected from user-changes. The geometry being protected means the user can not change shape or position of the shape. This includes any matrix operation such as rotation.

Parameters

on	when true; set the shape to have its geometry protected.

See also: setContentProtected(), setSelectable(), setVisible()

Definition at line 1019 of file KoShape.cpp.

{
    s->geometryProtected = on;
}

References s.

◆ setHyperLink()

void KoShape::setHyperLink ( const QString & hyperLink )

Set hyperlink for this shape.

Parameters

hyperLink name.

Definition at line 1325 of file KoShape.cpp.

{
    s->hyperLink = hyperLink;
}

References hyperLink(), and s.

◆ setInheritBackground()

void KoShape::setInheritBackground ( bool value )

setInheritBackground marks a shape as inheriting the background from the parent shape. NOTE: The currently selected background is destroyed.

Parameters

value true if the shape should inherit the filling background

Definition at line 940 of file KoShape.cpp.

{
 
    s->inheritBackground = value;
    if (s->inheritBackground) {
        s->fill.clear();
    }
}

References s, and value().

◆ setInheritPaintOrder()

void KoShape::setInheritPaintOrder ( bool value )

setInheritPaintOrder set inherit paint order.

Parameters

value

Definition at line 790 of file KoShape.cpp.

{
    s->inheritPaintOrder = value;
}

References s, and value().

◆ setInheritStroke()

void KoShape::setInheritStroke ( bool value )

setInheritStroke marks a shape as inheriting the stroke from the parent shape. NOTE: The currently selected stroke is destroyed.

Parameters

value true if the shape should inherit the stroke style

Definition at line 1090 of file KoShape.cpp.

{
    s->inheritStroke = value;
    if (s->inheritStroke) {
        s->stroke.clear();
    }
}

References s, and value().

◆ setKeepAspectRatio()

void KoShape::setKeepAspectRatio ( bool keepAspect )

Setting the shape to keep its aspect-ratio has the effect that user-scaling will keep the width/height ratio intact so as not to distort shapes that rely on that ratio.

Parameters

keepAspect the new value

Definition at line 1044 of file KoShape.cpp.

{
    s->keepAspect = keepAspect;
 
    shapeChangedPriv(KeepAspectRatioChange);
    notifyChanged();
}

References KeepAspectRatioChange, notifyChanged(), s, and shapeChangedPriv().

◆ setMinimumHeight()

void KoShape::setMinimumHeight ( qreal height )

Set the minimum height of the shape. Currently it's not respected but only for informational purpose

Parameters

height the minimum height of the frame.

◆ setName()

void KoShape::setName ( const QString & name )

Sets the name of the shape.

Parameters

name	the new shape name

Definition at line 1155 of file KoShape.cpp.

{
    s->name = name;
}

References name(), and s.

◆ setPaintOrder()

void KoShape::setPaintOrder	(	KoShape::PaintOrder	first,
		KoShape::PaintOrder	second )

virtual

setPaintOrder set the paint order. As there's only three entries in any given paintorder, you only need to have the first and second entry to set it.

Parameters

first	first thing to paint
second	second thing to paint.

Reimplemented in KoSvgTextShape.

Definition at line 749 of file KoShape.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(first != second);
    QVector<PaintOrder> order = defaultPaintOrder();
 
    if (first != Fill) {
        if (order.at(1) == first) {
            order[1] = order[0];
            order[0] = first;
        } else if (order.at(2) == first) {
            order[2] = order[0];
            order[0] = first;
        }
    }
    if (second != first && second != Stroke) {
        if (order.at(2) == second) {
            order[2] = order[1];
            order[1] = second;
        }
    }
    s->inheritPaintOrder = false;
    s->paintOrder = order;
}

References defaultPaintOrder(), Fill, KIS_SAFE_ASSERT_RECOVER_RETURN, and s.

◆ setParent()

void KoShape::setParent ( KoShapeContainer * parent )

Set the parent of this shape.

Parameters

parent the new parent of this shape. Can be 0 if the shape has no parent anymore.

Definition at line 535 of file KoShape.cpp.

{
 
    if (d->parent == parent) {
        return;
    }
 
    if (d->parent) {
        d->parent->shapeInterface()->removeShape(this);
        d->parent = 0;
    }
 
 
    KIS_SAFE_ASSERT_RECOVER_NOOP(parent != this);
 
    if (parent && parent != this) {
        d->parent = parent;
        parent->shapeInterface()->addShape(this);
    }
 
    notifyChanged();
    shapeChangedPriv(ParentChanged);
}

References d, and parent().

◆ setPosition()

void KoShape::setPosition ( const QPointF & position )

virtual

Set the position of the shape in pt.

Parameters

position the new position of the shape

Reimplemented in KisNodeShape.

Definition at line 295 of file KoShape.cpp.

{
    QPointF currentPos = position();
    if (newPosition == currentPos)
        return;
    QTransform translateMatrix;
    translateMatrix.translate(newPosition.x() - currentPos.x(), newPosition.y() - currentPos.y());
    s->localMatrix = s->localMatrix * translateMatrix;
 
    notifyChanged();
    shapeChangedPriv(PositionChanged);
}

References notifyChanged(), position(), PositionChanged, s, and shapeChangedPriv().

◆ setPrintable()

void KoShape::setPrintable ( bool on )

Changes the shape to be printable or not. The default is true.

If a Shape's print flag is true, the shape will be printed. If false, the shape will not be printed. If a shape is not visible (

See also: isVisible), it isPrinted will return false, too.

Definition at line 996 of file KoShape.cpp.

{
    s->printable = on;
}

References s.

◆ setResolution()

void KoShape::setResolution	(	qreal	xRes,
		qreal	yRes )

virtual

Update the image resolution in pixels per inch. Shapes should override this if they need to know the image resolution.

Parameters

xRes
yRes

Reimplemented in KoSvgTextShape.

Definition at line 1416 of file KoShape.cpp.

1417{

1418}

◆ setRunThrough()

void KoShape::setRunThrough ( short int runThrough )

virtual

Set the run through property of this shape. The run through property is used to determine if the shape is behind, inside or before text.

Parameters

runThrough the new run through;

Reimplemented in KoTosContainer.

Definition at line 967 of file KoShape.cpp.

{
    s->runThrough = runThrough;
}

References runThrough(), and s.

◆ setSelectable()

void KoShape::setSelectable ( bool selectable )

Makes it possible for the user to select this shape. This parameter defaults to true.

Parameters

selectable when true; set the shape to be selectable by the user.

See also: setGeometryProtected(), setContentProtected(), setVisible()

Definition at line 1009 of file KoShape.cpp.

{
    s->selectable = selectable;
}

References s.

◆ setShadow()

void KoShape::setShadow ( KoShapeShadow * shadow )

Sets the new shadow, removing the old one.

Definition at line 1103 of file KoShape.cpp.

{
    if (s->shadow)
        s->shadow->deref();
    s->shadow = shadow;
    if (s->shadow) {
        s->shadow->ref();
        // TODO update changed area
    }
    shapeChangedPriv(ShadowChanged);
    notifyChanged();
}

References notifyChanged(), KoShapeShadow::ref(), s, shadow(), ShadowChanged, and shapeChangedPriv().

◆ setShapeId()

void KoShape::setShapeId ( const QString & id )

Set the Id of this shape. A shapeFactory is expected to set the Id at creation so applications can find out what kind of shape this is.

See also: KoShapeFactoryBase::shapeId()

Parameters

id	the ID from the factory that created this shape

Definition at line 1062 of file KoShape.cpp.

{
    s->shapeId = id;
}

References s.

◆ setSize()

void KoShape::setSize ( const QSizeF & size )

virtual

Resize the shape.

Parameters

size the new size of the shape. This is different from scaling as scaling is a so called secondary operation which is comparable to zooming in instead of changing the size of the basic shape. Easiest example of this difference is that using this method will not distort the size of pattern-fills and strokes.

Reimplemented in EllipseShape, EnhancedPathShape, SpiralShape, StarShape, KarbonCalligraphicShape, KoParameterShape, KoPathShape, KoSelection, KoShapeGroup, and ImageShape.

Definition at line 276 of file KoShape.cpp.

{
    QSizeF oldSize(size());
 
    // always set size, as d->size and size() may vary
    setSizeImpl(newSize);
 
    if (oldSize == newSize)
        return;
 
    notifyChanged();
    shapeChangedPriv(SizeChanged);
}

References notifyChanged(), setSizeImpl(), shapeChangedPriv(), size(), and SizeChanged.

◆ setSizeImpl()

void KoShape::setSizeImpl ( const QSizeF & size ) const

protected

Definition at line 290 of file KoShape.cpp.

{
    s->size = size;
}

References s, and size().

◆ setStroke()

void KoShape::setStroke ( KoShapeStrokeModelSP stroke )

virtual

Set a new stroke, removing the old one. The stroke inheritance becomes disabled.

Parameters

stroke the new stroke, or 0 if there should be no stroke.

Reimplemented in KoSvgTextShape.

Definition at line 1081 of file KoShape.cpp.

{
 
    s->inheritStroke = false;
    s->stroke = stroke;
    shapeChangedPriv(StrokeChanged);
    notifyChanged();
}

References notifyChanged(), s, shapeChangedPriv(), stroke(), and StrokeChanged.

◆ setTextRunAroundContour()

void KoShape::setTextRunAroundContour ( KoShape::TextRunAroundContour contour )

Set how tight text run around is done around this shape.

Parameters

contour the new contour

Definition at line 913 of file KoShape.cpp.

{
    s->textRunAroundContour = contour;
}

References s.

◆ setTextRunAroundDistanceBottom()

void KoShape::setTextRunAroundDistanceBottom ( qreal distance )

Set the space between this shape's bottom edge and the text that run around this shape.

Parameters

distance the space around this shape to keep free from text

Definition at line 893 of file KoShape.cpp.

{
    s->textRunAroundDistanceBottom = distance;
}

References distance(), and s.

◆ setTextRunAroundDistanceLeft()

void KoShape::setTextRunAroundDistanceLeft ( qreal distance )

Set the space between this shape's left edge and the text that run around this shape.

Parameters

distance the space around this shape to keep free from text

Definition at line 873 of file KoShape.cpp.

{
    s->textRunAroundDistanceLeft = distance;
}

References distance(), and s.

◆ setTextRunAroundDistanceRight()

void KoShape::setTextRunAroundDistanceRight ( qreal distance )

Set the space between this shape's right edge and the text that run around this shape.

Parameters

distance the space around this shape to keep free from text

Definition at line 883 of file KoShape.cpp.

{
    s->textRunAroundDistanceRight = distance;
}

References distance(), and s.

◆ setTextRunAroundDistanceTop()

void KoShape::setTextRunAroundDistanceTop ( qreal distance )

Set the space between this shape's top edge and the text that run around this shape.

Parameters

distance the space around this shape to keep free from text

Definition at line 863 of file KoShape.cpp.

{
    s->textRunAroundDistanceTop = distance;
}

References distance(), and s.

◆ setTextRunAroundSide()

void KoShape::setTextRunAroundSide	(	TextRunAroundSide	side,
		RunThroughLevel	runThrough = Background )

Set the side text should flow around this shape.

Parameters

side	the requested side
runThrough	run through the foreground or background or...

Definition at line 836 of file KoShape.cpp.

{
 
    if (side == RunThrough) {
        if (runThrough == Background) {
            setRunThrough(-1);
        } else {
            setRunThrough(1);
        }
    } else {
        setRunThrough(0);
    }
 
    if ( s->textRunAroundSide == side) {
        return;
    }
 
    s->textRunAroundSide = side;
    notifyChanged();
    shapeChangedPriv(TextRunAroundChanged);
}

References Background, notifyChanged(), RunThrough, runThrough(), s, setRunThrough(), shapeChangedPriv(), and TextRunAroundChanged.

◆ setTextRunAroundThreshold()

void KoShape::setTextRunAroundThreshold ( qreal threshold )

Set the threshold above which text should flow around this shape. The text will not flow around the shape on a side unless the space available on that side is above this threshold. Only used when the text run around side is EnoughRunAroundSide.

Parameters

threshold the new threshold

Definition at line 903 of file KoShape.cpp.

{
    s->textRunAroundThreshold = threshold;
}

References s.

◆ setToolDelegates()

void KoShape::setToolDelegates ( const QSet< KoShape * > & delegates )

Set the tool delegates.

Parameters

delegates the new delegates.

See also: toolDelegates()

Definition at line 1315 of file KoShape.cpp.

{
    d->toolDelegates = delegates;
}

References d.

◆ setTransformation()

void KoShape::setTransformation ( const QTransform & matrix )

Sets a new transformation matrix describing the local transformations on this shape.

Parameters

matrix the new transformation matrix

Definition at line 417 of file KoShape.cpp.

{
    s->localMatrix = matrix;
    notifyChanged();
    shapeChangedPriv(GenericMatrixChange);
}

References GenericMatrixChange, notifyChanged(), s, and shapeChangedPriv().

◆ setTransparency()

void KoShape::setTransparency ( qreal transparency )

Sets shape level transparency.

Parameters

transparency the new shape level transparency

Definition at line 722 of file KoShape.cpp.

{
    s->transparency = qBound<qreal>(0.0, transparency, 1.0);
 
    shapeChangedPriv(TransparencyChanged);
    notifyChanged();
}

References notifyChanged(), s, shapeChangedPriv(), transparency(), and TransparencyChanged.

◆ setUserData()

void KoShape::setUserData ( KoShapeUserData * userData )

Set a data object on the shape to be used by an application. This is specifically useful when a shape is created in a plugin and that data from that shape should be accessible outside the plugin.

Parameters

userData the new user data, or 0 to delete the current one.

Definition at line 705 of file KoShape.cpp.

{
    s->userData.reset(userData);
}

References s, and userData().

◆ setVisible()

void KoShape::setVisible ( bool on )

Changes the Shape to be visible or invisible. Being visible means being painted, as well as being used for things like guidelines or searches.

Parameters

on	when true; set the shape to be visible.

See also: setGeometryProtected(), setContentProtected(), setSelectable()

Definition at line 972 of file KoShape.cpp.

{
    int _on = (on ? 1 : 0);
    if (s->visible == _on) return;
    s->visible = _on;
}

References s.

◆ setZIndex()

void KoShape::setZIndex ( qint16 zIndex )

Set the z-coordinate of this shape. The zIndex property is used to determine which shape lies on top of other objects. An shape with a higher z-order is on top, and can obscure, another shape.

Just like two objects having the same x or y coordinate will make them 'touch', so will two objects with the same z-index touch on the z plane. In layering the shape this, however, can cause a little confusion as one always has to be on top. The layering if two overlapping objects have the same index is implementation dependent and probably depends on the order in which they are added to the shape manager.

Parameters

zIndex the new z-index;

Definition at line 954 of file KoShape.cpp.

{
    if (s->zIndex == zIndex)
        return;
    s->zIndex = zIndex;
    notifyChanged();
}

References notifyChanged(), s, and zIndex().

◆ shadow()

KoShapeShadow * KoShape::shadow ( ) const

Returns the currently set shadow or 0 if there is no shadow set.

Definition at line 1116 of file KoShape.cpp.

{
    return s->shadow;
}

References s.

◆ shadowOutline()

QPainterPath KoShape::shadowOutline ( ) const

virtual

returns the outline of the shape in the form of a path for the use of painting a shadow.

Normally this would be the same as outline() if there is a fill (background) set on the shape and empty if not. However, a shape could reimplement this to return an outline even if no fill is defined. A typical example of this would be the picture shape which has a picture but almost never a background.

Returns: the outline of the shape in the form of a path.

Definition at line 644 of file KoShape.cpp.

{
    if (background()) {
        return outline();
    }
 
    return QPainterPath();
}

References background(), and outline().

◆ shapeChanged()

void KoShape::shapeChanged	(	ChangeType	type,
		KoShape *	shape = 0 )

protectedvirtual

A hook that allows inheriting classes to do something after a KoShape property changed This is called whenever the shape, position rotation or scale properties were altered.

Parameters

type	an indicator which type was changed.
shape	the shape.

Reimplemented in KoSvgTextShape, KoShapeContainer, KoShapeGroup, KoTosContainer, and EnhancedPathShape.

Definition at line 1253 of file KoShape.cpp.

{
    Q_UNUSED(type);
    Q_UNUSED(shape);
}

◆ shapeChangedPriv()

void KoShape::shapeChangedPriv ( KoShape::ChangeType type )

protected

Notify the shape that a change was done. To be used by inheriting shapes.

Parameters

type	the change type

Definition at line 132 of file KoShape.cpp.

{
    if (d->parent)
        d->parent->model()->childChanged(this, type);
 
    this->shapeChanged(type);
 
    Q_FOREACH (KoShape * shape, d->dependees) {
        shape->shapeChanged(type, this);
    }
 
    Q_FOREACH (KoShape::ShapeChangeListener *listener, d->listeners) {
        listener->notifyShapeChangedImpl(type, this);
    }
}

References d, dependees(), KoShape::ShapeChangeListener::notifyShapeChangedImpl(), and shapeChanged().

◆ shapeId()

QString KoShape::shapeId ( ) const

Return the Id of this shape, identifying the type of shape by the id of the factory.

See also: KoShapeFactoryBase::shapeId()

Returns: the id of the shape-type

Definition at line 1057 of file KoShape.cpp.

{
    return s->shapeId;
}

References s.

◆ shapeToDocument() [1/2]

QPointF KoShape::shapeToDocument ( const QPointF & point ) const

Transforms point from shape coordinates to document coordinates.

Parameters

point in shape coordinates

Returns: point in document coordinates

Definition at line 1201 of file KoShape.cpp.

{
    return absoluteTransformation().map(point);
}

References absoluteTransformation().

◆ shapeToDocument() [2/2]

QRectF KoShape::shapeToDocument ( const QRectF & rect ) const

Transforms rect from shape coordinates to document coordinates.

Parameters

rect	in shape coordinates

Returns: rect in document coordinates

Definition at line 1206 of file KoShape.cpp.

{
    return absoluteTransformation().mapRect(rect);
}

References absoluteTransformation().

◆ shear()

void KoShape::shear	(	qreal	sx,
		qreal	sy )

Shear the shape The shape will be sheared using the zero-point which is the top-left corner.

See also: position()

Parameters

sx	shear in x direction
sy	shear in y direction

Definition at line 263 of file KoShape.cpp.

{
    QPointF pos = position();
    QTransform shearMatrix;
    shearMatrix.translate(pos.x(), pos.y());
    shearMatrix.shear(sx, sy);
    shearMatrix.translate(-pos.x(), -pos.y());
    s->localMatrix = s->localMatrix * shearMatrix;
 
    notifyChanged();
    shapeChangedPriv(ShearChanged);
}

References notifyChanged(), position(), s, shapeChangedPriv(), and ShearChanged.

◆ size()

QSizeF KoShape::size ( ) const

virtual

Get the size of the shape in pt.

The size is in shape coordinates.

Returns: the size of the shape as set by setSize()

Reimplemented in KoPathShape, KoSelection, KoShapeGroup, and KisNodeShape.

Definition at line 820 of file KoShape.cpp.

{
    return s->size;
}

References s.

◆ snapData()

KoSnapData KoShape::snapData ( ) const

virtual

Returns additional snap data the shape wants to have snapping to.

Definition at line 1259 of file KoShape.cpp.

{
    return KoSnapData();
}

◆ stroke()

KoShapeStrokeModelSP KoShape::stroke ( ) const

virtual

Returns the currently set stroke, or 0 if there is no stroke.

Returns: the currently set stroke, or 0 if there is no stroke.

Reimplemented in KoSvgTextShape.

Definition at line 1067 of file KoShape.cpp.

{
 
    KoShapeStrokeModelSP stroke;
 
    if (!s->inheritStroke) {
        stroke = s->stroke;
    } else if (parent()) {
        stroke = parent()->stroke();
    }
 
    return stroke;
}

References parent(), s, and stroke().

◆ strokeInsets()

KoInsets KoShape::strokeInsets ( ) const

Return the insets of the stroke. Convenience method for KoShapeStrokeModel::strokeInsets()

Definition at line 741 of file KoShape.cpp.

{
    KoInsets answer;
    if (s->stroke)
        s->stroke->strokeInsets(this, answer);
    return answer;
}

References s.

◆ textRunAroundContour()

KoShape::TextRunAroundContour KoShape::textRunAroundContour ( ) const

Return the how tight text run around is done around this shape.

Returns: the contour

Definition at line 908 of file KoShape.cpp.

{
    return s->textRunAroundContour;
}

References s.

◆ textRunAroundDistanceBottom()

qreal KoShape::textRunAroundDistanceBottom ( ) const

The space between this shape's bottom edge and text that runs around this shape.

Returns: the space around this shape to keep free from text

Definition at line 888 of file KoShape.cpp.

{
    return s->textRunAroundDistanceBottom;
}

References s.

◆ textRunAroundDistanceLeft()

qreal KoShape::textRunAroundDistanceLeft ( ) const

The space between this shape's left edge and text that runs around this shape.

Returns: the space around this shape to keep free from text

Definition at line 868 of file KoShape.cpp.

{
    return s->textRunAroundDistanceLeft;
}

References s.

◆ textRunAroundDistanceRight()

qreal KoShape::textRunAroundDistanceRight ( ) const

The space between this shape's right edge and text that runs around this shape.

Returns: the space around this shape to keep free from text

Definition at line 878 of file KoShape.cpp.

{
    return s->textRunAroundDistanceRight;
}

References s.

◆ textRunAroundDistanceTop()

qreal KoShape::textRunAroundDistanceTop ( ) const

The space between this shape's top edge and text that runs around this shape.

Returns: the space around this shape to keep free from text

Definition at line 858 of file KoShape.cpp.

{
    return s->textRunAroundDistanceTop;
}

References s.

◆ textRunAroundSide()

KoShape::TextRunAroundSide KoShape::textRunAroundSide ( ) const

Return the side text should flow around this shape. This implements the ODF style:wrap attribute that specifies how text is displayed around a frame or graphic object.

Definition at line 831 of file KoShape.cpp.

{
    return s->textRunAroundSide;
}

References s.

◆ textRunAroundThreshold()

qreal KoShape::textRunAroundThreshold ( ) const

Return the threshold above which text should flow around this shape. The text will not flow around the shape on a side unless the space available on that side is above this threshold. Only used when the text run around side is EnoughRunAroundSide.

Returns: threshold the threshold

Definition at line 898 of file KoShape.cpp.

{
    return s->textRunAroundThreshold;
}

References s.

◆ toolDelegates()

QSet< KoShape * > KoShape::toolDelegates ( ) const

Return the tool delegates for this shape. In Flake a shape being selected will cause the tool manager to make available all tools that can edit the selected shapes. In some cases selecting one shape should allow the tool to edit a related shape be available too. The tool delegates allows this to happen by taking all the shapes in the set into account on tool selection. Notice that if the set is non-empty 'this' shape is no longer looked at. You can choose to add itself to the set too.

Definition at line 1310 of file KoShape.cpp.

{
    return d->toolDelegates;
}

References d.

◆ transform()

QTransform KoShape::transform ( ) const

protected

return the current matrix that contains the rotation/scale/position of this shape

Definition at line 1145 of file KoShape.cpp.

{
    return s->localMatrix;
}

References s.

◆ transformation()

QTransform KoShape::transformation ( ) const

Returns the shapes local transformation matrix.

Definition at line 424 of file KoShape.cpp.

{
    return s->localMatrix;
}

References s.

◆ transparency()

qreal KoShape::transparency ( bool recursive = false ) const

Returns the shape level transparency.

Parameters

recursive when true takes the parents transparency into account

Definition at line 730 of file KoShape.cpp.

{
    if (!recursive || !parent()) {
        return s->transparency;
    } else {
        const qreal parentOpacity = 1.0-parent()->transparency(recursive);
        const qreal childOpacity = 1.0-s->transparency;
        return 1.0-(parentOpacity*childOpacity);
    }
}

References parent(), s, and transparency().

◆ update()

void KoShape::update ( ) const

virtual

Request a repaint to be queued. The repaint will be of the entire Shape, including its selection handles should this shape be selected.

This method will return immediately and only request a repaint. Successive calls will be merged into an appropriate repaint action.

Reimplemented in KoShapeContainer, and KoShapeContainer.

Definition at line 605 of file KoShape.cpp.

{
 
    if (!d->shapeManagers.empty()) {
        const QRectF rect(boundingRect());
        Q_FOREACH (KoShapeManager * manager, d->shapeManagers) {
            manager->update(rect, this, true);
        }
    }
}

References boundingRect(), d, and KoShapeManager::update().

◆ updateAbsolute()

void KoShape::updateAbsolute ( const QRectF & rect ) const

virtual

Request a repaint to be queued. The repaint will be restricted to the parameters rectangle, which is expected to be in absolute coordinates of the canvas and it is expected to be normalized.

This method will return immediately and only request a repaint. Successive calls will be merged into an appropriate repaint action.

Parameters

rect	the rectangle (in pt) to queue for repaint.

Definition at line 616 of file KoShape.cpp.

{
    if (rect.isEmpty() && !rect.isNull()) {
        return;
    }
 
 
    if (!d->shapeManagers.empty() && isVisible()) {
        Q_FOREACH (KoShapeManager *manager, d->shapeManagers) {
            manager->update(rect);
        }
    }
}

References d, isVisible(), and KoShapeManager::update().

◆ userData()

KoShapeUserData * KoShape::userData ( ) const

Return the current userData.

Definition at line 710 of file KoShape.cpp.

{
    return s->userData.data();
}

References s.

◆ waitUntilReady()

void KoShape::waitUntilReady ( bool asynchronous = true ) const

virtual

A shape can be in a state that it is doing processing data like loading or text layout. In this case it can be shown on screen probably partially but it should really not be printed until it is fully done processing. Warning! This method can be blocking for a long time

Parameters

asynchronous If set to true the processing will can take place in a different thread and the function will not block until the shape is finished. In case of printing Flake will call this method from a non-main thread and only start printing it when the in case of printing method returned. If set to false the processing needs to be done synchronously and will block until the result is finished.

Definition at line 1160 of file KoShape.cpp.

{
    Q_UNUSED(asynchronous);
}

◆ zIndex()

qint16 KoShape::zIndex ( ) const

Retrieve the z-coordinate of this shape. The zIndex property is used to determine which shape lies on top of other objects. An shape with a higher z-order is on top, and can obscure another shape.

Returns: the z-index of this shape.

See also: setZIndex()

Definition at line 600 of file KoShape.cpp.

{
    return s->zIndex;
}

References s, and zIndex().

Friends And Related Symbol Documentation

◆ KoShapeManager

friend class KoShapeManager

friend

Definition at line 1151 of file KoShape.h.

Member Data Documentation

◆ d

QScopedPointer<Private> KoShape::d

private

Definition at line 1135 of file KoShape.h.

◆ maxZIndex

const qint16 KoShape::maxZIndex = std::numeric_limits<qint16>::max()

static

Maximum value of z-index

Definition at line 502 of file KoShape.h.

◆ minZIndex

const qint16 KoShape::minZIndex = std::numeric_limits<qint16>::min()

static

Minimum value of z-index

Definition at line 507 of file KoShape.h.

◆ s

QSharedDataPointer<SharedData> KoShape::s

private

Definition at line 1138 of file KoShape.h.

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

libs/flake/KoShape.h
libs/flake/KoShape.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Shape interaction notifications

Member Enumeration Documentation

◆ ChangeType

◆ ChildZOrderPolicy

◆ PaintOrder

◆ RunThroughLevel

◆ TextRunAroundContour

◆ TextRunAroundSide

Constructor & Destructor Documentation

◆ KoShape() [1/2]

◆ ~KoShape()

◆ KoShape() [2/2]

Member Function Documentation

◆ absoluteOutlineRect() [1/2]

◆ absoluteOutlineRect() [2/2]

◆ absolutePosition()

◆ absoluteTransformation()

◆ addDependee()

◆ additionalAttribute()

◆ addShapeChangeListener()

◆ addShapeManager()

◆ anchor()

◆ applyAbsoluteTransformation()

◆ applyTransformation()

◆ background()

◆ boundingRect() [1/2]

◆ boundingRect() [2/2]

◆ childZOrderPolicy()

◆ clipMask()

◆ clipPath()

◆ cloneShape()

◆ cloneShapeAndBakeAbsoluteTransform()

◆ compareShapeZIndex()

◆ copySettings()

◆ createHandlePainterHelperDocument()

◆ createHandlePainterHelperView()

◆ defaultPaintOrder()

◆ dependees()

◆ documentToShape() [1/2]

◆ documentToShape() [2/2]

◆ filterEffectStack()

◆ hasAdditionalAttribute()

◆ hasCommonParent()

◆ hasDependee()

◆ hasTransparency()

◆ hitTest()

◆ hyperLink()

◆ inheritBackground()

◆ inheritPaintOrder()

◆ inheritsTransformFromAny()

◆ inheritStroke()

◆ isContentProtected()

◆ isGeometryProtected()

◆ isPrintable()

◆ isSelectable()

◆ isShapeEditable()

◆ isVisible()

◆ keepAspectRatio()

◆ linearizeSubtree()

◆ linearizeSubtreeSorted()

◆ listeners()

◆ minimumHeight()

◆ name()

◆ notifyChanged()

◆ outline()

◆ outlineRect()

◆ paint()

◆ paintMarkers()

◆ paintOrder()

◆ paintStroke()