Skip to content
Permalink
Browse files

More geometry docs

  • Loading branch information
nyalldawson committed Jun 1, 2015
1 parent df0b842 commit ded11b32562c100aeaae95bf20e21bcfc38d0777
@@ -30,6 +30,11 @@ class QgsConstWkbPtr;
class QgsWkbPtr;
class QPainter;

/**\ingroup core
* \class QgsVertexId
* \brief Utility class for identifying a unique vertex within a geometry.
* \note added in QGIS 2.10
*/
struct CORE_EXPORT QgsVertexId
{
enum VertexType
@@ -41,7 +46,11 @@ struct CORE_EXPORT QgsVertexId
QgsVertexId(): part( - 1 ), ring( -1 ), vertex( -1 ), type( SegmentVertex ) {}
QgsVertexId( int _part, int _ring, int _vertex, VertexType _type = SegmentVertex )
: part( _part ), ring( _ring ), vertex( _vertex ), type( _type ) {}

/** Returns true if the vertex id is valid
*/
bool isValid() const { return part >= 0 && ring >= 0 && vertex >= 0; }

bool operator==( const QgsVertexId& other )
{
return part == other.part && ring == other.ring && vertex == other.vertex;
@@ -57,7 +66,11 @@ struct CORE_EXPORT QgsVertexId
VertexType type;
};

/**Abstract base class for all geometries*/
/**\ingroup core
* \class QgsAbstractGeometryV2
* \brief Abstract base class for all geometries
* \note added in QGIS 2.10
*/
class CORE_EXPORT QgsAbstractGeometryV2
{
public:
@@ -66,18 +79,56 @@ class CORE_EXPORT QgsAbstractGeometryV2
QgsAbstractGeometryV2( const QgsAbstractGeometryV2& geom );
virtual QgsAbstractGeometryV2& operator=( const QgsAbstractGeometryV2& geom );

/** Clones the geometry by performing a deep copy
*/
virtual QgsAbstractGeometryV2* clone() const = 0;

/** Clears the geometry, ie reset it to a null geometry
*/
virtual void clear() = 0;

/** Returns the minimal bounding box for the geometry
*/
QgsRectangle boundingBox() const;

/** Calculates the minimal bounding box for the geometry. Derived classes should override this method
* to return the correct bounding box.
*/
virtual QgsRectangle calculateBoundingBox() const;

//mm-sql interface
/** Returns the inherent dimension of the geometry. For example, this is 0 for a point geometry,
* 1 for a linestring and 2 for a polygon.
*/
virtual int dimension() const = 0;
//virtual int coordDim() const { return mCoordDimension; }

/** Returns a unique string representing the geometry type.
* @see wkbType
* @see wktTypeStr
*/
virtual QString geometryType() const = 0;

/** Returns the WKB type of the geometry.
* @see geometryType
* @see wktTypeStr
*/
QgsWKBTypes::Type wkbType() const { return mWkbType; }

/** Returns the WKT type string of the geometry.
* @see geometryType
* @see wkbType
*/
QString wktTypeStr() const;

/** Returns true if the geometry is 3D and contains a z-value.
* @see isMeasure
*/
bool is3D() const;

/** Returns true if the geometry contains m values.
* @see is3D
*/
bool isMeasure() const;

#if 0
@@ -92,56 +143,194 @@ class CORE_EXPORT QgsAbstractGeometryV2
#endif

//import

/** Sets the geometry from a WKB string.
* @see fromWkt
*/
virtual bool fromWkb( const unsigned char * wkb ) = 0;

/** Sets the geometry from a WKT string.
* @see fromWkb
*/
virtual bool fromWkt( const QString& wkt ) = 0;

//export

/** Returns the size of the WKB representation of the geometry.
* @see asWkb
*/
virtual int wkbSize() const = 0;

/** Returns a WKB representation of the geometry.
* @param binarySize will be set to the size of the returned WKB string
* @see wkbSize
* @see asWkt
* @see asGML2
* @see asGML3
* @see asJSON
*/
virtual unsigned char* asWkb( int& binarySize ) const = 0;

/** Returns a WKT representation of the geometry.
* @param precision number of decimal places for coordinates
* @see asWkb
* @see asGML2
* @see asGML3
* @see asJSON
*/
virtual QString asWkt( int precision = 17 ) const = 0;

/** Returns a GML2 representation of the geometry.
* @param doc DOM document
* @param precision number of decimal places for coordinates
* @param ns XML namespace
* @see asWkb
* @see asWkt
* @see asGML3
* @see asJSON
*/
virtual QDomElement asGML2( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const = 0;

/** Returns a GML3 representation of the geometry.
* @param doc DOM document
* @param precision number of decimal places for coordinates
* @param ns XML namespace
* @see asWkb
* @see asWkt
* @see asGML2
* @see asJSON
*/
virtual QDomElement asGML3( QDomDocument& doc, int precision = 17, const QString& ns = "gml" ) const = 0;
virtual QString asJSON( int precision = 17 ) const = 0;

virtual QgsRectangle calculateBoundingBox() const;
/** Returns a GeoJSON representation of the geometry.
* @param precision number of decimal places for coordinates
* @see asWkb
* @see asWkt
* @see asGML2
* @see asGML3
*/
virtual QString asJSON( int precision = 17 ) const = 0;

//render pipeline

/** Transforms the geometry using a coordinate transform
* @param ct coordinate transform
*/
virtual void transform( const QgsCoordinateTransform& ct ) = 0;

/** Transforms the geometry using a QTransform object
* @param t QTransform transformation
*/
virtual void transform( const QTransform& t ) = 0;

#if 0

This comment has been minimized.

Copy link
@m-kuhn

m-kuhn Jun 1, 2015

Member

This breaks the compiler for me. It's being called from the code and there are overrides in subclasses

virtual void clip( const QgsRectangle& rect ) { Q_UNUSED( rect ); } //todo
#endif

/** Draws the geometry using the specified QPainter.
* @param p destination QPainter
*/
virtual void draw( QPainter& p ) const = 0;

/**Returns next vertex id and coordinates
@return false if at end*/
/** Returns next vertex id and coordinates
* @param id initial value should be the starting vertex id. The next vertex id will be stored
* in this variable if found.
* @param vertex container for found node
* @return false if at end
*/
virtual bool nextVertex( QgsVertexId& id, QgsPointV2& vertex ) const = 0;

/** Retrieves the sequence of geometries, rings and nodes.
* @param coord destination for coordinate sequence.
*/
virtual void coordinateSequence( QList< QList< QList< QgsPointV2 > > >& coord ) const = 0;

/** Returns the number of nodes contained in the geometry
*/
int nCoordinates() const;

/** Returns the point corresponding to a specified vertex id
*/
QgsPointV2 vertexAt( const QgsVertexId& id ) const;
virtual double closestSegment( const QgsPointV2& pt, QgsPointV2& segmentPt, QgsVertexId& vertexAfter, bool* leftOf, double epsilon ) const = 0;

/** Searches for the closest segment of the geometry to a given point.
* @param pt Specifies the point for search
* @param segmentPt storage for the closest point within the geometry
* @param vertexAfter storage for the id of the vertex after the closest segment
* @param leftOf returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right )
* @param epsilon epsilon for segment snapping
* @returns squared distance to closest segment
*/
virtual double closestSegment( const QgsPointV2& pt, QgsPointV2& segmentPt, QgsVertexId& vertexAfter, bool* leftOf, double epsilon ) const = 0;

//low-level editing

/** Inserts a vertex into the geometry
* @param position vertex id for position of inserted vertex
* @param vertex vertex to insert
* @returns true if insert was successful
* @see moveVertex
* @see deleteVertex
*/
virtual bool insertVertex( const QgsVertexId& position, const QgsPointV2& vertex ) = 0;

/** Moves a vertex within the geometry
* @param position vertex id for vertex to move
* @param newPos new position of vertex
* @returns true if move was successful
* @see insertVertex
* @see deleteVertex
*/
virtual bool moveVertex( const QgsVertexId& position, const QgsPointV2& newPos ) = 0;

/** Deletes a vertex within the geometry
* @param position vertex id for vertex to delete
* @returns true if delete was successful
* @see insertVertex
* @see moveVertex
*/
virtual bool deleteVertex( const QgsVertexId& position ) = 0;

/**Length for linear geometries,perimeter for area geometries*/
/** Returns the length (or perimeter for area geometries) of the geometry.
* @see area
*/
virtual double length() const { return 0.0; }

/** Returns the area of the geometry.
* @see length
*/
virtual double area() const { return 0.0; }

/** Returns true if the geometry is empty
*/
bool isEmpty() const;

/** Returns true if the geometry contains curved segments
*/
virtual bool hasCurvedSegments() const { return false; }
/**Returns a geometry without curves. Caller takes ownership*/

/** Returns a version of the geometry without curves. Caller takes ownership of
* the returned geometry.
*/
virtual QgsAbstractGeometryV2* segmentize() const { return clone(); }

protected:
QgsWKBTypes::Type mWkbType;
mutable QgsRectangle mBoundingBox;

/** Updates the geometry type based on whether sub geometries contain z or m values.
*/
void setZMTypeFromSubGeometry( const QgsAbstractGeometryV2* subggeom, QgsWKBTypes::Type baseGeomType );

/** Reads a WKB header and tests its validity.
* @param wkbPtr
* @param wkbType destination for WKB type from header
* @param endianSwap will be set to true if endian from WKB must be swapped to match QGIS platform endianess
* @param expectedType expected WKB type
* @returns true if header is valid and matches expected type
*/
static bool readWkbHeader( QgsConstWkbPtr& wkbPtr, QgsWKBTypes::Type& wkbType, bool& endianSwap, QgsWKBTypes::Type expectedType );

};

#endif //QGSABSTRACTGEOMETRYV2
@@ -21,6 +21,11 @@
#include "qgscurvev2.h"
#include <QVector>

/**\ingroup core
* \class QgsCircularStringV2
* \brief Circular string geometry type
* \note added in QGIS 2.10
*/
class CORE_EXPORT QgsCircularStringV2: public QgsCurveV2
{
public:
@@ -45,10 +50,15 @@ class CORE_EXPORT QgsCircularStringV2: public QgsCurveV2
QString asJSON( int precision = 17 ) const override;

int numPoints() const override;

/** Returns the point at index i within the circular string.
*/
QgsPointV2 pointN( int i ) const;
void points( QList<QgsPointV2>& pts ) const override;
void setPoints( const QList<QgsPointV2>& points );

/** Sets the circular string's points
*/
void setPoints( const QList<QgsPointV2>& points );

//curve interface
virtual double length() const override;
@@ -20,6 +20,11 @@

#include "qgscurvev2.h"

/**\ingroup core
* \class QgsCompoundCurveV2
* \brief Compound curve geometry type
* \note added in QGIS 2.10
*/
class CORE_EXPORT QgsCompoundCurveV2: public QgsCurveV2
{
public:
@@ -52,12 +57,26 @@ class CORE_EXPORT QgsCompoundCurveV2: public QgsCurveV2
virtual void points( QList<QgsPointV2>& pts ) const override;
virtual int numPoints() const override;
virtual QgsLineStringV2* curveToLine() const override;

/** Returns the number of curves in the geometry.
*/
int nCurves() const { return mCurves.size(); }

/** Returns the curve at the specified index.
*/
const QgsCurveV2* curveAt( int i ) const;

/**Adds curve (takes ownership)*/
/** Adds a curve to the geometr (takes ownership)
*/
void addCurve( QgsCurveV2* c );

/** Removes a curve from the geometry.
* @param i index of curve to remove
*/
void removeCurve( int i );

/** Adds a vertex to the end of the geometry.
*/
void addVertex( const QgsPointV2& pt );

void draw( QPainter& p ) const override;
@@ -75,7 +94,7 @@ class CORE_EXPORT QgsCompoundCurveV2: public QgsCurveV2

void sumUpArea( double& sum ) const override;

/**Appends first point if not already closed*/
/** Appends first point if not already closed.*/
void close();

bool hasCurvedSegments() const override;
@@ -22,6 +22,11 @@

class QgsPolygonV2;

/**\ingroup core
* \class QgsCurvePolygonV2
* \brief Curve polygon geometry type
* \note added in QGIS 2.10
*/
class CORE_EXPORT QgsCurvePolygonV2: public QgsSurfaceV2
{
public:
@@ -62,8 +67,9 @@ class CORE_EXPORT QgsCurvePolygonV2: public QgsSurfaceV2

/**Sets exterior ring (takes ownership)*/
void setExteriorRing( QgsCurveV2* ring );
/**Sets interior rings (takes ownership)*/
/**Sets all interior rings (takes ownership)*/
void setInteriorRings( QList<QgsCurveV2*> rings );
/**Adds an interior ring to the geometry (takes ownership)*/
void addInteriorRing( QgsCurveV2* ring );
/**Removes ring. Exterior ring is 0, first interior ring 1, ...*/
bool removeInteriorRing( int nr );

0 comments on commit ded11b3

Please sign in to comment.
You can’t perform that action at this time.