QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Protected Attributes | List of all members
TriDecorator Class Reference

Decorator class for Triangulations (s. More...

#include <TriDecorator.h>

Inheritance diagram for TriDecorator:
Inheritance graph
[legend]

Public Member Functions

 TriDecorator ()=default
 Constructor for TriDecorator. More...
 
 TriDecorator (QgsTriangulation *t)
 Constructor for TriDecorator with an existing triangulation. More...
 
void addLine (const QVector< QgsPoint > &points, QgsInterpolator::SourceType lineType) override
 Adds a line (e.g. More...
 
int addPoint (const QgsPoint &p) override
 Adds a point to the triangulation. More...
 
virtual void addTriangulation (QgsTriangulation *t)
 Adds an association to a triangulation. More...
 
bool calcNormal (double x, double y, QgsPoint &result) override
 Calculates the normal at a point on the surface and assigns it to 'result'. More...
 
bool calcPoint (double x, double y, QgsPoint &result) override
 Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. More...
 
void eliminateHorizontalTriangles () override
 Eliminates the horizontal triangles by swapping. More...
 
int oppositePoint (int p1, int p2) override
 Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge). More...
 
void performConsistencyTest () override
 Performs a consistency check, remove this later. More...
 
QgsPointpoint (int i) const override
 Returns a pointer to the point with number i. More...
 
bool pointInside (double x, double y) override
 Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise. More...
 
QList< int > pointsAroundEdge (double x, double y) override
 Returns a value list with the numbers of the four points, which would be affected by an edge swap. More...
 
int pointsCount () const override
 Returns the number of points. More...
 
void ruppertRefinement () override
 Adds points to make the triangles better shaped (algorithm of ruppert) More...
 
void setForcedCrossBehavior (QgsTriangulation::ForcedCrossBehavior b) override
 Draws the points, edges and the forced lines. More...
 
void setTriangleInterpolator (TriangleInterpolator *interpolator) override
 Sets an interpolator object. More...
 
QList< int > surroundingTriangles (int pointno) override
 Returns a value list with the information of the triangles surrounding (counterclockwise) a point. More...
 
bool swapEdge (double x, double y) override
 Reads the content of a taff-file. More...
 
bool triangleVertices (double x, double y, QgsPoint &p1, int &n1, QgsPoint &p2, int &n2, QgsPoint &p3, int &n3) override
 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...
 
bool triangleVertices (double x, double y, QgsPoint &p1, QgsPoint &p2, QgsPoint &p3) override
 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...
 
double xMax () const override
 Returns the largest x-coordinate value of the bounding box. More...
 
double xMin () const override
 Returns the smallest x-coordinate value of the bounding box. More...
 
double yMax () const override
 Returns the largest y-coordinate value of the bounding box. More...
 
double yMin () const override
 Returns the smallest x-coordinate value of the bounding box. More...
 
- Public Member Functions inherited from QgsTriangulation
virtual ~QgsTriangulation ()=default
 
virtual void addLine (const QgsPointSequence &points, QgsInterpolator::SourceType lineType)=0
 Adds a line (e.g. More...
 
virtual int addPoint (const QgsPoint &point)=0
 Adds a point to the triangulation. More...
 
virtual bool calcNormal (double x, double y, QgsPoint &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 oppositePoint (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 void performConsistencyTest ()=0
 Performs a consistency check, remove this later. More...
 
virtual QgsPointpoint (int i) const =0
 Returns a pointer to the point with number i. 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 QList< int > pointsAroundEdge (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 int pointsCount () const =0
 Returns the number of points. 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 setForcedCrossBehavior (QgsTriangulation::ForcedCrossBehavior b)=0
 Draws the points, edges and the forced lines. More...
 
virtual void setTriangleInterpolator (TriangleInterpolator *interpolator)=0
 Sets an interpolator object. More...
 
virtual QList< int > surroundingTriangles (int pointno)=0
 Returns a value list with the information of the triangles surrounding (counterclockwise) a point. More...
 
virtual bool swapEdge (double x, double y)=0
 Reads the content of a taff-file. More...
 
virtual bool triangleVertices (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 triangleVertices (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 QgsMesh triangulationToMesh (QgsFeedback *feedback=nullptr) const =0
 Returns a QgsMesh corresponding to the triangulation. More...
 
virtual double xMax () const =0
 Returns the largest x-coordinate value of the bounding box. More...
 
virtual double xMin () const =0
 Returns the smallest x-coordinate value of the bounding box. More...
 
virtual double yMax () const =0
 Returns the largest y-coordinate value of the bounding box. More...
 
virtual double yMin () const =0
 Returns the smallest x-coordinate value of the bounding box. More...
 

Protected Attributes

QgsTriangulationmTIN = nullptr
 Association with a Triangulation object. More...
 

Additional Inherited Members

- Public Types inherited from QgsTriangulation
enum  ForcedCrossBehavior { SnappingTypeVertex , DeleteFirst , InsertVertex }
 Enumeration describing the behavior, if two forced lines cross. More...
 
- Static Public Member Functions inherited from QgsTriangulation
static QgsFields triangulationFields ()
 Returns the fields output by features when calling saveTriangulation(). More...
 

Detailed Description

Decorator class for Triangulations (s.

Decorator pattern in Gamma et al.).

Note
Not available in Python bindings.

Definition at line 31 of file TriDecorator.h.

Constructor & Destructor Documentation

◆ TriDecorator() [1/2]

TriDecorator::TriDecorator ( )
default

Constructor for TriDecorator.

◆ TriDecorator() [2/2]

TriDecorator::TriDecorator ( QgsTriangulation t)
inlineexplicit

Constructor for TriDecorator with an existing triangulation.

Definition at line 70 of file TriDecorator.h.

Member Function Documentation

◆ addLine()

void TriDecorator::addLine ( const QVector< QgsPoint > &  points,
QgsInterpolator::SourceType  lineType 
)
overridevirtual

Adds a line (e.g.

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

Implements QgsTriangulation.

Definition at line 20 of file TriDecorator.cpp.

◆ addPoint()

int TriDecorator::addPoint ( const QgsPoint point)
overridevirtual

Adds a point to the triangulation.

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

Implements QgsTriangulation.

Definition at line 32 of file TriDecorator.cpp.

◆ addTriangulation()

void TriDecorator::addTriangulation ( QgsTriangulation t)
inlinevirtual

Adds an association to a triangulation.

Definition at line 76 of file TriDecorator.h.

◆ calcNormal()

bool TriDecorator::calcNormal ( double  x,
double  y,
QgsPoint result 
)
overridevirtual

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

Implements QgsTriangulation.

Definition at line 58 of file TriDecorator.cpp.

◆ calcPoint()

bool TriDecorator::calcPoint ( double  x,
double  y,
QgsPoint result 
)
overridevirtual

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

Implements QgsTriangulation.

Definition at line 72 of file TriDecorator.cpp.

◆ eliminateHorizontalTriangles()

void TriDecorator::eliminateHorizontalTriangles ( )
overridevirtual

Eliminates the horizontal triangles by swapping.

Implements QgsTriangulation.

Definition at line 246 of file TriDecorator.cpp.

◆ oppositePoint()

int TriDecorator::oppositePoint ( int  p1,
int  p2 
)
overridevirtual

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.

Implements QgsTriangulation.

Definition at line 141 of file TriDecorator.cpp.

◆ performConsistencyTest()

void TriDecorator::performConsistencyTest ( )
overridevirtual

Performs a consistency check, remove this later.

Implements QgsTriangulation.

Definition at line 46 of file TriDecorator.cpp.

◆ point()

QgsPoint * TriDecorator::point ( int  i) const
overridevirtual

Returns a pointer to the point with number i.

Implements QgsTriangulation.

Definition at line 86 of file TriDecorator.cpp.

◆ pointInside()

bool TriDecorator::pointInside ( double  x,
double  y 
)
overridevirtual

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

Implements QgsTriangulation.

Definition at line 270 of file TriDecorator.cpp.

◆ pointsAroundEdge()

QList< int > TriDecorator::pointsAroundEdge ( double  x,
double  y 
)
overridevirtual

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

Implements QgsTriangulation.

Definition at line 298 of file TriDecorator.cpp.

◆ pointsCount()

int TriDecorator::pointsCount ( ) const
overridevirtual

Returns the number of points.

Implements QgsTriangulation.

Definition at line 128 of file TriDecorator.cpp.

◆ ruppertRefinement()

void TriDecorator::ruppertRefinement ( )
overridevirtual

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

Implements QgsTriangulation.

Definition at line 258 of file TriDecorator.cpp.

◆ setForcedCrossBehavior()

void TriDecorator::setForcedCrossBehavior ( QgsTriangulation::ForcedCrossBehavior  b)
overridevirtual

Draws the points, edges and the forced lines.

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

Implements QgsTriangulation.

Definition at line 222 of file TriDecorator.cpp.

◆ setTriangleInterpolator()

void TriDecorator::setTriangleInterpolator ( TriangleInterpolator interpolator)
overridevirtual

Sets an interpolator object.

Implements QgsTriangulation.

Definition at line 234 of file TriDecorator.cpp.

◆ surroundingTriangles()

QList< int > TriDecorator::surroundingTriangles ( int  pointno)
overridevirtual

Returns 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

Implements QgsTriangulation.

Definition at line 155 of file TriDecorator.cpp.

◆ swapEdge()

bool TriDecorator::swapEdge ( double  x,
double  y 
)
overridevirtual

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)

Implements QgsTriangulation.

Definition at line 284 of file TriDecorator.cpp.

◆ triangleVertices() [1/2]

bool TriDecorator::triangleVertices ( double  x,
double  y,
QgsPoint p1,
int &  n1,
QgsPoint p2,
int &  n2,
QgsPoint p3,
int &  n3 
)
overridevirtual

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'.

Implements QgsTriangulation.

Definition at line 100 of file TriDecorator.cpp.

◆ triangleVertices() [2/2]

bool TriDecorator::triangleVertices ( double  x,
double  y,
QgsPoint p1,
QgsPoint p2,
QgsPoint p3 
)
overridevirtual

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.

Implements QgsTriangulation.

Definition at line 114 of file TriDecorator.cpp.

◆ xMax()

double TriDecorator::xMax ( ) const
overridevirtual

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

Implements QgsTriangulation.

Definition at line 167 of file TriDecorator.cpp.

◆ xMin()

double TriDecorator::xMin ( ) const
overridevirtual

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

Implements QgsTriangulation.

Definition at line 181 of file TriDecorator.cpp.

◆ yMax()

double TriDecorator::yMax ( ) const
overridevirtual

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

Implements QgsTriangulation.

Definition at line 194 of file TriDecorator.cpp.

◆ yMin()

double TriDecorator::yMin ( ) const
overridevirtual

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

Implements QgsTriangulation.

Definition at line 208 of file TriDecorator.cpp.

Member Data Documentation

◆ mTIN

QgsTriangulation* TriDecorator::mTIN = nullptr
protected

Association with a Triangulation object.

Definition at line 65 of file TriDecorator.h.


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