/usr/include/marble/GeoDataLinearRing.h is in libmarble-dev 4:17.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | //
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2008 Torsten Rahn <tackat@kde.org>
//
#ifndef MARBLE_GEODATALINEARRING_H
#define MARBLE_GEODATALINEARRING_H
#include "geodata_export.h"
#include "GeoDataLineString.h"
namespace Marble
{
class GeoDataLinearRingPrivate;
/*!
\class GeoDataLinearRing
\brief A LinearRing that allows to store a closed, contiguous set of line segments.
GeoDataLinearRing is a tool class that implements the LinearRing tag/class
of the Open Geospatial Consortium standard KML 2.2.
Unlike suggested in the KML spec GeoDataLinearRing extends GeoDataLineString
to store a closed LineString (the KML specification suggests to inherit from
the Geometry class directly).
In the QPainter API LinearRings are also referred to as "polygons".
As such they are similar to QPolygons.
Whenever a LinearRing is painted GeoDataLineStyle should be used to assign a
color and line width.
A GeoDataLinearRing consists of several (geodetic) nodes which are each
connected through line segments. The nodes are stored as GeoDataCoordinates
objects.
The API which provides access to the nodes is similar to the API of
QVector.
GeoDataLinearRing allows LinearRings to be tessellated in order to make them
follow the terrain and the curvature of the earth. The tessellation options
allow for different ways of visualization:
\li Not tessellated: A LinearRing that connects each two nodes directly and
straight in screen coordinate space.
\li A tessellated line: Each line segment is bent so that the LinearRing
follows the curvature of the earth and its terrain. A tessellated
line segment connects two nodes at the shortest possible distance
("along great circles").
\li A tessellated line that follows latitude circles whenever possible:
In this case Latitude circles are followed as soon as two subsequent
nodes have exactly the same amount of latitude. In all other places the
line segments follow great circles.
Some convenience methods have been added that allow to calculate the
geodesic bounding box or the length of a LinearRing.
*/
class GEODATA_EXPORT GeoDataLinearRing : public GeoDataLineString
{
public:
/*!
\brief Creates a new LinearRing.
*/
explicit GeoDataLinearRing( TessellationFlags f = NoTessellation);
/*!
\brief Creates a LinearRing from an existing geometry object.
*/
explicit GeoDataLinearRing(const GeoDataGeometry &other);
/*!
\brief Destroys a LinearRing.
*/
~GeoDataLinearRing() override;
const char *nodeType() const override;
EnumGeometryId geometryId() const override;
GeoDataGeometry *copy() const override;
/*!
\brief Returns true/false depending on whether this and other are/are not equal.
*/
bool operator==( const GeoDataLinearRing &other ) const;
bool operator!=( const GeoDataLinearRing &other ) const;
/*!
\brief Returns whether a LinearRing is a closed polygon.
\return <code>true</code> for a LinearRing.
*/
bool isClosed() const override;
/*!
\brief Returns the length of the LinearRing across a sphere.
As a parameter the \a planetRadius needs to be passed.
\return The return value is the length of the LinearRing.
The unit used for the resulting length matches the unit of the planet
radius.
This method can be used as an approximation for the circumference of a
LinearRing.
*/
qreal length( qreal planetRadius, int offset = 0 ) const override;
/*!
\brief Returns whether the given coordinates lie within the polygon.
\return <code>true</code> if the coordinates lie within the polygon, false otherwise.
*/
virtual bool contains( const GeoDataCoordinates &coordinates ) const;
/*!
* \brief Returns whether the orientaion of ring is coloskwise or not
* \return Return value is true if ring is clockwise orientated
*/
virtual bool isClockwise() const;
};
}
#endif
|