QGIS API Documentation  2.99.0-Master (19b062c)
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 (Triangulation *t)
 
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 (Triangulation *t)
 Adds an association to a triangulation. More...
 
bool calcNormal (double x, double y, Vector3D *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 getNumberOfPoints () const override
 Returns the number of points. More...
 
int getOppositePoint (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...
 
QgsPointgetPoint (int i) const override
 Returns a pointer to the point with number i. Any virtual points must have the number -1. More...
 
QList< int > * getPointsAroundEdge (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...
 
QList< int > getSurroundingTriangles (int pointno) override
 Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. More...
 
bool getTriangle (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 getTriangle (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 getXMax () const override
 Returns the largest x-coordinate value of the bounding box. More...
 
double getXMin () const override
 Returns the smallest x-coordinate value of the bounding box. More...
 
double getYMax () const override
 Returns the largest y-coordinate value of the bounding box. More...
 
double getYMin () const override
 Returns the smallest x-coordinate value of the bounding box. More...
 
void performConsistencyTest () override
 Performs a consistency check, remove this later. 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...
 
void ruppertRefinement () override
 Adds points to make the triangles better shaped (algorithm of ruppert) More...
 
void setBreakEdgeColor (int r, int g, int b) override
 Sets the color of the breaklines. More...
 
void setEdgeColor (int r, int g, int b) override
 Sets the color of the normal edges. More...
 
void setForcedCrossBehavior (Triangulation::ForcedCrossBehavior b) override
 Draws the points, edges and the forced lines. More...
 
void setForcedEdgeColor (int r, int g, int b) override
 Sets the color of the forced edges. More...
 
void setTriangleInterpolator (TriangleInterpolator *interpolator) override
 Sets an interpolator object. More...
 
bool swapEdge (double x, double y) override
 Reads the content of a taff-file. More...
 
- Public Member Functions inherited from Triangulation
virtual ~Triangulation ()=default
 
virtual bool saveTriangulation (QgsFeatureSink *sink, QgsFeedback *feedback=nullptr) const =0
 Saves the triangulation features to a feature sink. More...
 

Protected Attributes

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

Additional Inherited Members

- Public Types inherited from Triangulation
enum  ForcedCrossBehavior { SnappingTypeVertex, DeleteFirst, InsertVertex }
 Enumeration describing the behavior, if two forced lines cross. More...
 
- Static Public Member Functions inherited from Triangulation
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 ( Triangulation t)
inlineexplicit

Definition at line 72 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 Triangulation.

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

Definition at line 32 of file TriDecorator.cpp.

◆ addTriangulation()

void TriDecorator::addTriangulation ( Triangulation t)
inlinevirtual

Adds an association to a triangulation.

Definition at line 78 of file TriDecorator.h.

◆ calcNormal()

bool TriDecorator::calcNormal ( double  x,
double  y,
Vector3D 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 Triangulation.

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 flase in case of failure

Implements Triangulation.

Definition at line 72 of file TriDecorator.cpp.

◆ eliminateHorizontalTriangles()

void TriDecorator::eliminateHorizontalTriangles ( )
overridevirtual

Eliminates the horizontal triangles by swapping.

Implements Triangulation.

Definition at line 282 of file TriDecorator.cpp.

◆ getNumberOfPoints()

int TriDecorator::getNumberOfPoints ( ) const
overridevirtual

Returns the number of points.

Implements Triangulation.

Definition at line 128 of file TriDecorator.cpp.

◆ getOppositePoint()

int TriDecorator::getOppositePoint ( 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 Triangulation.

Definition at line 141 of file TriDecorator.cpp.

◆ getPoint()

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

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

Implements Triangulation.

Definition at line 86 of file TriDecorator.cpp.

◆ getPointsAroundEdge()

QList< int > * TriDecorator::getPointsAroundEdge ( 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 Triangulation.

Definition at line 334 of file TriDecorator.cpp.

◆ getSurroundingTriangles()

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

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

Implements Triangulation.

Definition at line 155 of file TriDecorator.cpp.

◆ getTriangle() [1/2]

bool TriDecorator::getTriangle ( 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 Triangulation.

Definition at line 100 of file TriDecorator.cpp.

◆ getTriangle() [2/2]

bool TriDecorator::getTriangle ( 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 Triangulation.

Definition at line 114 of file TriDecorator.cpp.

◆ getXMax()

double TriDecorator::getXMax ( ) const
overridevirtual

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

Implements Triangulation.

Definition at line 167 of file TriDecorator.cpp.

◆ getXMin()

double TriDecorator::getXMin ( ) const
overridevirtual

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

Implements Triangulation.

Definition at line 181 of file TriDecorator.cpp.

◆ getYMax()

double TriDecorator::getYMax ( ) const
overridevirtual

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

Implements Triangulation.

Definition at line 194 of file TriDecorator.cpp.

◆ getYMin()

double TriDecorator::getYMin ( ) const
overridevirtual

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

Implements Triangulation.

Definition at line 208 of file TriDecorator.cpp.

◆ performConsistencyTest()

void TriDecorator::performConsistencyTest ( )
overridevirtual

Performs a consistency check, remove this later.

Implements Triangulation.

Definition at line 46 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 Triangulation.

Definition at line 306 of file TriDecorator.cpp.

◆ ruppertRefinement()

void TriDecorator::ruppertRefinement ( )
overridevirtual

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

Implements Triangulation.

Definition at line 294 of file TriDecorator.cpp.

◆ setBreakEdgeColor()

void TriDecorator::setBreakEdgeColor ( int  r,
int  g,
int  b 
)
overridevirtual

Sets the color of the breaklines.

Implements Triangulation.

Definition at line 258 of file TriDecorator.cpp.

◆ setEdgeColor()

void TriDecorator::setEdgeColor ( int  r,
int  g,
int  b 
)
overridevirtual

Sets the color of the normal edges.

Implements Triangulation.

Definition at line 234 of file TriDecorator.cpp.

◆ setForcedCrossBehavior()

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

Draws the points, edges and the forced lines.

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

Implements Triangulation.

Definition at line 222 of file TriDecorator.cpp.

◆ setForcedEdgeColor()

void TriDecorator::setForcedEdgeColor ( int  r,
int  g,
int  b 
)
overridevirtual

Sets the color of the forced edges.

Implements Triangulation.

Definition at line 246 of file TriDecorator.cpp.

◆ setTriangleInterpolator()

void TriDecorator::setTriangleInterpolator ( TriangleInterpolator interpolator)
overridevirtual

Sets an interpolator object.

Implements Triangulation.

Definition at line 270 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 Triangulation.

Definition at line 320 of file TriDecorator.cpp.

Member Data Documentation

◆ mTIN

Triangulation* TriDecorator::mTIN = nullptr
protected

Association with a Triangulation object.

Definition at line 67 of file TriDecorator.h.


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