KoShape.cpp 76.4 KB
Newer Older
Thomas Zander's avatar
Thomas Zander committed
1
/* This file is part of the KDE project
C. Boemann's avatar
C. Boemann committed
2
   Copyright (C) 2006 C. Boemann Rasmussen <cbo@boemann.dk>
3
   Copyright (C) 2006-2010 Thomas Zander <zander@kde.org>
4
   Copyright (C) 2006-2010 Thorsten Zachmann <zachmann@kde.org>
5
   Copyright (C) 2007-2009,2011 Jan Hambrecht <jaham@gmx.net>
Boudewijn Rempt's avatar
Boudewijn Rempt committed
6
   CopyRight (C) 2010 Boudewijn Rempt <boud@valdyas.org>
Thomas Zander's avatar
Thomas Zander committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21
   Boston, MA 02110-1301, USA.
Thomas Zander's avatar
Thomas Zander committed
22 23 24
*/

#include "KoShape.h"
25
#include "KoShape_p.h"
Thomas Zander's avatar
Thomas Zander committed
26
#include "KoShapeContainer.h"
27
#include "KoShapeLayer.h"
28
#include "KoShapeContainerModel.h"
Thomas Zander's avatar
Thomas Zander committed
29
#include "KoSelection.h"
30
#include "KoPointerEvent.h"
Thomas Zander's avatar
Thomas Zander committed
31
#include "KoInsets.h"
32
#include "KoShapeStrokeModel.h"
33 34
#include "KoShapeBackground.h"
#include "KoColorBackground.h"
35
#include "KoHatchBackground.h"
36 37
#include "KoGradientBackground.h"
#include "KoPatternBackground.h"
38
#include "KoShapeManager.h"
39
#include "KoShapeUserData.h"
40
#include "KoShapeApplicationData.h"
41
#include "KoShapeSavingContext.h"
42
#include "KoShapeLoadingContext.h"
43
#include "KoViewConverter.h"
44
#include "KoShapeStroke.h"
45
#include "KoShapeShadow.h"
46
#include "KoClipPath.h"
47
#include "KoPathShape.h"
48
#include "KoOdfWorkaround.h"
49
#include "KoFilterEffectStack.h"
50
#include <KoSnapData.h>
51
#include <KoElementReference.h>
Thomas Zander's avatar
Thomas Zander committed
52

53
#include <KoXmlReader.h>
54
#include <KoXmlWriter.h>
55
#include <KoXmlNS.h>
56
#include <KoGenStyle.h>
57
#include <KoGenStyles.h>
58
#include <KoUnit.h>
59
#include <KoOdfStylesReader.h>
60
#include <KoOdfGraphicStyles.h>
61
#include <KoOdfLoadingContext.h>
62
#include <KoStyleStack.h>
63
#include <KoBorder.h>
64

Thomas Zander's avatar
Thomas Zander committed
65
#include <QPainter>
66
#include <QVariant>
Thomas Zander's avatar
Thomas Zander committed
67
#include <QPainterPath>
68
#include <QList>
69
#include <QMap>
70
#include <QByteArray>
Boudewijn Rempt's avatar
Boudewijn Rempt committed
71
#include <FlakeDebug.h>
72

73 74
#include "kis_assert.h"

75
#include <limits>
76
#include "KoOdfGradientBackground.h"
77
#include <KisHandlePainterHelper.h>
78

79 80
// KoShapePrivate

81
KoShapePrivate::KoShapePrivate(KoShape *shape)
82 83
    : q_ptr(shape),
      size(50, 50),
84 85
      parent(0),
      shadow(0),
86
      border(0),
87 88 89
      filterEffectStack(0),
      transparency(0.0),
      zIndex(0),
90
      runThrough(0),
91 92 93 94 95 96 97
      visible(true),
      printable(true),
      geometryProtected(false),
      keepAspect(false),
      selectable(true),
      detectCollision(false),
      protectContent(false),
98
      textRunAroundSide(KoShape::BiggestRunAroundSide),
99
      textRunAroundDistanceLeft(0.0),
100
      textRunAroundDistanceTop(0.0),
101 102
      textRunAroundDistanceRight(0.0),
      textRunAroundDistanceBottom(0.0),
103
      textRunAroundThreshold(0.0),
104
      textRunAroundContour(KoShape::ContourFull)
105
{
106 107 108 109
    connectors[KoConnectionPoint::TopConnectionPoint] = KoConnectionPoint::defaultConnectionPoint(KoConnectionPoint::TopConnectionPoint);
    connectors[KoConnectionPoint::RightConnectionPoint] = KoConnectionPoint::defaultConnectionPoint(KoConnectionPoint::RightConnectionPoint);
    connectors[KoConnectionPoint::BottomConnectionPoint] = KoConnectionPoint::defaultConnectionPoint(KoConnectionPoint::BottomConnectionPoint);
    connectors[KoConnectionPoint::LeftConnectionPoint] = KoConnectionPoint::defaultConnectionPoint(KoConnectionPoint::LeftConnectionPoint);
110
    connectors[KoConnectionPoint::FirstCustomConnectionPoint] = KoConnectionPoint(QPointF(0.5, 0.5), KoConnectionPoint::AllDirections, KoConnectionPoint::AlignCenter);
111
}
Thomas Zander's avatar
Thomas Zander committed
112

113 114 115 116 117 118 119 120 121 122 123 124 125
KoShapePrivate::KoShapePrivate(const KoShapePrivate &rhs, KoShape *q)
    : q_ptr(q),
      size(rhs.size),
      shapeId(rhs.shapeId),
      name(rhs.name),
      localMatrix(rhs.localMatrix),
      connectors(rhs.connectors),
      parent(0), // to be initialized later
      shapeManagers(), // to be initialized later
      toolDelegates(), // FIXME: how to initialize them?
      userData(rhs.userData ? rhs.userData->clone() : 0),
      stroke(rhs.stroke),
      fill(rhs.fill),
126
      inheritBackground(rhs.inheritBackground),
127
      inheritStroke(rhs.inheritStroke),
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
      dependees(), // FIXME: how to initialize them?
      shadow(0), // WARNING: not implemented in Krita
      border(0), // WARNING: not implemented in Krita
      clipPath(rhs.clipPath ? rhs.clipPath->clone() : 0),
      clipMask(rhs.clipMask ? rhs.clipMask->clone() : 0),
      additionalAttributes(rhs.additionalAttributes),
      additionalStyleAttributes(rhs.additionalStyleAttributes),
      filterEffectStack(0), // WARNING: not implemented in Krita
      transparency(rhs.transparency),
      hyperLink(rhs.hyperLink),

      zIndex(rhs.zIndex),
      runThrough(rhs.runThrough),
      visible(rhs.visible),
      printable(rhs.visible),
      geometryProtected(rhs.geometryProtected),
      keepAspect(rhs.keepAspect),
      selectable(rhs.selectable),
      detectCollision(rhs.detectCollision),
      protectContent(rhs.protectContent),

      textRunAroundSide(rhs.textRunAroundSide),
      textRunAroundDistanceLeft(rhs.textRunAroundDistanceLeft),
      textRunAroundDistanceTop(rhs.textRunAroundDistanceTop),
      textRunAroundDistanceRight(rhs.textRunAroundDistanceRight),
      textRunAroundDistanceBottom(rhs.textRunAroundDistanceBottom),
      textRunAroundThreshold(rhs.textRunAroundThreshold),
      textRunAroundContour(rhs.textRunAroundContour)
{
}

159 160
KoShapePrivate::~KoShapePrivate()
{
161
    Q_Q(KoShape);
162 163 164 165 166 167 168 169 170 171

    /**
     * The shape must have already been detached from all the parents and
     * shape managers. Otherwise we migh 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!
     */
    KIS_SAFE_ASSERT_RECOVER (!parent) {
172
        parent->removeShape(q);
173 174
    }

175 176 177 178 179
    KIS_SAFE_ASSERT_RECOVER (shapeManagers.isEmpty()) {
        Q_FOREACH (KoShapeManager *manager, shapeManagers) {
            manager->shapeInterface()->notifyShapeDestructed(q);
        }
        shapeManagers.clear();
Thomas Zander's avatar
Thomas Zander committed
180
    }
181

182
    if (shadow && !shadow->deref())
183
        delete shadow;
184
    if (filterEffectStack && !filterEffectStack->deref())
185
        delete filterEffectStack;
186
}
Thomas Zander's avatar
Thomas Zander committed
187

188 189
void KoShapePrivate::shapeChanged(KoShape::ChangeType type)
{
190
    Q_Q(KoShape);
191
    if (parent)
192
        parent->model()->childChanged(q, type);
193

194
    q->shapeChanged(type);
195 196

    Q_FOREACH (KoShape * shape, dependees) {
197
        shape->shapeChanged(type, q);
198 199 200 201 202
    }

    Q_FOREACH (KoShape::ShapeChangeListener *listener, listeners) {
       listener->notifyShapeChangedImpl(type, q);
    }
203
}
204

205 206 207 208 209 210 211 212
void KoShapePrivate::addShapeManager(KoShapeManager *manager)
{
    shapeManagers.insert(manager);
}

void KoShapePrivate::removeShapeManager(KoShapeManager *manager)
{
    shapeManagers.remove(manager);
213 214
}

215
void KoShapePrivate::convertFromShapeCoordinates(KoConnectionPoint &point, const QSizeF &shapeSize) const
216
{
Jan Hambrecht's avatar
Jan Hambrecht committed
217
    switch(point.alignment) {
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
        case KoConnectionPoint::AlignNone:
            point.position = KoFlake::toRelative(point.position, shapeSize);
            point.position.rx() = qBound<qreal>(0.0, point.position.x(), 1.0);
            point.position.ry() = qBound<qreal>(0.0, point.position.y(), 1.0);
            break;
        case KoConnectionPoint::AlignRight:
            point.position.rx() -= shapeSize.width();
        case KoConnectionPoint::AlignLeft:
            point.position.ry() = 0.5*shapeSize.height();
            break;
        case KoConnectionPoint::AlignBottom:
            point.position.ry() -= shapeSize.height();
        case KoConnectionPoint::AlignTop:
            point.position.rx() = 0.5*shapeSize.width();
            break;
        case KoConnectionPoint::AlignTopLeft:
            // nothing to do here
            break;
        case KoConnectionPoint::AlignTopRight:
            point.position.rx() -= shapeSize.width();
            break;
        case KoConnectionPoint::AlignBottomLeft:
            point.position.ry() -= shapeSize.height();
            break;
        case KoConnectionPoint::AlignBottomRight:
            point.position.rx() -= shapeSize.width();
            point.position.ry() -= shapeSize.height();
            break;
        case KoConnectionPoint::AlignCenter:
            point.position.rx() -= 0.5 * shapeSize.width();
            point.position.ry() -= 0.5 * shapeSize.height();
            break;
    }
}

void KoShapePrivate::convertToShapeCoordinates(KoConnectionPoint &point, const QSizeF &shapeSize) const
{
Jan Hambrecht's avatar
Jan Hambrecht committed
255
    switch(point.alignment) {
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
        case KoConnectionPoint::AlignNone:
            point.position = KoFlake::toAbsolute(point.position, shapeSize);
            break;
        case KoConnectionPoint::AlignRight:
            point.position.rx() += shapeSize.width();
        case KoConnectionPoint::AlignLeft:
            point.position.ry() = 0.5*shapeSize.height();
            break;
        case KoConnectionPoint::AlignBottom:
            point.position.ry() += shapeSize.height();
        case KoConnectionPoint::AlignTop:
            point.position.rx() = 0.5*shapeSize.width();
            break;
        case KoConnectionPoint::AlignTopLeft:
            // nothing to do here
            break;
        case KoConnectionPoint::AlignTopRight:
            point.position.rx() += shapeSize.width();
            break;
        case KoConnectionPoint::AlignBottomLeft:
            point.position.ry() += shapeSize.height();
            break;
        case KoConnectionPoint::AlignBottomRight:
            point.position.rx() += shapeSize.width();
            point.position.ry() += shapeSize.height();
            break;
        case KoConnectionPoint::AlignCenter:
            point.position.rx() += 0.5 * shapeSize.width();
            point.position.ry() += 0.5 * shapeSize.height();
            break;
    }
287 288
}

289
// static
290
QString KoShapePrivate::getStyleProperty(const char *property, KoShapeLoadingContext &context)
291 292 293 294 295 296 297 298 299 300 301
{
    KoStyleStack &styleStack = context.odfLoadingContext().styleStack();
    QString value;

    if (styleStack.hasProperty(KoXmlNS::draw, property)) {
        value = styleStack.property(KoXmlNS::draw, property);
    }

    return value;
}

302 303


304
// ======== KoShape
Thomas Zander's avatar
Thomas Zander committed
305
KoShape::KoShape()
306
    : d_ptr(new KoShapePrivate(this))
Thomas Zander's avatar
Thomas Zander committed
307
{
308
    notifyChanged();
Thomas Zander's avatar
Thomas Zander committed
309 310
}

311 312
KoShape::KoShape(KoShapePrivate *dd)
    : d_ptr(dd)
313 314 315
{
}

Thomas Zander's avatar
Thomas Zander committed
316 317
KoShape::~KoShape()
{
318
    Q_D(KoShape);
319
    d->shapeChanged(Deleted);
320
    d->listeners.clear();
321
    delete d_ptr;
Thomas Zander's avatar
Thomas Zander committed
322 323
}

324 325
KoShape *KoShape::cloneShape() const
{
326
    KIS_SAFE_ASSERT_RECOVER_NOOP(0 && "not implemented!");
327
    qWarning() << shapeId() << "cannot be cloned";
328 329 330
    return 0;
}

331 332 333 334 335 336 337 338 339
void KoShape::paintStroke(QPainter &painter, const KoViewConverter &converter, KoShapePaintingContext &paintcontext)
{
    Q_UNUSED(paintcontext);

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

Thomas Zander's avatar
Thomas Zander committed
340
void KoShape::scale(qreal sx, qreal sy)
Thomas Zander's avatar
Thomas Zander committed
341
{
342
    Q_D(KoShape);
343
    QPointF pos = position();
344
    QTransform scaleMatrix;
345 346 347
    scaleMatrix.translate(pos.x(), pos.y());
    scaleMatrix.scale(sx, sy);
    scaleMatrix.translate(-pos.x(), -pos.y());
348
    d->localMatrix = d->localMatrix * scaleMatrix;
349

350
    notifyChanged();
351
    d->shapeChanged(ScaleChanged);
Thomas Zander's avatar
Thomas Zander committed
352 353
}

354
void KoShape::rotate(qreal angle)
Thomas Zander's avatar
Thomas Zander committed
355
{
356
    Q_D(KoShape);
357
    QPointF center = d->localMatrix.map(QPointF(0.5 * size().width(), 0.5 * size().height()));
358
    QTransform rotateMatrix;
359 360 361
    rotateMatrix.translate(center.x(), center.y());
    rotateMatrix.rotate(angle);
    rotateMatrix.translate(-center.x(), -center.y());
362
    d->localMatrix = d->localMatrix * rotateMatrix;
363

364
    notifyChanged();
365
    d->shapeChanged(RotationChanged);
Thomas Zander's avatar
Thomas Zander committed
366 367
}

Thomas Zander's avatar
Thomas Zander committed
368
void KoShape::shear(qreal sx, qreal sy)
Thomas Zander's avatar
Thomas Zander committed
369
{
370
    Q_D(KoShape);
371
    QPointF pos = position();
372
    QTransform shearMatrix;
373 374 375
    shearMatrix.translate(pos.x(), pos.y());
    shearMatrix.shear(sx, sy);
    shearMatrix.translate(-pos.x(), -pos.y());
376
    d->localMatrix = d->localMatrix * shearMatrix;
377

378
    notifyChanged();
379
    d->shapeChanged(ShearChanged);
Thomas Zander's avatar
Thomas Zander committed
380 381
}

382
void KoShape::setSize(const QSizeF &newSize)
Thomas Zander's avatar
Thomas Zander committed
383
{
384
    Q_D(KoShape);
385
    QSizeF oldSize(size());
386

387
    // always set size, as d->size and size() may vary
Thomas Zander's avatar
Thomas Zander committed
388
    d->size = newSize;
389

390 391 392
    if (oldSize == newSize)
        return;

393
    notifyChanged();
394
    d->shapeChanged(SizeChanged);
Thomas Zander's avatar
Thomas Zander committed
395 396
}

397
void KoShape::setPosition(const QPointF &newPosition)
Thomas Zander's avatar
Thomas Zander committed
398
{
399
    Q_D(KoShape);
400
    QPointF currentPos = position();
401
    if (newPosition == currentPos)
Thomas Zander's avatar
Thomas Zander committed
402
        return;
403
    QTransform translateMatrix;
404
    translateMatrix.translate(newPosition.x() - currentPos.x(), newPosition.y() - currentPos.y());
405 406 407
    d->localMatrix = d->localMatrix * translateMatrix;

    notifyChanged();
408
    d->shapeChanged(PositionChanged);
Thomas Zander's avatar
Thomas Zander committed
409 410
}

411
bool KoShape::hitTest(const QPointF &position) const
Thomas Zander's avatar
Thomas Zander committed
412
{
413
    Q_D(const KoShape);
414
    if (d->parent && d->parent->isClipped(this) && !d->parent->hitTest(position))
Thomas Zander's avatar
Thomas Zander committed
415 416
        return false;

417
    QPointF point = absoluteTransformation(0).inverted().map(position);
418 419
    QRectF bb = outlineRect();

420
    if (d->stroke) {
421
        KoInsets insets;
422
        d->stroke->strokeInsets(this, insets);
423
        bb.adjust(-insets.left, -insets.top, insets.right, insets.bottom);
424
    }
425 426 427
    if (bb.contains(point))
        return true;

428
    // if there is no shadow we can as well just leave
429
    if (! d->shadow)
430
        return false;
Thomas Zander's avatar
Thomas Zander committed
431

432 433
    // the shadow has an offset to the shape, so we simply
    // check if the position minus the shadow offset hits the shape
434
    point = absoluteTransformation(0).inverted().map(position - d->shadow->offset());
435

436
    return bb.contains(point);
Thomas Zander's avatar
Thomas Zander committed
437 438
}

439
QRectF KoShape::boundingRect() const
Thomas Zander's avatar
Thomas Zander committed
440
{
441
    Q_D(const KoShape);
Jan Hambrecht's avatar
Jan Hambrecht committed
442

443
    QTransform transform = absoluteTransformation(0);
444
    QRectF bb = outlineRect();
445
    if (d->stroke) {
446
        KoInsets insets;
447
        d->stroke->strokeInsets(this, insets);
448 449
        bb.adjust(-insets.left, -insets.top, insets.right, insets.bottom);
    }
450
    bb = transform.mapRect(bb);
451
    if (d->shadow) {
452
        KoInsets insets;
Thomas Zander's avatar
Thomas Zander committed
453
        d->shadow->insets(insets);
454 455
        bb.adjust(-insets.left, -insets.top, insets.right, insets.bottom);
    }
456
    if (d->filterEffectStack) {
457
        QRectF clipRect = d->filterEffectStack->clipRectForBoundingRect(outlineRect());
458 459
        bb |= transform.mapRect(clipRect);
    }
Thomas Zander's avatar
Thomas Zander committed
460

461
    return bb;
Thomas Zander's avatar
Thomas Zander committed
462 463
}

464 465 466 467 468 469 470 471 472
QRectF KoShape::boundingRect(const QList<KoShape *> &shapes)
{
    QRectF boundingRect;
    Q_FOREACH (KoShape *shape, shapes) {
        boundingRect |= shape->boundingRect();
    }
    return boundingRect;
}

473 474 475 476 477 478 479 480 481 482 483 484 485 486
QRectF KoShape::absoluteOutlineRect(KoViewConverter *converter) const
{
    return absoluteTransformation(converter).map(outline()).boundingRect();
}

QRectF KoShape::absoluteOutlineRect(const QList<KoShape *> &shapes, KoViewConverter *converter)
{
    QRectF absoluteOutlineRect;
    Q_FOREACH (KoShape *shape, shapes) {
        absoluteOutlineRect |= shape->absoluteOutlineRect(converter);
    }
    return absoluteOutlineRect;
}

487
QTransform KoShape::absoluteTransformation(const KoViewConverter *converter) const
488
{
489
    Q_D(const KoShape);
490
    QTransform matrix;
Thomas Zander's avatar
Thomas Zander committed
491
    // apply parents matrix to inherit any transformations done there.
492
    KoShapeContainer * container = d->parent;
493
    if (container) {
494
        if (container->inheritsTransform(this)) {
495 496 497 498
            // We do need to pass the converter here, otherwise the parent's
            // translation is not inherited.
            matrix = container->absoluteTransformation(converter);
        } else {
499 500 501 502
            QSizeF containerSize = container->size();
            QPointF containerPos = container->absolutePosition() - QPointF(0.5 * containerSize.width(), 0.5 * containerSize.height());
            if (converter)
                containerPos = converter->documentToView(containerPos);
503
            matrix.translate(containerPos.x(), containerPos.y());
Thomas Zander's avatar
Thomas Zander committed
504 505 506
        }
    }

507
    if (converter) {
508 509 510
        QPointF pos = d->localMatrix.map(QPointF());
        QPointF trans = converter->documentToView(pos) - pos;
        matrix.translate(trans.x(), trans.y());
Thomas Zander's avatar
Thomas Zander committed
511
    }
512 513

    return d->localMatrix * matrix;
Thomas Zander's avatar
Thomas Zander committed
514 515
}

516
void KoShape::applyAbsoluteTransformation(const QTransform &matrix)
517
{
518
    QTransform globalMatrix = absoluteTransformation(0);
519 520
    // the transformation is relative to the global coordinate system
    // but we want to change the local matrix, so convert the matrix
Thomas Zander's avatar
Thomas Zander committed
521
    // to be relative to the local coordinate system
522
    QTransform transformMatrix = globalMatrix * matrix * globalMatrix.inverted();
523
    applyTransformation(transformMatrix);
524 525
}

526
void KoShape::applyTransformation(const QTransform &matrix)
527
{
528
    Q_D(KoShape);
529
    d->localMatrix = matrix * d->localMatrix;
530
    notifyChanged();
531
    d->shapeChanged(GenericMatrixChange);
532 533
}

534
void KoShape::setTransformation(const QTransform &matrix)
535
{
536
    Q_D(KoShape);
537 538
    d->localMatrix = matrix;
    notifyChanged();
539
    d->shapeChanged(GenericMatrixChange);
540
}
Thomas Zander's avatar
Thomas Zander committed
541

542
QTransform KoShape::transformation() const
543
{
544
    Q_D(const KoShape);
545 546 547
    return d->localMatrix;
}

548
KoShape::ChildZOrderPolicy KoShape::childZOrderPolicy()
549
{
550
    return ChildZDefault;
551 552
}

553 554
bool KoShape::compareShapeZIndex(KoShape *s1, KoShape *s2)
{
555 556 557 558 559 560 561 562 563 564 565 566 567
    /**
     * 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
     *          coinside, the resulting painting order in Krita is
     *          **UNDEFINED**.
     *
     *          To avoid this trouble we use  KoShapeReorderCommand::mergeInShape()
     *          inside KoShapeCreateCommand.
     */

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
    // 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
607
    bool foundCommonParent = false;
608 609 610 611
    int index1 = s1->zIndex();
    int index2 = s2->zIndex();
    parentShapeS1 = s1;
    parentShapeS2 = s2;
612 613 614 615 616 617 618 619
    while (parentShapeS1 && !foundCommonParent) {
        parentShapeS2 = s2;
        index2 = parentShapeS2->zIndex();
        while (parentShapeS2) {
            if (parentShapeS2 == parentShapeS1) {
                foundCommonParent = true;
                break;
            }
620
            if (parentShapeS2->childZOrderPolicy() == KoShape::ChildZParentChild) {
621 622
                index2 = parentShapeS2->zIndex();
            }
623
            parentShapeS2 = parentShapeS2->parent();
624
        }
625 626

        if (!foundCommonParent) {
627
            if (parentShapeS1->childZOrderPolicy() == KoShape::ChildZParentChild) {
628 629
                index1 = parentShapeS1->zIndex();
            }
630
            parentShapeS1 = parentShapeS1->parent();
631 632
        }
    }
633

634 635 636 637 638 639 640 641
    // If the one shape is a parent/child of the other then sort so.
    if (s1 == parentShapeS2) {
        return true;
    }
    if (s2 == parentShapeS1) {
        return false;
    }

642
    // If we went that far then the z-Index is used for sorting.
643
    return index1 < index2;
Thomas Zander's avatar
Thomas Zander committed
644 645
}

646 647
void KoShape::setParent(KoShapeContainer *parent)
{
648
    Q_D(KoShape);
649 650

    if (d->parent == parent) {
651
        return;
652 653
    }

654 655
    KoShapeContainer *oldParent = d->parent;
    d->parent = 0; // avoids recursive removing
656 657 658 659 660 661 662

    if (oldParent) {
        oldParent->shapeInterface()->removeShape(this);
    }

    KIS_SAFE_ASSERT_RECOVER_NOOP(parent != this);

Thomas Zander's avatar
Thomas Zander committed
663
    if (parent && parent != this) {
Thomas Zander's avatar
Thomas Zander committed
664
        d->parent = parent;
665
        parent->shapeInterface()->addShape(this);
666
    }
667

668
    notifyChanged();
669
    d->shapeChanged(ParentChanged);
Thomas Zander's avatar
Thomas Zander committed
670 671
}

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
bool KoShape::inheritsTransformFromAny(const QList<KoShape *> ancestorsInQuestion) const
{
    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;
}

694 695
int KoShape::zIndex() const
{
696
    Q_D(const KoShape);
Thomas Zander's avatar
Thomas Zander committed
697
    return d->zIndex;
Thomas Zander's avatar
Thomas Zander committed
698 699
}

700 701
void KoShape::update() const
{
702
    Q_D(const KoShape);
703

704 705
    if (!d->shapeManagers.empty()) {
        QRectF rect(boundingRect());
706
        Q_FOREACH (KoShapeManager * manager, d->shapeManagers) {
Jan Hambrecht's avatar
Jan Hambrecht committed
707
            manager->update(rect, this, true);
708
        }
Thomas Zander's avatar
Thomas Zander committed
709 710 711
    }
}

712
void KoShape::updateAbsolute(const QRectF &rect) const
713
{
714 715 716 717 718

    if (rect.isEmpty() && !rect.isNull()) {
        return;
    }

719
    Q_D(const KoShape);
720

721
    if (!d->shapeManagers.empty() && isVisible()) {
722
        Q_FOREACH (KoShapeManager * manager, d->shapeManagers) {
723
            manager->update(rect);
724 725
        }
    }
Thomas Zander's avatar
Thomas Zander committed
726 727
}

728
QPainterPath KoShape::outline() const
729
{
Thomas Zander's avatar
Thomas Zander committed
730
    QPainterPath path;
731
    path.addRect(outlineRect());
Thomas Zander's avatar
Thomas Zander committed
732 733 734
    return path;
}

735 736
QRectF KoShape::outlineRect() const
{
737
    const QSizeF s = size();
738 739 740 741 742 743 744
    return QRectF(QPointF(0, 0), QSizeF(qMax(s.width(),  qreal(0.0001)),
                                        qMax(s.height(), qreal(0.0001))));
}

QPainterPath KoShape::shadowOutline() const
{
    Q_D(const KoShape);
745
    if (background()) {
746
        return outline();
747
    }
748 749

    return QPainterPath();
750 751
}

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
QPointF KoShape::absolutePosition(KoFlake::AnchorPosition anchor) const
{
    const QRectF rc = outlineRect();

    QPointF point = rc.topLeft();

    bool valid = false;
    QPointF anchoredPoint = KoFlake::anchorToPoint(anchor, rc, &valid);
    if (valid) {
        point = anchoredPoint;
    }

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

void KoShape::setAbsolutePosition(const QPointF &newPosition, KoFlake::AnchorPosition anchor)
{
    Q_D(KoShape);
    QPointF currentAbsPosition = absolutePosition(anchor);
    QPointF translate = newPosition - currentAbsPosition;
    QTransform translateMatrix;
    translateMatrix.translate(translate.x(), translate.y());
    applyAbsoluteTransformation(translateMatrix);
    notifyChanged();
    d->shapeChanged(PositionChanged);
}

779 780
void KoShape::copySettings(const KoShape *shape)
{
781
    Q_D(KoShape);
Thomas Zander's avatar
Thomas Zander committed
782 783
    d->size = shape->size();
    d->connectors.clear();
784
    Q_FOREACH (const KoConnectionPoint &point, shape->connectionPoints())
Jan Hambrecht's avatar
Jan Hambrecht committed
785
        addConnectionPoint(point);
Thomas Zander's avatar
Thomas Zander committed
786 787
    d->zIndex = shape->zIndex();
    d->visible = shape->isVisible();
788

789 790 791 792 793
    // Ensure printable is true by default
    if (!d->visible)
        d->printable = true;
    else
        d->printable = shape->isPrintable();
794

795
    d->geometryProtected = shape->isGeometryProtected();
Thomas Zander's avatar
Thomas Zander committed
796 797
    d->protectContent = shape->isContentProtected();
    d->selectable = shape->isSelectable();
Thomas Zander's avatar
Thomas Zander committed
798
    d->keepAspect = shape->keepAspectRatio();
799
    d->localMatrix = shape->d_ptr->localMatrix;
Thomas Zander's avatar
Thomas Zander committed
800 801
}

Thomas Zander's avatar
Thomas Zander committed
802
void KoShape::notifyChanged()
803
{
804
    Q_D(KoShape);
805
    Q_FOREACH (KoShapeManager * manager, d->shapeManagers) {
806
        manager->notifyShapeChanged(this);
807 808 809
    }
}

810 811
void KoShape::setUserData(KoShapeUserData *userData)
{
812
    Q_D(KoShape);
813
    d->userData.reset(userData);
814 815
}

816 817
KoShapeUserData *KoShape::userData() const
{
818
    Q_D(const KoShape);
819
    return d->userData.data();
820 821
}

Thomas Zander's avatar
Thomas Zander committed
822
bool KoShape::hasTransparency() const
823
{
Thomas Zander's avatar
Thomas Zander committed
824
    Q_D(const KoShape);
825 826 827
    QSharedPointer<KoShapeBackground> bg = background();

    return !bg || bg->hasTransparency() || d->transparency > 0.0;
828 829 830 831 832
}

void KoShape::setTransparency(qreal transparency)
{
    Q_D(KoShape);
833
    d->transparency = qBound<qreal>(0.0, transparency, 1.0);
834 835 836

    d->shapeChanged(TransparencyChanged);
    notifyChanged();
837 838 839 840 841 842 843 844 845 846 847 848
}

qreal KoShape::transparency(bool recursive) const
{
    Q_D(const KoShape);
    if (!recursive || !parent()) {
        return d->transparency;
    } else {
        const qreal parentOpacity = 1.0-parent()->transparency(recursive);
        const qreal childOpacity = 1.0-d->transparency;
        return 1.0-(parentOpacity*childOpacity);
    }
Thomas Zander's avatar
Thomas Zander committed
849 850
}

851
KoInsets KoShape::strokeInsets() const
852
{
853
    Q_D(const KoShape);
854
    KoInsets answer;
855 856
    if (d->stroke)
        d->stroke->strokeInsets(this, answer);
857 858 859
    return answer;
}

860 861
qreal KoShape::rotation() const
{
862
    Q_D(const KoShape);
863
    // try to extract the rotation angle out of the local matrix
864 865 866
    // if it is a pure rotation matrix

    // check if the matrix has shearing mixed in
867
    if (fabs(fabs(d->localMatrix.m12()) - fabs(d->localMatrix.m21())) > 1e-10)
868
        return std::numeric_limits<qreal>::quiet_NaN();
869
    // check if the matrix has scaling mixed in
870
    if (fabs(d->localMatrix.m11() - d->localMatrix.m22()) > 1e-10)
871
        return std::numeric_limits<qreal>::quiet_NaN();
872 873

    // calculate the angle from the matrix elements
874 875
    qreal angle = atan2(-d->localMatrix.m21(), d->localMatrix.m11()) * 180.0 / M_PI;
    if (angle < 0.0)
876 877 878
        angle += 360.0;

    return angle;
Thomas Zander's avatar
Thomas Zander committed
879 880
}

881
QSizeF KoShape::size() const
882
{
883
    Q_D(const KoShape);
Thomas Zander's avatar
Thomas Zander committed
884 885 886
    return d->size;
}

887 888
QPointF KoShape::position() const
{
889
    Q_D(const KoShape);
890
    QPointF center = outlineRect().center();
891
    return d->localMatrix.map(center) - center;
Thomas Zander's avatar
Thomas Zander committed
892 893
}

894
int KoShape::addConnectionPoint(const KoConnectionPoint &point)
895
{
896
    Q_D(KoShape);
897

898
    // get next glue point id
899
    int nextConnectionPointId = KoConnectionPoint::FirstCustomConnectionPoint;
Jan Hambrecht's avatar
Jan Hambrecht committed
900
    if (d->connectors.size())
901 902
        nextConnectionPointId = qMax(nextConnectionPointId, (--d->connectors.end()).key()+1);

903
    KoConnectionPoint p = point;
904 905
    d->convertFromShapeCoordinates(p, size());
    d->connectors[nextConnectionPointId] = p;
906 907 908 909

    return nextConnectionPointId;
}

910
bool KoShape::setConnectionPoint(int connectionPointId, const KoConnectionPoint &point)
911 912
{
    Q_D(KoShape);
913
    if (connectionPointId < 0)
914 915
        return false;

916 917
    const bool insertPoint = !hasConnectionPoint(connectionPointId);

918
    switch(connectionPointId) {
919 920 921 922 923 924
        case KoConnectionPoint::TopConnectionPoint:
        case KoConnectionPoint::RightConnectionPoint:
        case KoConnectionPoint::BottomConnectionPoint:
        case KoConnectionPoint::LeftConnectionPoint:
        {
            KoConnectionPoint::PointId id = static_cast<KoConnectionPoint::PointId>(connectionPointId);
925
            d->connectors[id] = KoConnectionPoint::defaultConnectionPoint(id);
926
            break;
927
        }
928
        default:
929
        {
930
            KoConnectionPoint p = point;
931 932
            d->convertFromShapeCoordinates(p, size());
            d->connectors[connectionPointId] = p;
933
            break;
934
        }
935 936
    }

937 938
    if(!insertPoint)
        d->shapeChanged(ConnectionPointChanged);
939 940 941 942

    return true;
}

943 944 945 946 947 948
bool KoShape::hasConnectionPoint(int connectionPointId) const
{
    Q_D(const KoShape);
    return d->connectors.contains(connectionPointId);
}

949
KoConnectionPoint KoShape::connectionPoint(int connectionPointId) const
950 951
{
    Q_D(const KoShape);
952
    KoConnectionPoint p = d->connectors.value(connectionPointId, KoConnectionPoint());
953
    // convert glue point to shape coordinates
954
    d->convertToShapeCoordinates(p, size());
955
    return p;
Thomas Zander's avatar
Thomas Zander committed
956 957
}

958
KoConnectionPoints KoShape::connectionPoints() const
959
{
960
    Q_D(const KoShape);
961
    QSizeF s = size();
962 963 964
    KoConnectionPoints points = d->connectors;
    KoConnectionPoints::iterator point = points.begin();
    KoConnectionPoints::iterator lastPoint = points.end();
965
    // convert glue points to shape coordinates
966
    for(; point != lastPoint; ++point) {
967
        d->convertToShapeCoordinates(point.value(), s);
968
    }
969 970

    return points;
971 972
}

973 974 975 976
void KoShape::removeConnectionPoint(int connectionPointId)
{
    Q_D(KoShape);
    d->connectors.remove(connectionPointId);
977
    d->shapeChanged(ConnectionPointChanged);
978 979 980 981 982 983 984 985
}

void KoShape::clearConnectionPoints()
{
    Q_D(KoShape);
    d->connectors.clear();
}