QGIS API Documentation  3.13.0-Master (13337b20cd)
Triangulation Class Referenceabstract

Interface for Triangulation classes. More...

`#include <Triangulation.h>`

Inheritance diagram for Triangulation:
[legend]

## Public Types

enum  ForcedCrossBehavior { SnappingTypeVertex, DeleteFirst, InsertVertex }
Enumeration describing the behavior, if two forced lines cross. More...

## Public Member Functions

virtual ~Triangulation ()=default

virtual void addLine (const QVector< QgsPoint > &points, QgsInterpolator::SourceType lineType)=0

virtual int addPoint (const QgsPoint &point)=0
Adds a point to the triangulation. More...

virtual bool calcNormal (double x, double y, Vector3D *result)=0
Calculates the normal at a point on the surface and assigns it to 'result'. More...

virtual bool calcPoint (double x, double y, QgsPoint &result)=0
Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. More...

virtual void eliminateHorizontalTriangles ()=0
Eliminates the horizontal triangles by swapping. More...

virtual int getNumberOfPoints () const =0
Returns the number of points. More...

virtual int getOppositePoint (int p1, int p2)=0
Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge). More...

virtual QgsPointgetPoint (int i) const =0
Returns a pointer to the point with number i. Any virtual points must have the number -1. More...

virtual QList< int > * getPointsAroundEdge (double x, double y)=0
Returns a value list with the numbers of the four points, which would be affected by an edge swap. More...

virtual QList< int > getSurroundingTriangles (int pointno)=0
Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. More...

virtual bool getTriangle (double x, double y, QgsPoint &p1, int &n1, QgsPoint &p2, int &n2, QgsPoint &p3, int &n3)=0
Finds out in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'. More...

virtual bool getTriangle (double x, double y, QgsPoint &p1, QgsPoint &p2, QgsPoint &p3)=0
Finds out, in which triangle the point with coordinates x and y is and assigns the points at the vertices to 'p1', 'p2' and 'p3. More...

virtual double getXMax () const =0
Returns the largest x-coordinate value of the bounding box. More...

virtual double getXMin () const =0
Returns the smallest x-coordinate value of the bounding box. More...

virtual double getYMax () const =0
Returns the largest y-coordinate value of the bounding box. More...

virtual double getYMin () const =0
Returns the smallest x-coordinate value of the bounding box. More...

virtual void performConsistencyTest ()=0
Performs a consistency check, remove this later. More...

virtual bool pointInside (double x, double y)=0
Returns `true`, if the point with coordinates x and y is inside the convex hull and `false` otherwise. More...

virtual void ruppertRefinement ()=0
Adds points to make the triangles better shaped (algorithm of ruppert) More...

virtual bool saveTriangulation (QgsFeatureSink *sink, QgsFeedback *feedback=nullptr) const =0
Saves the triangulation features to a feature sink. More...

virtual void setBreakEdgeColor (int r, int g, int b)=0
Sets the color of the breaklines. More...

virtual void setEdgeColor (int r, int g, int b)=0
Sets the color of the normal edges. More...

virtual void setForcedCrossBehavior (Triangulation::ForcedCrossBehavior b)=0
Draws the points, edges and the forced lines. More...

virtual void setForcedEdgeColor (int r, int g, int b)=0
Sets the color of the forced edges. More...

virtual void setTriangleInterpolator (TriangleInterpolator *interpolator)=0
Sets an interpolator object. More...

virtual bool swapEdge (double x, double y)=0
Reads the content of a taff-file. More...

## Static Public Member Functions

static QgsFields triangulationFields ()
Returns the fields output by features when calling saveTriangulation(). More...

## Detailed Description

Interface for Triangulation classes.

Note
Not available in Python bindings.

Definition at line 38 of file Triangulation.h.

## ◆ ForcedCrossBehavior

Enumeration describing the behavior, if two forced lines cross.

Enumerator
SnappingTypeVertex

The second inserted forced line is snapped to the closest vertice of the first inserted forced line.

DeleteFirst

The status of the first inserted forced line is reset to that of a normal edge (so that the second inserted forced line remain and the first not)

InsertVertex

Definition at line 42 of file Triangulation.h.

## ◆ ~Triangulation()

 virtual Triangulation::~Triangulation ( )
virtualdefault

## Member Function Documentation

 virtual void Triangulation::addLine ( const QVector< QgsPoint > & points, QgsInterpolator::SourceType lineType )
pure virtual

a break-, structure- or an isoline) to the triangulation, by specifying a list of source points.

Implemented in DualEdgeTriangulation, and TriDecorator.

 virtual int Triangulation::addPoint ( const QgsPoint & point )
pure virtual

Adds a point to the triangulation.

The point should have a z-value matching the value to interpolate.

Implemented in DualEdgeTriangulation, NormVecDecorator, and TriDecorator.

## ◆ calcNormal()

 virtual bool Triangulation::calcNormal ( double x, double y, Vector3D * result )
pure virtual

Calculates the normal at a point on the surface and assigns it to 'result'.

Returns
`true` in case of success and `false` in case of failure

Implemented in DualEdgeTriangulation, NormVecDecorator, and TriDecorator.

## ◆ calcPoint()

 virtual bool Triangulation::calcPoint ( double x, double y, QgsPoint & result )
pure virtual

Calculates x-, y and z-value of the point on the surface and assigns it to 'result'.

Returns `true` in case of success and `false` in case of failure

Implemented in DualEdgeTriangulation, NormVecDecorator, and TriDecorator.

## ◆ eliminateHorizontalTriangles()

 virtual void Triangulation::eliminateHorizontalTriangles ( )
pure virtual

Eliminates the horizontal triangles by swapping.

Implemented in DualEdgeTriangulation, TriDecorator, and NormVecDecorator.

## ◆ getNumberOfPoints()

 virtual int Triangulation::getNumberOfPoints ( ) const
pure virtual

Returns the number of points.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getOppositePoint()

 virtual int Triangulation::getOppositePoint ( int p1, int p2 )
pure virtual

Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge).

Returns -1 if point is a virtual point. Returns -10 if point crosses over edges.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getPoint()

 virtual QgsPoint* Triangulation::getPoint ( int i ) const
pure virtual

Returns a pointer to the point with number i. Any virtual points must have the number -1.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getPointsAroundEdge()

 virtual QList* Triangulation::getPointsAroundEdge ( double x, double y )
pure virtual

Returns a value list with the numbers of the four points, which would be affected by an edge swap.

This function is e.g. needed by NormVecDecorator to know the points, for which the normals have to be recalculated. The list has to be deleted by the code which calls this method

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getSurroundingTriangles()

 virtual QList Triangulation::getSurroundingTriangles ( int pointno )
pure virtual

Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point.

Four integer values describe a triangle, the first three are the number of the half edges of the triangle and the fourth is -10, if the third (and most counterclockwise) edge is a breakline, and -20 otherwise. Any virtual point needs to have the number -1

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getTriangle() [1/2]

 virtual bool Triangulation::getTriangle ( double x, double y, QgsPoint & p1, int & n1, QgsPoint & p2, int & n2, QgsPoint & p3, int & n3 )
pure virtual

Finds out in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getTriangle() [2/2]

 virtual bool Triangulation::getTriangle ( double x, double y, QgsPoint & p1, QgsPoint & p2, QgsPoint & p3 )
pure virtual

Finds out, in which triangle the point with coordinates x and y is and assigns the points at the vertices to 'p1', 'p2' and 'p3.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getXMax()

 virtual double Triangulation::getXMax ( ) const
pure virtual

Returns the largest x-coordinate value of the bounding box.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getXMin()

 virtual double Triangulation::getXMin ( ) const
pure virtual

Returns the smallest x-coordinate value of the bounding box.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getYMax()

 virtual double Triangulation::getYMax ( ) const
pure virtual

Returns the largest y-coordinate value of the bounding box.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ getYMin()

 virtual double Triangulation::getYMin ( ) const
pure virtual

Returns the smallest x-coordinate value of the bounding box.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ performConsistencyTest()

 virtual void Triangulation::performConsistencyTest ( )
pure virtual

Performs a consistency check, remove this later.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ pointInside()

 virtual bool Triangulation::pointInside ( double x, double y )
pure virtual

Returns `true`, if the point with coordinates x and y is inside the convex hull and `false` otherwise.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ ruppertRefinement()

 virtual void Triangulation::ruppertRefinement ( )
pure virtual

Adds points to make the triangles better shaped (algorithm of ruppert)

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ saveTriangulation()

 virtual bool Triangulation::saveTriangulation ( QgsFeatureSink * sink, QgsFeedback * feedback = `nullptr` ) const
pure virtual

Saves the triangulation features to a feature sink.

The sink must be setup to accept LineString features, with fields matching those returned by triangulationFields().

Returns
`true` in case of success
triangulationFields()
Since
QGIS 3.0

Implemented in DualEdgeTriangulation, and NormVecDecorator.

## ◆ setBreakEdgeColor()

 virtual void Triangulation::setBreakEdgeColor ( int r, int g, int b )
pure virtual

Sets the color of the breaklines.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ setEdgeColor()

 virtual void Triangulation::setEdgeColor ( int r, int g, int b )
pure virtual

Sets the color of the normal edges.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ setForcedCrossBehavior()

 virtual void Triangulation::setForcedCrossBehavior ( Triangulation::ForcedCrossBehavior b )
pure virtual

Draws the points, edges and the forced lines.

Sets the behavior of the triangulation in case of crossing forced lines

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ setForcedEdgeColor()

 virtual void Triangulation::setForcedEdgeColor ( int r, int g, int b )
pure virtual

Sets the color of the forced edges.

Implemented in DualEdgeTriangulation, and TriDecorator.

## ◆ setTriangleInterpolator()

 virtual void Triangulation::setTriangleInterpolator ( TriangleInterpolator * interpolator )
pure virtual

Sets an interpolator object.

Implemented in DualEdgeTriangulation, NormVecDecorator, and TriDecorator.

## ◆ swapEdge()

 virtual bool Triangulation::swapEdge ( double x, double y )
pure virtual

Reads the content of a taff-file.

Saves the content to a taff file Swaps the edge which is closest to the point with x and y coordinates (if this is possible)

Implemented in DualEdgeTriangulation, NormVecDecorator, and TriDecorator.

## ◆ triangulationFields()

 QgsFields Triangulation::triangulationFields ( )
static

Returns the fields output by features when calling saveTriangulation().

These fields should be used when creating a suitable feature sink for saveTriangulation()