Marble::GeoDataPolygon Class Reference

#include <GeoDataPolygon.h>

Inheritance diagram for Marble::GeoDataPolygon:

Public Member Functions
	GeoDataPolygon (TessellationFlags f=Tessellate)
	GeoDataPolygon (const GeoDataGeometry &other)
virtual	~GeoDataPolygon ()
void	appendInnerBoundary (const GeoDataLinearRing &boundary)
virtual bool	contains (const GeoDataCoordinates &coordinates) const
QVector< GeoDataLinearRing > &	innerBoundaries ()
const QVector < GeoDataLinearRing > &	innerBoundaries () const
virtual bool	isClosed () const
virtual const GeoDataLatLonAltBox &	latLonAltBox () const
GeoDataLinearRing &	outerBoundary ()
const GeoDataLinearRing &	outerBoundary () const
virtual void	pack (QDataStream &stream) const
void	setOuterBoundary (const GeoDataLinearRing &boundary)
void	setTessellate (bool tessellate)
void	setTessellationFlags (TessellationFlags f)
bool	tessellate () const
TessellationFlags	tessellationFlags () const
virtual void	unpack (QDataStream &stream)
Public Member Functions inherited from Marble::GeoDataGeometry
	GeoDataGeometry ()
	GeoDataGeometry (const GeoDataGeometry &other)
virtual	~GeoDataGeometry ()
AltitudeMode	altitudeMode () const
void	detach ()
bool	extrude () const
virtual EnumGeometryId	geometryId () const
virtual const char *	nodeType () const
GeoDataGeometry &	operator= (const GeoDataGeometry &other)
void	setAltitudeMode (const AltitudeMode altitudeMode)
void	setExtrude (bool extrude)
Public Member Functions inherited from Marble::GeoDataObject
	GeoDataObject ()
	GeoDataObject (const GeoDataObject &)
virtual	~GeoDataObject ()
int	id () const
GeoDataObject &	operator= (const GeoDataObject &)
virtual GeoDataObject *	parent () const
QString	resolvePath (const QString &relativePath) const
void	setId (int value)
virtual void	setParent (GeoDataObject *parent)
void	setTargetId (int value)
int	targetId () const
Public Member Functions inherited from Marble::GeoNode
	GeoNode ()
virtual	~GeoNode ()
Public Member Functions inherited from Marble::Serializable
virtual	~Serializable ()

Protected Member Functions
GeoDataPolygonPrivate *	p () const

Detailed Description

A polygon that can have "holes".

GeoDataPolygon is a tool class that implements the Polygon tag/class of the Open Geospatial Consortium standard KML 2.2.

GeoDataPolygon extends GeoDataGeometry to store and edit Polygons.

In the QPainter API "pure" Polygons would represent polygons with "holes" inside. However QPolygon doesn't provide this feature directly.

Whenever a Polygon is painted GeoDataLineStyle should be used to assign a color and line width.

The polygon consists of

• a single outer boundary and
• optionally a set of inner boundaries.

All boundaries are LinearRings.

The boundaries of a GeoDataPolygon consist 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.

GeoDataPolygon allows Polygons 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:

• Not tessellated: A Polygon that connects each two nodes directly and straight in screen coordinate space.
• A tessellated line: Each line segment is bent so that the Polygon follows the curvature of the earth and its terrain. A tessellated line segment connects two nodes at the shortest possible distance ("along great circles").
• 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 Polygon.

See also

GeoDataLinearRing

Definition at line 81 of file GeoDataPolygon.h.

Constructor & Destructor Documentation

Marble::GeoDataPolygon::GeoDataPolygon ( TessellationFlags  f = Tessellate )

explicit

Creates a new Polygon.

Definition at line 22 of file GeoDataPolygon.cpp.

Marble::GeoDataPolygon::GeoDataPolygon ( const GeoDataGeometry &  other )

explicit

Creates a Polygon from an existing geometry object.

Definition at line 27 of file GeoDataPolygon.cpp.

Marble::GeoDataPolygon::~GeoDataPolygon ( )

virtual

Destroys a Polygon.

Definition at line 32 of file GeoDataPolygon.cpp.

Member Function Documentation

void Marble::GeoDataPolygon::appendInnerBoundary

(

const GeoDataLinearRing &

boundary

)

Appends a given LinearRing as an inner boundary of the Polygon.

See also

GeoDataLinearRing

Definition at line 111 of file GeoDataPolygon.cpp.

bool Marble::GeoDataPolygon::contains ( const GeoDataCoordinates &  coordinates ) const

virtual

Returns whether the given coordinates lie within the polygon.

Returns

true if the coordinates lie within the polygon (and not in its holes), false otherwise.

Definition at line 158 of file GeoDataPolygon.cpp.

QVector< GeoDataLinearRing > & Marble::GeoDataPolygon::innerBoundaries

(

)

Returns a set of inner boundaries which are represented as LinearRings.

See also

GeoDataLinearRing

Definition at line 101 of file GeoDataPolygon.cpp.

const QVector< GeoDataLinearRing > & Marble::GeoDataPolygon::innerBoundaries

(

)

const

Returns a set of inner boundaries which are represented as LinearRings.

See also

GeoDataLinearRing

Definition at line 106 of file GeoDataPolygon.cpp.

bool Marble::GeoDataPolygon::isClosed ( ) const

virtual

Returns whether a Polygon is a closed polygon.

Returns

true for a Polygon.

Definition at line 44 of file GeoDataPolygon.cpp.

const GeoDataLatLonAltBox & Marble::GeoDataPolygon::latLonAltBox ( ) const

virtual

Returns the smallest latLonAltBox that contains the Polygon.

See also

GeoDataLatLonAltBox

Reimplemented from Marble::GeoDataGeometry.

Definition at line 80 of file GeoDataPolygon.cpp.

GeoDataLinearRing & Marble::GeoDataPolygon::outerBoundary

(

)

Returns the outer boundary that is represented as a LinearRing.

See also

GeoDataLinearRing

Definition at line 85 of file GeoDataPolygon.cpp.

const GeoDataLinearRing & Marble::GeoDataPolygon::outerBoundary

(

)

const

Returns the outer boundary that is represented as a LinearRing.

See also

GeoDataLinearRing

Definition at line 90 of file GeoDataPolygon.cpp.

GeoDataPolygonPrivate * Marble::GeoDataPolygon::p ( ) const

protected

Definition at line 39 of file GeoDataPolygon.cpp.

void Marble::GeoDataPolygon::pack ( QDataStream &  stream ) const

virtual

Serialize the Polygon to a stream.

Parameters

stream

the stream.

Reimplemented from Marble::GeoDataGeometry.

Definition at line 117 of file GeoDataPolygon.cpp.

void Marble::GeoDataPolygon::setOuterBoundary

(

const GeoDataLinearRing &

boundary

)

Sets the given LinearRing as an outer boundary of the Polygon.

See also

GeoDataLinearRing

Definition at line 95 of file GeoDataPolygon.cpp.

void Marble::GeoDataPolygon::setTessellate

(

bool

tessellate

)

Sets the tessellation property for the Polygon.

If tessellate is true then the Polygon's line segments are bent and follow the earth's surface and terrain along great circles. If tessellate is false then the Polygon's line segments are rendered as straight lines in screen coordinate space.

Definition at line 54 of file GeoDataPolygon.cpp.

void Marble::GeoDataPolygon::setTessellationFlags

(

TessellationFlags

f

)

Sets the given tessellation flags for a Polygon.

Definition at line 74 of file GeoDataPolygon.cpp.

bool Marble::GeoDataPolygon::tessellate

(

)

const

Returns whether the Polygon follows the earth's surface.

Returns

true if the Polygon's line segments follow the earth's surface and terrain along great circles.

Definition at line 49 of file GeoDataPolygon.cpp.

TessellationFlags Marble::GeoDataPolygon::tessellationFlags

(

)

const

Returns the tessellation flags for a Polygon.

Definition at line 69 of file GeoDataPolygon.cpp.

void Marble::GeoDataPolygon::unpack ( QDataStream &  stream )

virtual

Unserialize the Polygon from a stream.

Parameters

stream

the stream.

Reimplemented from Marble::GeoDataGeometry.

Definition at line 136 of file GeoDataPolygon.cpp.

---

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

• GeoDataPolygon.h
• GeoDataPolygon.cpp