KoSnapProxy Class Reference

#include <KoSnapProxy.h>

Public Member Functions
KoCanvasBase *	canvas ()
	returns canvas we are working on
	KoSnapProxy (KoSnapGuide *snapGuide)
QList< QPointF >	pointsFromShape (KoShape *shape)
	returns list of points from given shape
QList< QPointF >	pointsInRect (const QRectF &rect, bool omitEditedShape)
	returns list of points in given rectangle in document coordinates
QList< KoPathSegment >	segmentsInRect (const QRectF &rect, bool omitEditedShape)
	returns list of points in given rectangle in document coordinates
QList< KoShape * >	shapes (bool omitEditedShape=false)
	returns list of all shapes
QList< KoShape * >	shapesInRect (const QRectF &rect, bool omitEditedShape=false)
	returns list of shape in given rectangle in document coordinates

Private Attributes
KoSnapGuide *	m_snapGuide

Detailed Description

This class provides access to different shape related snap targets to snap strategies.

Definition at line 22 of file KoSnapProxy.h.

Constructor & Destructor Documentation

KoSnapProxy()

KoSnapProxy::KoSnapProxy

(

KoSnapGuide *

snapGuide

)

Definition at line 16 of file KoSnapProxy.cpp.

        : m_snapGuide(snapGuide)
{
}

Member Function Documentation

canvas()

KoCanvasBase * KoSnapProxy::canvas

(

)

returns canvas we are working on

Definition at line 172 of file KoSnapProxy.cpp.

{
    return m_snapGuide->canvas();
}

References KoSnapGuide::canvas, and m_snapGuide.

pointsFromShape()

QList< QPointF > KoSnapProxy::pointsFromShape

(

KoShape *

shape

)

returns list of points from given shape

Definition at line 63 of file KoSnapProxy.cpp.

{
    QList<QPointF> snapPoints;
    // no snapping to hidden shapes
    if (! shape->isVisible())
        return snapPoints;
 
    // return the special snap points of the shape
    snapPoints += shape->snapData().snapPoints();
 
    KoPathShape * path = dynamic_cast<KoPathShape*>(shape);
    if (path) {
        QTransform m = path->absoluteTransformation();
 
        QList<KoPathPoint*> ignoredPoints = m_snapGuide->ignoredPathPoints();
 
        int subpathCount = path->subpathCount();
        for (int subpathIndex = 0; subpathIndex < subpathCount; ++subpathIndex) {
            int pointCount = path->subpathPointCount(subpathIndex);
            for (int pointIndex = 0; pointIndex < pointCount; ++pointIndex) {
                KoPathPoint * p = path->pointByIndex(KoPathPointIndex(subpathIndex, pointIndex));
                if (! p || ignoredPoints.contains(p))
                    continue;
 
                snapPoints.append(m.map(p->point()));
            }
        }
    }
    else
    {
        // add the bounding box corners as default snap points
        QRectF bbox = shape->boundingRect();
        snapPoints.append(bbox.topLeft());
        snapPoints.append(bbox.topRight());
        snapPoints.append(bbox.bottomRight());
        snapPoints.append(bbox.bottomLeft());
    }
 
    return snapPoints;
}

References KoShape::absoluteTransformation(), KoShape::boundingRect(), KoSnapGuide::ignoredPathPoints(), KoShape::isVisible(), m_snapGuide, p, KoShape::snapData(), and KoSnapData::snapPoints().

pointsInRect()

QList< QPointF > KoSnapProxy::pointsInRect	(	const QRectF &	rect,
		bool	omitEditedShape )

returns list of points in given rectangle in document coordinates

Definition at line 21 of file KoSnapProxy.cpp.

{
    QList<QPointF> points;
    QList<KoShape*> shapes = shapesInRect(rect, omitEditedShape);
    Q_FOREACH (KoShape * shape, shapes) {
        Q_FOREACH (const QPointF & point, pointsFromShape(shape)) {
            if (rect.contains(point))
                points.append(point);
        }
    }
 
    return points;
}

References pointsFromShape(), shapes(), and shapesInRect().

segmentsInRect()

QList< KoPathSegment > KoSnapProxy::segmentsInRect	(	const QRectF &	rect,
		bool	omitEditedShape )

returns list of points in given rectangle in document coordinates

Definition at line 104 of file KoSnapProxy.cpp.

{
    
    QList<KoShape*> shapes = shapesInRect(rect, omitEditedShape);
    QList<KoPathPoint*> ignoredPoints = m_snapGuide->ignoredPathPoints();
 
    QList<KoPathSegment> segments;
    Q_FOREACH (KoShape * shape, shapes) {
        QList<KoPathSegment> shapeSegments;
        QRectF rectOnShape = shape->documentToShape(rect);
        KoPathShape * path = dynamic_cast<KoPathShape*>(shape);
        if (path) {
            shapeSegments = path->segmentsAt(rectOnShape);
        } else {
            Q_FOREACH (const KoPathSegment & s, shape->snapData().snapSegments()) {
                QRectF controlRect = s.controlPointRect();
                if (! rect.intersects(controlRect) && ! controlRect.contains(rect))
                    continue;
                QRectF bound = s.boundingRect();
                if (! rect.intersects(bound) && ! bound.contains(rect))
                    continue;
                shapeSegments.append(s);
            }
        }
 
        QTransform m = shape->absoluteTransformation();
        // transform segments to document coordinates
        Q_FOREACH (const KoPathSegment & s, shapeSegments) {
            if (ignoredPoints.contains(s.first()) || ignoredPoints.contains(s.second()))
                continue;
            segments.append(s.mapped(m));
        }
    }
    return segments;
}

References KoShape::absoluteTransformation(), KoPathSegment::boundingRect(), KoPathSegment::controlPointRect(), KoShape::documentToShape(), KoPathSegment::first, KoSnapGuide::ignoredPathPoints(), m_snapGuide, KoPathSegment::mapped(), KoPathSegment::second, shapes(), shapesInRect(), KoShape::snapData(), and KoSnapData::snapSegments().

shapes()

QList< KoShape * > KoSnapProxy::shapes

(

bool

omitEditedShape = false

)

returns list of all shapes

Definition at line 140 of file KoSnapProxy.cpp.

{
    QList<KoShape*> allShapes = m_snapGuide->canvas()->shapeManager()->shapes();
    QList<KoShape*> filteredShapes;
    QList<KoShape*> ignoredShapes = m_snapGuide->ignoredShapes();
 
    // filter all hidden and ignored shapes
    Q_FOREACH (KoShape * shape, allShapes) {
        if (shape->isVisible() &&
            !ignoredShapes.contains(shape) &&
            !dynamic_cast<KoShapeLayer*>(shape)) {
 
            filteredShapes.append(shape);
        }
    }
 
    if (omitEditedShape) {
        Q_FOREACH (KoPathPoint *point, m_snapGuide->ignoredPathPoints()) {
            const int index = filteredShapes.indexOf(point->parent());
            if (index >= 0) {
                filteredShapes.removeAt(index);
            }
        }
    }
 
    if (!omitEditedShape && m_snapGuide->additionalEditedShape()) {
        filteredShapes.append(m_snapGuide->additionalEditedShape());
    }
 
    return filteredShapes;
}

References KoSnapGuide::additionalEditedShape, KoSnapGuide::canvas, KoSnapGuide::ignoredPathPoints(), KoSnapGuide::ignoredShapes, KoShape::isVisible(), m_snapGuide, KoPathPoint::parent(), KoCanvasBase::shapeManager(), and KoShapeManager::shapes.

shapesInRect()

QList< KoShape * > KoSnapProxy::shapesInRect	(	const QRectF &	rect,
		bool	omitEditedShape = false )

returns list of shape in given rectangle in document coordinates

Definition at line 35 of file KoSnapProxy.cpp.

{
    QList<KoShape*> shapes = m_snapGuide->canvas()->shapeManager()->shapesAt(rect);
    Q_FOREACH (KoShape * shape, m_snapGuide->ignoredShapes()) {
        const int index = shapes.indexOf(shape);
        if (index >= 0) {
            shapes.removeAt(index);
        }
    }
 
 
    if (omitEditedShape) {
        Q_FOREACH (KoPathPoint *point, m_snapGuide->ignoredPathPoints()) {
            const int index = shapes.indexOf(point->parent());
            if (index >= 0) {
                shapes.removeAt(index);
            }
        }
    }
 
    if (!omitEditedShape && m_snapGuide->additionalEditedShape()) {
        QRectF bound = m_snapGuide->additionalEditedShape()->boundingRect();
        if (rect.intersects(bound) || rect.contains(bound))
            shapes.append(m_snapGuide->additionalEditedShape());
    }
    return shapes;
}

References KoSnapGuide::additionalEditedShape, KoShape::boundingRect(), KoSnapGuide::canvas, KoSnapGuide::ignoredPathPoints(), KoSnapGuide::ignoredShapes, m_snapGuide, KoPathPoint::parent(), KoCanvasBase::shapeManager(), shapes(), and KoShapeManager::shapesAt().

Member Data Documentation

m_snapGuide

KoSnapGuide* KoSnapProxy::m_snapGuide

private

Definition at line 46 of file KoSnapProxy.h.

---

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

• libs/flake/KoSnapProxy.h
• libs/flake/KoSnapProxy.cpp