QGCMapPolygon.cc 15.5 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8 9 10 11
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

#include "QGCMapPolygon.h"
#include "QGCGeo.h"
12
#include "JsonHelper.h"
13
#include "QGCQGeoCoordinate.h"
DonLakeFlyer's avatar
DonLakeFlyer committed
14
#include "QGCApplication.h"
15
#include "ShapeFileHelper.h"
16 17 18

#include <QGeoRectangle>
#include <QDebug>
19
#include <QJsonArray>
20
#include <QLineF>
DonLakeFlyer's avatar
DonLakeFlyer committed
21 22
#include <QFile>
#include <QDomDocument>
23

24
const char* QGCMapPolygon::jsonPolygonKey = "polygon";
25

26 27 28 29 30 31
QGCMapPolygon::QGCMapPolygon(QObject* parent)
    : QObject               (parent)
    , _dirty                (false)
    , _centerDrag           (false)
    , _ignoreCenterUpdates  (false)
    , _interactive          (false)
Don Gagne's avatar
Don Gagne committed
32
    , _resetActive          (false)
33 34 35 36 37 38 39 40 41 42
{
    _init();
}

QGCMapPolygon::QGCMapPolygon(const QGCMapPolygon& other, QObject* parent)
    : QObject               (parent)
    , _dirty                (false)
    , _centerDrag           (false)
    , _ignoreCenterUpdates  (false)
    , _interactive          (false)
Don Gagne's avatar
Don Gagne committed
43
    , _resetActive          (false)
44 45 46 47 48 49 50
{
    *this = other;

    _init();
}

void QGCMapPolygon::_init(void)
51
{
52 53
    connect(&_polygonModel, &QmlObjectListModel::dirtyChanged, this, &QGCMapPolygon::_polygonModelDirtyChanged);
    connect(&_polygonModel, &QmlObjectListModel::countChanged, this, &QGCMapPolygon::_polygonModelCountChanged);
DonLakeFlyer's avatar
DonLakeFlyer committed
54 55 56 57

    connect(this, &QGCMapPolygon::pathChanged,  this, &QGCMapPolygon::_updateCenter);
    connect(this, &QGCMapPolygon::countChanged, this, &QGCMapPolygon::isValidChanged);
    connect(this, &QGCMapPolygon::countChanged, this, &QGCMapPolygon::isEmptyChanged);
58 59
}

60 61 62 63 64
const QGCMapPolygon& QGCMapPolygon::operator=(const QGCMapPolygon& other)
{
    clear();

    QVariantList vertices = other.path();
DonLakeFlyer's avatar
DonLakeFlyer committed
65
    QList<QGeoCoordinate> rgCoord;
66
    for (const QVariant& vertexVar: vertices) {
DonLakeFlyer's avatar
DonLakeFlyer committed
67
        rgCoord.append(vertexVar.value<QGeoCoordinate>());
68
    }
DonLakeFlyer's avatar
DonLakeFlyer committed
69
    appendVertices(rgCoord);
70 71 72 73 74 75

    setDirty(true);

    return *this;
}

76 77 78 79 80 81 82 83 84 85 86 87 88 89
void QGCMapPolygon::clear(void)
{
    // Bug workaround, see below
    while (_polygonPath.count() > 1) {
        _polygonPath.takeLast();
    }
    emit pathChanged();

    // Although this code should remove the polygon from the map it doesn't. There appears
    // to be a bug in QGCMapPolygon which causes it to not be redrawn if the list is empty. So
    // we work around it by using the code above to remove all but the last point which in turn
    // will cause the polygon to go away.
    _polygonPath.clear();

90 91
    _polygonModel.clearAndDeleteContents();

92 93
    emit cleared();

94 95 96
    setDirty(true);
}

97
void QGCMapPolygon::adjustVertex(int vertexIndex, const QGeoCoordinate coordinate)
98 99
{
    _polygonPath[vertexIndex] = QVariant::fromValue(coordinate);
100
    _polygonModel.value<QGCQGeoCoordinate*>(vertexIndex)->setCoordinate(coordinate);
DonLakeFlyer's avatar
DonLakeFlyer committed
101
    if (!_centerDrag) {
102
        // When dragging center we don't signal path changed until all vertices are updated
DonLakeFlyer's avatar
DonLakeFlyer committed
103 104
        emit pathChanged();
    }
105 106 107 108 109 110 111
    setDirty(true);
}

void QGCMapPolygon::setDirty(bool dirty)
{
    if (_dirty != dirty) {
        _dirty = dirty;
112 113 114
        if (!dirty) {
            _polygonModel.setDirty(false);
        }
115 116 117 118
        emit dirtyChanged(dirty);
    }
}

119
QGeoCoordinate QGCMapPolygon::_coordFromPointF(const QPointF& point) const
120
{
121 122 123 124 125 126
    QGeoCoordinate coord;

    if (_polygonPath.count() > 0) {
        QGeoCoordinate tangentOrigin = _polygonPath[0].value<QGeoCoordinate>();
        convertNedToGeo(-point.y(), point.x(), 0, tangentOrigin, &coord);
    }
127

128 129
    return coord;
}
130

131 132 133
QPointF QGCMapPolygon::_pointFFromCoord(const QGeoCoordinate& coordinate) const
{
    if (_polygonPath.count() > 0) {
134
        double y, x, down;
135
        QGeoCoordinate tangentOrigin = _polygonPath[0].value<QGeoCoordinate>();
136

137 138
        convertGeoToNed(coordinate, tangentOrigin, &y, &x, &down);
        return QPointF(x, -y);
139 140
    }

141 142
    return QPointF();
}
143

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
QPolygonF QGCMapPolygon::_toPolygonF(void) const
{
    QPolygonF polygon;

    if (_polygonPath.count() > 2) {
        for (int i=0; i<_polygonPath.count(); i++) {
            polygon.append(_pointFFromCoord(_polygonPath[i].value<QGeoCoordinate>()));
        }
    }

    return polygon;
}

bool QGCMapPolygon::containsCoordinate(const QGeoCoordinate& coordinate) const
{
    if (_polygonPath.count() > 2) {
        return _toPolygonF().containsPoint(_pointFFromCoord(coordinate), Qt::OddEvenFill);
    } else {
        return false;
    }
}

166 167 168
void QGCMapPolygon::setPath(const QList<QGeoCoordinate>& path)
{
    _polygonPath.clear();
169
    _polygonModel.clearAndDeleteContents();
170
    for(const QGeoCoordinate& coord: path) {
171
        _polygonPath.append(QVariant::fromValue(coord));
172
        _polygonModel.append(new QGCQGeoCoordinate(coord, this));
173
    }
174

175 176 177 178 179 180 181
    setDirty(true);
    emit pathChanged();
}

void QGCMapPolygon::setPath(const QVariantList& path)
{
    _polygonPath = path;
182 183 184

    _polygonModel.clearAndDeleteContents();
    for (int i=0; i<_polygonPath.count(); i++) {
185
        _polygonModel.append(new QGCQGeoCoordinate(_polygonPath[i].value<QGeoCoordinate>(), this));
186 187
    }

188 189 190
    setDirty(true);
    emit pathChanged();
}
191 192 193

void QGCMapPolygon::saveToJson(QJsonObject& json)
{
194
    QJsonValue jsonValue;
195

196
    JsonHelper::saveGeoCoordinateArray(_polygonPath, false /* writeAltitude*/, jsonValue);
197
    json.insert(jsonPolygonKey, jsonValue);
198 199 200 201 202 203 204 205 206
    setDirty(false);
}

bool QGCMapPolygon::loadFromJson(const QJsonObject& json, bool required, QString& errorString)
{
    errorString.clear();
    clear();

    if (required) {
207
        if (!JsonHelper::validateRequiredKeys(json, QStringList(jsonPolygonKey), errorString)) {
208 209
            return false;
        }
210
    } else if (!json.contains(jsonPolygonKey)) {
211 212 213
        return true;
    }

214
    if (!JsonHelper::loadGeoCoordinateArray(json[jsonPolygonKey], false /* altitudeRequired */, _polygonPath, errorString)) {
215 216
        return false;
    }
217 218

    for (int i=0; i<_polygonPath.count(); i++) {
219
        _polygonModel.append(new QGCQGeoCoordinate(_polygonPath[i].value<QGeoCoordinate>(), this));
220 221
    }

222
    setDirty(false);
223
    emit pathChanged();
224 225 226 227

    return true;
}

228 229 230 231
QList<QGeoCoordinate> QGCMapPolygon::coordinateList(void) const
{
    QList<QGeoCoordinate> coords;

232 233
    for (int i=0; i<_polygonPath.count(); i++) {
        coords.append(_polygonPath[i].value<QGeoCoordinate>());
234 235 236 237
    }

    return coords;
}
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

void QGCMapPolygon::splitPolygonSegment(int vertexIndex)
{
    int nextIndex = vertexIndex + 1;
    if (nextIndex > _polygonPath.length() - 1) {
        nextIndex = 0;
    }

    QGeoCoordinate firstVertex = _polygonPath[vertexIndex].value<QGeoCoordinate>();
    QGeoCoordinate nextVertex = _polygonPath[nextIndex].value<QGeoCoordinate>();

    double distance = firstVertex.distanceTo(nextVertex);
    double azimuth = firstVertex.azimuthTo(nextVertex);
    QGeoCoordinate newVertex = firstVertex.atDistanceAndAzimuth(distance / 2, azimuth);

    if (nextIndex == 0) {
        appendVertex(newVertex);
    } else {
        _polygonModel.insert(nextIndex, new QGCQGeoCoordinate(newVertex, this));
        _polygonPath.insert(nextIndex, QVariant::fromValue(newVertex));
        emit pathChanged();
    }
}

void QGCMapPolygon::appendVertex(const QGeoCoordinate& coordinate)
{
    _polygonPath.append(QVariant::fromValue(coordinate));
265
    _polygonModel.append(new QGCQGeoCoordinate(coordinate, this));
266 267 268
    emit pathChanged();
}

269 270 271 272
void QGCMapPolygon::appendVertices(const QList<QGeoCoordinate>& coordinates)
{
    QList<QObject*> objects;

Don Gagne's avatar
Don Gagne committed
273
    _beginResetIfNotActive();
274
    for (const QGeoCoordinate& coordinate: coordinates) {
275 276 277 278
        objects.append(new QGCQGeoCoordinate(coordinate, this));
        _polygonPath.append(QVariant::fromValue(coordinate));
    }
    _polygonModel.append(objects);
Don Gagne's avatar
Don Gagne committed
279 280
    _endResetIfNotActive();

281 282 283
    emit pathChanged();
}

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
void QGCMapPolygon::_polygonModelDirtyChanged(bool dirty)
{
    if (dirty) {
        setDirty(true);
    }
}

void QGCMapPolygon::removeVertex(int vertexIndex)
{
    if (vertexIndex < 0 && vertexIndex > _polygonPath.length() - 1) {
        qWarning() << "Call to removePolygonCoordinate with bad vertexIndex:count" << vertexIndex << _polygonPath.length();
        return;
    }

    if (_polygonPath.length() <= 3) {
        // Don't allow the user to trash the polygon
        return;
    }

    QObject* coordObj = _polygonModel.removeAt(vertexIndex);
    coordObj->deleteLater();

    _polygonPath.removeAt(vertexIndex);
    emit pathChanged();
}

void QGCMapPolygon::_polygonModelCountChanged(int count)
{
    emit countChanged(count);
}
314 315 316 317 318 319

void QGCMapPolygon::_updateCenter(void)
{
    if (!_ignoreCenterUpdates) {
        QGeoCoordinate center;

320
        if (_polygonPath.count() > 2) {
Don Gagne's avatar
Don Gagne committed
321 322 323 324 325 326
            QPointF centroid(0, 0);
            QPolygonF polygonF = _toPolygonF();
            for (int i=0; i<polygonF.count(); i++) {
                centroid += polygonF[i];
            }
            center = _coordFromPointF(QPointF(centroid.x() / polygonF.count(), centroid.y() / polygonF.count()));
327
        }
Don Gagne's avatar
Don Gagne committed
328 329 330 331
        if (_center != center) {
            _center = center;
            emit centerChanged(center);
        }
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
    }
}

void QGCMapPolygon::setCenter(QGeoCoordinate newCenter)
{
    if (newCenter != _center) {
        _ignoreCenterUpdates = true;

        // Adjust polygon vertices to new center
        double distance = _center.distanceTo(newCenter);
        double azimuth = _center.azimuthTo(newCenter);

        for (int i=0; i<count(); i++) {
            QGeoCoordinate oldVertex = _polygonPath[i].value<QGeoCoordinate>();
            QGeoCoordinate newVertex = oldVertex.atDistanceAndAzimuth(distance, azimuth);
            adjustVertex(i, newVertex);
        }

DonLakeFlyer's avatar
DonLakeFlyer committed
350
        if (_centerDrag) {
351
            // When center dragging, signals from adjustVertext are not sent. So we need to signal here when all adjusting is complete.
DonLakeFlyer's avatar
DonLakeFlyer committed
352 353 354
            emit pathChanged();
        }

355
        _ignoreCenterUpdates = false;
DonLakeFlyer's avatar
DonLakeFlyer committed
356 357 358 359 360 361 362 363 364 365 366

        _center = newCenter;
        emit centerChanged(newCenter);
    }
}

void QGCMapPolygon::setCenterDrag(bool centerDrag)
{
    if (centerDrag != _centerDrag) {
        _centerDrag = centerDrag;
        emit centerDragChanged(centerDrag);
367 368
    }
}
369 370 371 372 373 374 375 376

void QGCMapPolygon::setInteractive(bool interactive)
{
    if (_interactive != interactive) {
        _interactive = interactive;
        emit interactiveChanged(interactive);
    }
}
377 378 379 380 381 382

QGeoCoordinate QGCMapPolygon::vertexCoordinate(int vertex) const
{
    if (vertex >= 0 && vertex < _polygonPath.count()) {
        return _polygonPath[vertex].value<QGeoCoordinate>();
    } else {
DonLakeFlyer's avatar
DonLakeFlyer committed
383
        qWarning() << "QGCMapPolygon::vertexCoordinate bad vertex requested:count" << vertex << _polygonPath.count();
384 385 386
        return QGeoCoordinate();
    }
}
387

388
QList<QPointF> QGCMapPolygon::nedPolygon(void) const
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
{
    QList<QPointF>  nedPolygon;

    if (count() > 0) {
        QGeoCoordinate  tangentOrigin = vertexCoordinate(0);

        for (int i=0; i<_polygonModel.count(); i++) {
            double y, x, down;
            QGeoCoordinate vertex = vertexCoordinate(i);
            if (i == 0) {
                // This avoids a nan calculation that comes out of convertGeoToNed
                x = y = 0;
            } else {
                convertGeoToNed(vertex, tangentOrigin, &y, &x, &down);
            }
            nedPolygon += QPointF(x, y);
        }
    }

    return nedPolygon;
}


void QGCMapPolygon::offset(double distance)
{
    QList<QGeoCoordinate> rgNewPolygon;

    // I'm sure there is some beautiful famous algorithm to do this, but here is a brute force method

    if (count() > 2) {
        // Convert the polygon to NED
        QList<QPointF> rgNedVertices = nedPolygon();

        // Walk the edges, offsetting by the specified distance
        QList<QLineF> rgOffsetEdges;
        for (int i=0; i<rgNedVertices.count(); i++) {
            int     lastIndex = i == rgNedVertices.count() - 1 ? 0 : i + 1;
            QLineF  offsetEdge;
            QLineF  originalEdge(rgNedVertices[i], rgNedVertices[lastIndex]);

            QLineF workerLine = originalEdge;
            workerLine.setLength(distance);
            workerLine.setAngle(workerLine.angle() - 90.0);
            offsetEdge.setP1(workerLine.p2());

            workerLine.setPoints(originalEdge.p2(), originalEdge.p1());
            workerLine.setLength(distance);
            workerLine.setAngle(workerLine.angle() + 90.0);
            offsetEdge.setP2(workerLine.p2());

            rgOffsetEdges.append(offsetEdge);
        }

        // Intersect the offset edges to generate new vertices
        QPointF         newVertex;
        QGeoCoordinate  tangentOrigin = vertexCoordinate(0);
        for (int i=0; i<rgOffsetEdges.count(); i++) {
            int prevIndex = i == 0 ? rgOffsetEdges.count() - 1 : i - 1;
            if (rgOffsetEdges[prevIndex].intersect(rgOffsetEdges[i], &newVertex) == QLineF::NoIntersection) {
                // FIXME: Better error handling?
                qWarning("Intersection failed");
                return;
            }
            QGeoCoordinate coord;
            convertNedToGeo(newVertex.y(), newVertex.x(), 0, tangentOrigin, &coord);
            rgNewPolygon.append(coord);
        }
    }

    // Update internals
Don Gagne's avatar
Don Gagne committed
459
    _beginResetIfNotActive();
460
    clear();
DonLakeFlyer's avatar
DonLakeFlyer committed
461
    appendVertices(rgNewPolygon);
Don Gagne's avatar
Don Gagne committed
462
    _endResetIfNotActive();
463
}
DonLakeFlyer's avatar
DonLakeFlyer committed
464

465
bool QGCMapPolygon::loadKMLOrSHPFile(const QString& file)
DonLakeFlyer's avatar
DonLakeFlyer committed
466
{
467
    QString errorString;
DonLakeFlyer's avatar
DonLakeFlyer committed
468
    QList<QGeoCoordinate> rgCoords;
469
    if (!ShapeFileHelper::loadPolygonFromFile(file, rgCoords, errorString)) {
470 471
        qgcApp()->showMessage(errorString);
        return false;
DonLakeFlyer's avatar
DonLakeFlyer committed
472 473
    }

Don Gagne's avatar
Don Gagne committed
474
    _beginResetIfNotActive();
DonLakeFlyer's avatar
DonLakeFlyer committed
475
    clear();
476
    appendVertices(rgCoords);
Don Gagne's avatar
Don Gagne committed
477
    _endResetIfNotActive();
DonLakeFlyer's avatar
DonLakeFlyer committed
478 479 480

    return true;
}
481 482 483 484 485

double QGCMapPolygon::area(void) const
{
    // https://www.mathopenref.com/coordpolygonarea2.html

DonLakeFlyer's avatar
DonLakeFlyer committed
486 487 488 489
    if (_polygonPath.count() < 3) {
        return 0;
    }

490 491 492 493 494 495 496 497 498 499 500
    double coveredArea = 0.0;
    QList<QPointF> nedVertices = nedPolygon();
    for (int i=0; i<nedVertices.count(); i++) {
        if (i != 0) {
            coveredArea += nedVertices[i - 1].x() * nedVertices[i].y() - nedVertices[i].x() * nedVertices[i -1].y();
        } else {
            coveredArea += nedVertices.last().x() * nedVertices[i].y() - nedVertices[i].x() * nedVertices.last().y();
        }
    }
    return 0.5 * fabs(coveredArea);
}
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523

void QGCMapPolygon::verifyClockwiseWinding(void)
{
    if (_polygonPath.count() <= 2) {
        return;
    }

    double sum = 0;
    for (int i=0; i<_polygonPath.count(); i++) {
        QGeoCoordinate coord1 = _polygonPath[i].value<QGeoCoordinate>();
        QGeoCoordinate coord2 = (i == _polygonPath.count() - 1) ? _polygonPath[0].value<QGeoCoordinate>() : _polygonPath[i+1].value<QGeoCoordinate>();

        sum += (coord2.longitude() - coord1.longitude()) * (coord2.latitude() + coord1.latitude());
    }

    if (sum < 0.0) {
        // Winding is counter-clockwise and needs reversal

        QList<QGeoCoordinate> rgReversed;
        for (const QVariant& varCoord: _polygonPath) {
            rgReversed.prepend(varCoord.value<QGeoCoordinate>());
        }

Don Gagne's avatar
Don Gagne committed
524
        _beginResetIfNotActive();
525 526
        clear();
        appendVertices(rgReversed);
Don Gagne's avatar
Don Gagne committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
        _endResetIfNotActive();
    }
}

void QGCMapPolygon::beginReset(void)
{
    _resetActive = true;
    _polygonModel.beginReset();
}

void QGCMapPolygon::endReset(void)
{
    _resetActive = false;
    _polygonModel.endReset();
    emit pathChanged();
    emit centerChanged(_center);
}

void QGCMapPolygon::_beginResetIfNotActive(void)
{
    if (!_resetActive) {
        beginReset();
    }
}

void QGCMapPolygon::_endResetIfNotActive(void)
{
    if (!_resetActive) {
        endReset();
556 557
    }
}