| 
    QGIS API Documentation
    2.18.21-Las Palmas (9fba24a)
    
   | 
 
Point geometry type, with support for z-dimension and m-values. More...
#include <qgspointv2.h>

Public Member Functions | |
| QgsPointV2 (double x=0.0, double y=0.0) | |
| Construct a 2 dimensional point with an initial x and y coordinate.  More... | |
| QgsPointV2 (const QgsPoint &p) | |
| Construct a QgsPointV2 from a QgsPoint object.  More... | |
| QgsPointV2 (QPointF p) | |
| Construct a QgsPointV2 from a QPointF.  More... | |
| QgsPointV2 (QgsWKBTypes::Type type, double x=0.0, double y=0.0, double z=0.0, double m=0.0) | |
| Construct a point with a specified type (eg PointZ, PointM) and initial x, y, z, and m values.  More... | |
| virtual bool | addMValue (double mValue=0) override | 
| Adds a measure to the geometry, initialized to a preset value.  More... | |
| virtual bool | addZValue (double zValue=0) override | 
| Adds a z-dimension to the geometry, initialized to a preset value.  More... | |
| QDomElement | asGML2 (QDomDocument &doc, int precision=17, const QString &ns="gml") const override | 
| Returns a GML2 representation of the geometry.  More... | |
| QDomElement | asGML3 (QDomDocument &doc, int precision=17, const QString &ns="gml") const override | 
| Returns a GML3 representation of the geometry.  More... | |
| QString | asJSON (int precision=17) const override | 
| Returns a GeoJSON representation of the geometry.  More... | |
| unsigned char * | asWkb (int &binarySize) const override | 
| Returns a WKB representation of the geometry.  More... | |
| QString | asWkt (int precision=17) const override | 
| Returns a WKT representation of the geometry.  More... | |
| virtual QgsAbstractGeometryV2 * | boundary () const override | 
| Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).  More... | |
| virtual QgsRectangle | boundingBox () const override | 
| Returns the minimal bounding box for the geometry.  More... | |
| void | clear () override | 
| Clears the geometry, ie reset it to a null geometry.  More... | |
| virtual QgsPointV2 * | clone () const override | 
| Clones the geometry by performing a deep copy.  More... | |
| double | closestSegment (const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon) const override | 
| Searches for the closest segment of the geometry to a given point.  More... | |
| bool | convertTo (QgsWKBTypes::Type type) override | 
| Converts the geometry to a specified type.  More... | |
| virtual QgsCoordinateSequenceV2 | coordinateSequence () const override | 
| Retrieves the sequence of geometries, rings and nodes.  More... | |
| virtual bool | deleteVertex (QgsVertexId position) override | 
| Deletes a vertex within the geometry.  More... | |
| virtual int | dimension () const override | 
| Returns the inherent dimension of the geometry.  More... | |
| void | draw (QPainter &p) const override | 
| Draws the geometry using the specified QPainter.  More... | |
| virtual bool | dropMValue () override | 
| Drops any measure values which exist in the geometry.  More... | |
| virtual bool | dropZValue () override | 
| Drops any z-dimensions which exist in the geometry.  More... | |
| virtual bool | fromWkb (QgsConstWkbPtr wkb) override | 
| Sets the geometry from a WKB string.  More... | |
| virtual bool | fromWkt (const QString &wkt) override | 
| Sets the geometry from a WKT string.  More... | |
| virtual QString | geometryType () const override | 
| Returns a unique string representing the geometry type.  More... | |
| virtual bool | insertVertex (QgsVertexId position, const QgsPointV2 &vertex) override | 
| Inserts a vertex into the geometry.  More... | |
| double | m () const | 
| Returns the point's m value.  More... | |
| virtual bool | moveVertex (QgsVertexId position, const QgsPointV2 &newPos) override | 
| Moves a vertex within the geometry.  More... | |
| virtual int | nCoordinates () const override | 
| Returns the number of nodes contained in the geometry.  More... | |
| bool | nextVertex (QgsVertexId &id, QgsPointV2 &vertex) const override | 
| Returns next vertex id and coordinates.  More... | |
| bool | operator!= (const QgsPointV2 &pt) const | 
| bool | operator== (const QgsPointV2 &pt) const | 
| virtual int | partCount () const override | 
| Returns count of parts contained in the geometry.  More... | |
| virtual int | ringCount (int=0) const override | 
| double & | rm () | 
| Returns a reference to the m value of this point.  More... | |
| double & | rx () | 
| Returns a reference to the x-coordinate of this point.  More... | |
| double & | ry () | 
| Returns a reference to the y-coordinate of this point.  More... | |
| double & | rz () | 
| Returns a reference to the z-coordinate of this point.  More... | |
| void | setM (double m) | 
| Sets the point's m-value.  More... | |
| void | setX (double x) | 
| Sets the point's x-coordinate.  More... | |
| void | setY (double y) | 
| Sets the point's y-coordinate.  More... | |
| void | setZ (double z) | 
| Sets the point's z-coordinate.  More... | |
| QPointF | toQPointF () const | 
| Returns the point as a QPointF.  More... | |
| void | transform (const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false) override | 
| Transforms the geometry using a coordinate transform.  More... | |
| void | transform (const QTransform &t) override | 
| Transforms the geometry using a QTransform object.  More... | |
| double | vertexAngle (QgsVertexId vertex) const override | 
| Angle undefined.  More... | |
| virtual QgsPointV2 | vertexAt (QgsVertexId) const override | 
| Returns the point corresponding to a specified vertex id.  More... | |
| virtual int | vertexCount (int=0, int=0) const override | 
| int | wkbSize () const override | 
| Returns the size of the WKB representation of the geometry.  More... | |
| double | x () const | 
| Returns the point's x-coordinate.  More... | |
| double | y () const | 
| Returns the point's y-coordinate.  More... | |
| double | z () const | 
| Returns the point's z-coordinate.  More... | |
  Public Member Functions inherited from QgsAbstractGeometryV2 | |
| QgsAbstractGeometryV2 () | |
| QgsAbstractGeometryV2 (const QgsAbstractGeometryV2 &geom) | |
| virtual | ~QgsAbstractGeometryV2 () | 
| virtual double | area () const | 
| Returns the area of the geometry.  More... | |
| virtual QgsPointV2 | centroid () const | 
| Returns the centroid of the geometry.  More... | |
| virtual bool | hasCurvedSegments () const | 
| Returns true if the geometry contains curved segments.  More... | |
| bool | is3D () const | 
| Returns true if the geometry is 3D and contains a z-value.  More... | |
| bool | isEmpty () const | 
| Returns true if the geometry is empty.  More... | |
| bool | isMeasure () const | 
| Returns true if the geometry contains m values.  More... | |
| virtual double | length () const | 
| Returns the length of the geometry.  More... | |
| virtual QgsAbstractGeometryV2 & | operator= (const QgsAbstractGeometryV2 &geom) | 
| virtual double | perimeter () const | 
| Returns the perimeter of the geometry.  More... | |
| virtual QgsAbstractGeometryV2 * | segmentize (double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const | 
| Returns a version of the geometry without curves.  More... | |
| virtual QgsAbstractGeometryV2 * | toCurveType () const | 
| Returns the geometry converted to the more generic curve type.  More... | |
| QgsWKBTypes::Type | wkbType () const | 
| Returns the WKB type of the geometry.  More... | |
| QString | wktTypeStr () const | 
| Returns the WKT type string of the geometry.  More... | |
Additional Inherited Members | |
  Public Types inherited from QgsAbstractGeometryV2 | |
| enum | SegmentationToleranceType { MaximumAngle = 0, MaximumDifference } | 
| Segmentation tolerance as maximum angle or maximum difference between approximation and circle.  More... | |
  Protected Member Functions inherited from QgsAbstractGeometryV2 | |
| virtual QgsRectangle | calculateBoundingBox () const | 
| Default calculator for the minimal bounding box for the geometry.  More... | |
| virtual void | clearCache () const | 
| Clears any cached parameters associated with the geometry, eg bounding boxes.  More... | |
| void | setZMTypeFromSubGeometry (const QgsAbstractGeometryV2 *subggeom, QgsWKBTypes::Type baseGeomType) | 
| Updates the geometry type based on whether sub geometries contain z or m values.  More... | |
  Protected Attributes inherited from QgsAbstractGeometryV2 | |
| QgsWKBTypes::Type | mWkbType | 
Point geometry type, with support for z-dimension and m-values.
Definition at line 34 of file qgspointv2.h.
| QgsPointV2::QgsPointV2 | ( | double | x = 0.0,  | 
        
| double | y = 0.0  | 
        ||
| ) | 
Construct a 2 dimensional point with an initial x and y coordinate.
| x | x-coordinate of point | 
| y | y-coordinate of point | 
Definition at line 33 of file qgspointv2.cpp.
      
  | 
  explicit | 
Construct a QgsPointV2 from a QgsPoint object.
Definition at line 43 of file qgspointv2.cpp.
      
  | 
  explicit | 
Construct a QgsPointV2 from a QPointF.
Definition at line 53 of file qgspointv2.cpp.
| QgsPointV2::QgsPointV2 | ( | QgsWKBTypes::Type | type, | 
| double | x = 0.0,  | 
        ||
| double | y = 0.0,  | 
        ||
| double | z = 0.0,  | 
        ||
| double | m = 0.0  | 
        ||
| ) | 
Construct a point with a specified type (eg PointZ, PointM) and initial x, y, z, and m values.
| type | point type | 
| x | x-coordinate of point | 
| y | y-coordinate of point | 
| z | z-coordinate of point, for PointZ or PointZM types | 
| m | m-value of point, for PointM or PointZM types | 
Definition at line 63 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Adds a measure to the geometry, initialized to a preset value.
| mValue | initial m-value for all nodes | 
Implements QgsAbstractGeometryV2.
Definition at line 370 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Adds a z-dimension to the geometry, initialized to a preset value.
| zValue | initial z-value for all nodes | 
Implements QgsAbstractGeometryV2.
Definition at line 359 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Returns a GML2 representation of the geometry.
| doc | DOM document | 
| precision | number of decimal places for coordinates | 
| ns | XML namespace | 
Implements QgsAbstractGeometryV2.
Definition at line 212 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Returns a GML3 representation of the geometry.
| doc | DOM document | 
| precision | number of decimal places for coordinates | 
| ns | XML namespace | 
Implements QgsAbstractGeometryV2.
Definition at line 231 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Returns a GeoJSON representation of the geometry.
| precision | number of decimal places for coordinates | 
Implements QgsAbstractGeometryV2.
Definition at line 251 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Returns a WKB representation of the geometry.
| binarySize | will be set to the size of the returned WKB string | 
Implements QgsAbstractGeometryV2.
Definition at line 181 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Returns a WKT representation of the geometry.
| precision | number of decimal places for coordinates | 
Implements QgsAbstractGeometryV2.
Definition at line 200 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
Implements QgsAbstractGeometryV2.
Definition at line 293 of file qgspointv2.cpp.
      
  | 
  inlineoverridevirtual | 
Returns the minimal bounding box for the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 154 of file qgspointv2.h.
      
  | 
  overridevirtual | 
Clears the geometry, ie reset it to a null geometry.
Implements QgsAbstractGeometryV2.
Definition at line 263 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Clones the geometry by performing a deep copy.
Implements QgsAbstractGeometryV2.
Definition at line 94 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Searches for the closest segment of the geometry to a given point.
| pt | specifies the point to find closest segment to | 
| segmentPt | storage for the closest point within the geometry | 
| vertexAfter | storage for the ID of the vertex at the end of the closest segment | 
| leftOf | returns whether the point lies on the left side of the nearest segment (true if point is to left of segment, false if point is to right of segment) | 
| epsilon | epsilon for segment snapping | 
Implements QgsAbstractGeometryV2.
Definition at line 321 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Converts the geometry to a specified type.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 413 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Retrieves the sequence of geometries, rings and nodes.
Implements QgsAbstractGeometryV2.
Definition at line 283 of file qgspointv2.cpp.
      
  | 
  inlineoverridevirtual | 
Deletes a vertex within the geometry.
| position | vertex id for vertex to delete | 
Implements QgsAbstractGeometryV2.
Definition at line 178 of file qgspointv2.h.
      
  | 
  inlineoverridevirtual | 
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.
Implements QgsAbstractGeometryV2.
Definition at line 156 of file qgspointv2.h.
      
  | 
  overridevirtual | 
Draws the geometry using the specified QPainter.
| p | destination QPainter | 
Implements QgsAbstractGeometryV2.
Definition at line 258 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Drops any measure values which exist in the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 402 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Drops any z-dimensions which exist in the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 391 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Sets the geometry from a WKB string.
Implements QgsAbstractGeometryV2.
Definition at line 99 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Sets the geometry from a WKT string.
Implements QgsAbstractGeometryV2.
Definition at line 127 of file qgspointv2.cpp.
      
  | 
  inlineoverridevirtual | 
Returns a unique string representing the geometry type.
Implements QgsAbstractGeometryV2.
Definition at line 155 of file qgspointv2.h.
      
  | 
  inlineoverridevirtual | 
Inserts a vertex into the geometry.
| position | vertex id for position of inserted vertex | 
| vertex | vertex to insert | 
Implements QgsAbstractGeometryV2.
Definition at line 176 of file qgspointv2.h.
      
  | 
  inline | 
      
  | 
  overridevirtual | 
Moves a vertex within the geometry.
| position | vertex id for vertex to move | 
| newPos | new position of vertex | 
Implements QgsAbstractGeometryV2.
Definition at line 304 of file qgspointv2.cpp.
      
  | 
  inlineoverridevirtual | 
Returns the number of nodes contained in the geometry.
Reimplemented from QgsAbstractGeometryV2.
Definition at line 172 of file qgspointv2.h.
      
  | 
  overridevirtual | 
Returns next vertex id and coordinates.
| id | initial value should be the starting vertex id. The next vertex id will be stored in this variable if found. | 
| vertex | container for found node | 
Implements QgsAbstractGeometryV2.
Definition at line 331 of file qgspointv2.cpp.
| bool QgsPointV2::operator!= | ( | const QgsPointV2 & | pt | ) | const | 
Definition at line 89 of file qgspointv2.cpp.
| bool QgsPointV2::operator== | ( | const QgsPointV2 & | pt | ) | const | 
Definition at line 80 of file qgspointv2.cpp.
      
  | 
  inlineoverridevirtual | 
Returns count of parts contained in the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 190 of file qgspointv2.h.
      
  | 
  inlineoverridevirtual | 
Implements QgsAbstractGeometryV2.
Definition at line 189 of file qgspointv2.h.
      
  | 
  inline | 
Returns a reference to the m value of this point.
Using a reference makes it possible to directly manipulate m in place.
Definition at line 118 of file qgspointv2.h.
      
  | 
  inline | 
Returns a reference to the x-coordinate of this point.
Using a reference makes it possible to directly manipulate x in place.
Definition at line 94 of file qgspointv2.h.
      
  | 
  inline | 
Returns a reference to the y-coordinate of this point.
Using a reference makes it possible to directly manipulate y in place.
Definition at line 102 of file qgspointv2.h.
      
  | 
  inline | 
Returns a reference to the z-coordinate of this point.
Using a reference makes it possible to directly manipulate z in place.
Definition at line 110 of file qgspointv2.h.
      
  | 
  inline | 
Sets the point's m-value.
Definition at line 146 of file qgspointv2.h.
      
  | 
  inline | 
      
  | 
  inline | 
      
  | 
  inline | 
Sets the point's z-coordinate.
Definition at line 138 of file qgspointv2.h.
| QPointF QgsPointV2::toQPointF | ( | ) | const | 
Returns the point as a QPointF.
Definition at line 447 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Transforms the geometry using a coordinate transform.
| ct | coordinate transform | 
| d | transformation direction | 
| transformZ | set to true to also transform z coordinates. This requires that the z coordinates in the geometry represent height relative to the vertical datum of the source CRS (generally ellipsoidal heights) and are expressed in its vertical units (generally meters). If false, then z coordinates will not be changed by the transform. | 
Implements QgsAbstractGeometryV2.
Definition at line 269 of file qgspointv2.cpp.
      
  | 
  overridevirtual | 
Transforms the geometry using a QTransform object.
| t | QTransform transformation | 
Implements QgsAbstractGeometryV2.
Definition at line 381 of file qgspointv2.cpp.
      
  | 
  inlineoverridevirtual | 
Angle undefined.
Always returns 0.0
| vertex | the vertex id | 
Implements QgsAbstractGeometryV2.
Definition at line 186 of file qgspointv2.h.
      
  | 
  inlineoverridevirtual | 
Returns the point corresponding to a specified vertex id.
Implements QgsAbstractGeometryV2.
Definition at line 191 of file qgspointv2.h.
      
  | 
  inlineoverridevirtual | 
Implements QgsAbstractGeometryV2.
Definition at line 188 of file qgspointv2.h.
      
  | 
  overridevirtual | 
Returns the size of the WKB representation of the geometry.
Implements QgsAbstractGeometryV2.
Definition at line 168 of file qgspointv2.cpp.
      
  | 
  inline | 
      
  | 
  inline | 
      
  | 
  inline | 
 1.8.13