Clip path used to clip shapes. More...

#include <KoClipPath.h>

Inheritance diagram for KoClipPath:

Public Member Functions
QTransform	clipDataTransformation (KoShape *clippedShape) const

QList< KoPathShape * >	clipPathShapes () const
	Returns the clip path shapes.

Qt::FillRule	clipRule () const
	Returns the current clip rule.

QList< KoShape * >	clipShapes () const

KoClipPath *	clone () const

void	collectShapePath (QPainterPath result, const KoShape shape)

void	compileClipPath ()

KoFlake::CoordinateSystem	coordinates () const

	KoClipPath (const KoClipPath &)

	KoClipPath (QList< KoShape * > clipShapes, KoFlake::CoordinateSystem coordinates)

KoClipPath &	operator= (const KoClipPath &)

QPainterPath	path () const
	Returns the current clip path with coordinates in percent of the clipped shape size.

QPainterPath	pathForSize (const QSizeF &size) const
	Returns the current clip path scaled to match the specified shape size.

	Private ()

	Private (const Private &rhs)

void	setClipRule (Qt::FillRule clipRule)
	Sets the clip rule to be used for the clip path.

	~KoClipPath ()

	~Private ()

Static Public Member Functions
static void	applyClipping (KoShape *clippedShape, QPainter &painter)
	Applies the clipping to the given painter.

Public Attributes
QPainterPath	clipPath
	the compiled clip path in shape coordinates of the clipped shape

Qt::FillRule	clipRule = Qt::WindingFill

KoFlake::CoordinateSystem	coordinates = KoFlake::ObjectBoundingBox

QSizeF	initialShapeSize
	initial size of clipped shape

QTransform	initialTransformToShape
	initial transformation to shape coordinates of the clipped shape

QList< KoShape * >	shapes

Private Attributes
QSharedDataPointer< Private >	d

Detailed Description

Clip path used to clip shapes.

Definition at line 34 of file KoClipPath.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KoClipPath::~Private ( )

inline

Definition at line 57 of file KoClipPath.cpp.

    {
        qDeleteAll(shapes);
        shapes.clear();
    }

◆ KoClipPath() [1/2]

KoClipPath::KoClipPath	(	QList< KoShape * >	clipShapes,
		KoFlake::CoordinateSystem	coordinates )

Create a new shape clipping using the given clip data

Parameters

clipShapes	define the clipping shapes, owned by KoClipPath!
coordinates	shows if ObjectBoundingBox or UserSpaceOnUse coordinate system is used.

Definition at line 105 of file KoClipPath.cpp.

   : d(new Private())
{
    d->shapes = clipShapes;
    d->coordinates = coordinates;
    d->compileClipPath();
}

References clipShapes(), coordinates, and d.

◆ ~KoClipPath()

KoClipPath::~KoClipPath ( )

Definition at line 113 of file KoClipPath.cpp.

114{

115}

◆ KoClipPath() [2/2]

KoClipPath::KoClipPath ( const KoClipPath & rhs )

Definition at line 117 of file KoClipPath.cpp.

    : d(new Private(*rhs.d))
{
}

Member Function Documentation

◆ applyClipping()

void KoClipPath::applyClipping	(	KoShape *	clippedShape,
		QPainter &	painter )

static

Applies the clipping to the given painter.

Definition at line 148 of file KoClipPath.cpp.

{
    if (shape->clipPath()) {
        QPainterPath path = shape->clipPath()->path();
 
        if (shape->clipPath()->coordinates() == KoFlake::ObjectBoundingBox) {
            const QRectF shapeLocalBoundingRect = shape->outline().boundingRect();
            path = KisAlgebra2D::mapToRect(shapeLocalBoundingRect).map(path);
        }
 
        if (!path.isEmpty()) {
            painter.setClipPath(path, Qt::IntersectClip);
        }
    }
}

References KoShape::clipPath(), coordinates, KisAlgebra2D::mapToRect(), KoFlake::ObjectBoundingBox, KoShape::outline(), and path().

◆ clipDataTransformation()

QTransform KoClipPath::clipDataTransformation ( KoShape * clippedShape ) const

Returns the transformation from the clip data path shapes to the current document coordinates of the specified clipped shape. If the specified clipped shape is null, the transformation from clip data path shapes to shape coordinates of the clipped shape at the time of creating this clip path is being returned.

Definition at line 195 of file KoClipPath.cpp.

{
    if (!clippedShape)
        return d->initialTransformToShape;
 
    // the current transformation of the clipped shape
    QTransform currentShapeTransform = clippedShape->absoluteTransformation();
 
    // calculate the transformation which represents any resizing of the clipped shape
    const QSizeF currentShapeSize = clippedShape->outline().boundingRect().size();
    const qreal sx = currentShapeSize.width() / d->initialShapeSize.width();
    const qreal sy = currentShapeSize.height() / d->initialShapeSize.height();
    QTransform scaleTransform = QTransform().scale(sx, sy);
 
    // 1. transform to initial clipped shape coordinates
    // 2. apply resizing transformation
    // 3. convert to current clipped shape document coordinates
    return d->initialTransformToShape * scaleTransform * currentShapeTransform;
}

References KoShape::absoluteTransformation(), d, and KoShape::outline().

◆ clipPathShapes()

QList< KoPathShape * > KoClipPath::clipPathShapes ( ) const

Returns the clip path shapes.

Definition at line 174 of file KoClipPath.cpp.

{
    // TODO: deprecate this method!
 
    QList<KoPathShape*> shapes;
 
    Q_FOREACH (KoShape *shape, d->shapes) {
        KoPathShape *pathShape = dynamic_cast<KoPathShape*>(shape);
        if (pathShape) {
            shapes << pathShape;
        }
    }
 
    return shapes;
}

References d, and shapes.

◆ clipRule()

Qt::FillRule KoClipPath::clipRule ( ) const

Returns the current clip rule.

◆ clipShapes()

QList< KoShape * > KoClipPath::clipShapes ( ) const

Definition at line 190 of file KoClipPath.cpp.

{
    return d->shapes;
}

References d.

◆ clone()

KoClipPath * KoClipPath::clone ( ) const

Definition at line 128 of file KoClipPath.cpp.

{
    return new KoClipPath(*this);
}

References KoClipPath().

◆ collectShapePath()

void KoClipPath::collectShapePath	(	QPainterPath *	result,
		const KoShape *	shape )

inline

Definition at line 63 of file KoClipPath.cpp.

                                                                      {
        if (const KoPathShape *pathShape = dynamic_cast<const KoPathShape*>(shape)) {
            // different shapes add up to the final path using Windind Fill rule (acc. to SVG 1.1)
            QTransform t = pathShape->absoluteTransformation();
            result->addPath(t.map(pathShape->outline()));
        } else if (const KoShapeGroup *groupShape = dynamic_cast<const KoShapeGroup*>(shape)) {
            QList<KoShape*> shapes = groupShape->shapes();
            std::sort(shapes.begin(), shapes.end(), KoShape::compareShapeZIndex);
 
            Q_FOREACH (const KoShape *child, shapes) {
                collectShapePath(result, child);
            }
        }
    }

References KoShape::compareShapeZIndex().

◆ compileClipPath()

void KoClipPath::compileClipPath ( )

inline

Definition at line 79 of file KoClipPath.cpp.

    {
        QList<KoShape*> clipShapes = this->shapes;
        if (clipShapes.isEmpty())
            return;
 
        clipPath = QPainterPath();
        clipPath.setFillRule(Qt::WindingFill);
 
        std::sort(clipShapes.begin(), clipShapes.end(), KoShape::compareShapeZIndex);
 
        Q_FOREACH (KoShape *path, clipShapes) {
            if (!path) continue;
 
            collectShapePath(&clipPath, path);
        }
    }

References KoShape::compareShapeZIndex().

◆ coordinates()

KoFlake::CoordinateSystem KoClipPath::coordinates ( ) const

◆ operator=()

KoClipPath & KoClipPath::operator= ( const KoClipPath & rhs )

Definition at line 122 of file KoClipPath.cpp.

{
    d = rhs.d;
    return *this;
}

References d.

◆ path()

QPainterPath KoClipPath::path ( ) const

Returns the current clip path with coordinates in percent of the clipped shape size.

Definition at line 164 of file KoClipPath.cpp.

{
    return d->clipPath;
}

References d.

◆ pathForSize()

QPainterPath KoClipPath::pathForSize ( const QSizeF & size ) const

Returns the current clip path scaled to match the specified shape size.

Definition at line 169 of file KoClipPath.cpp.

{
    return scaleFromPercent(size).map(d->clipPath);
}

References d, and scaleFromPercent().

◆ Private() [1/2]

KoClipPath::Private ( )

inline

Definition at line 37 of file KoClipPath.cpp.

38 : QSharedData()

39 {}

◆ Private() [2/2]

KoClipPath::Private ( const Private & rhs )

inline

Definition at line 41 of file KoClipPath.cpp.

        : QSharedData()
        , clipPath(rhs.clipPath)
        , clipRule(rhs.clipRule)
        , coordinates(rhs.coordinates)
        , initialTransformToShape(rhs.initialTransformToShape)
        , initialShapeSize(rhs.initialShapeSize)
    {
        Q_FOREACH (KoShape *shape, rhs.shapes) {
            KoShape *clonedShape = shape->cloneShape();
            KIS_ASSERT_RECOVER(clonedShape) { continue; }
 
            shapes.append(clonedShape);
        }
    }

References KoShape::cloneShape(), and KIS_ASSERT_RECOVER.

◆ setClipRule()

void KoClipPath::setClipRule ( Qt::FillRule clipRule )

Sets the clip rule to be used for the clip path.

Definition at line 133 of file KoClipPath.cpp.

{
    d->clipRule = clipRule;
}

References clipRule, and d.

Member Data Documentation

◆ clipPath

QPainterPath KoClipPath::clipPath

the compiled clip path in shape coordinates of the clipped shape

Definition at line 98 of file KoClipPath.cpp.

◆ clipRule

Qt::FillRule KoClipPath::clipRule = Qt::WindingFill

Definition at line 99 of file KoClipPath.cpp.

◆ coordinates

KoFlake::CoordinateSystem KoClipPath::coordinates = KoFlake::ObjectBoundingBox

Definition at line 100 of file KoClipPath.cpp.

◆ d

QSharedDataPointer<Private> KoClipPath::d

private

Definition at line 77 of file KoClipPath.h.

◆ initialShapeSize

QSizeF KoClipPath::initialShapeSize

initial size of clipped shape

Definition at line 102 of file KoClipPath.cpp.

◆ initialTransformToShape

QTransform KoClipPath::initialTransformToShape

initial transformation to shape coordinates of the clipped shape

Definition at line 101 of file KoClipPath.cpp.

◆ shapes

QList<KoShape*> KoClipPath::shapes

Definition at line 97 of file KoClipPath.cpp.

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

libs/flake/KoClipPath.cpp
libs/flake/KoClipPath.h

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ KoClipPath() [1/2]

◆ ~KoClipPath()

◆ KoClipPath() [2/2]

Member Function Documentation

◆ applyClipping()

◆ clipDataTransformation()

◆ clipPathShapes()

◆ clipRule()

◆ clipShapes()

◆ clone()

◆ collectShapePath()

◆ compileClipPath()

◆ coordinates()

◆ operator=()

◆ path()

◆ pathForSize()

◆ Private() [1/2]

◆ Private() [2/2]

◆ setClipRule()

Member Data Documentation

◆ clipPath

◆ clipRule

◆ coordinates

◆ d

◆ initialShapeSize

◆ initialTransformToShape

◆ shapes