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

Decorator class which adds the functionality of estimating normals at the data points. More...

#include <NormVecDecorator.h>

Inheritance diagram for NormVecDecorator:
Inheritance graph
[legend]

Public Types

enum  PointState { Normal , BreakLine , EndPoint }
 Enumeration for the state of a point. Normal means, that the point is not on a BreakLine, BreakLine means that the point is on a breakline (but not an end point of it) and EndPoint means, that it is an endpoint of a breakline. More...
 
- Public Types inherited from QgsTriangulation
enum  ForcedCrossBehavior { SnappingTypeVertex , DeleteFirst , InsertVertex }
 Enumeration describing the behavior, if two forced lines cross. More...
 

Public Member Functions

 NormVecDecorator ()
 
 NormVecDecorator (QgsTriangulation *tin)
 Constructor for TriDecorator with an existing triangulation. More...
 
 ~NormVecDecorator () override
 
int addPoint (const QgsPoint &p) override
 Adds a point to the 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'. Returns true in case of success and false in case of failure. More...
 
bool calcNormalForPoint (double x, double y, int pointIndex, Vector3D *result)
 Calculates the normal of a triangle-point for the point with coordinates x and y. This is needed, if a point is on a break line and there is no unique normal stored in 'mNormVec'. Returns false, it something went wrong and true otherwise. 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 or by insertion of new points. If alreadyestimated is true, a re-estimation of the normals will be done. More...
 
bool estimateFirstDerivative (int pointno)
 Estimates the first derivative a point. Return true in case of success and false otherwise. More...
 
bool estimateFirstDerivatives (QgsFeedback *feedback=nullptr)
 This method adds the functionality of estimating normals at the data points. Return true in the case of success and false otherwise. More...
 
Vector3DgetNormal (int n) const
 Returns a pointer to the normal vector for the point with the number n. More...
 
PointState getState (int pointno) const
 Returns the state of the point with the number 'pointno'. More...
 
bool getTriangle (double x, double y, QgsPoint &p1, int &ptn1, Vector3D *v1, PointState *state1, QgsPoint &p2, int &ptn2, Vector3D *v2, PointState *state2, QgsPoint &p3, int &ptn3, Vector3D *v3, PointState *state3)
 This function behaves similar to the one above. Additionally, the numbers of the points are returned (ptn1, ptn2, ptn3) as well as the PointStates of the triangle points (state1, state2, state3) More...
 
bool getTriangle (double x, double y, QgsPoint &p1, Vector3D *v1, QgsPoint &p2, Vector3D *v2, QgsPoint &p3, Vector3D *v3)
 Finds out, in which triangle a point with coordinates x and y is and assigns the triangle points to p1, p2, p3 and the estimated normals to v1, v2, v3. The vectors are normally taken from 'mNormVec', except if p1, p2 or p3 is a point on a breakline. In this case, the normal is calculated on-the-fly. Returns false, if something went wrong and true otherwise. More...
 
bool saveTriangulation (QgsFeatureSink *sink, QgsFeedback *feedback=nullptr) const override
 Saves the triangulation features to a feature sink. More...
 
void setTriangleInterpolator (TriangleInterpolator *inter) override
 Sets an interpolator. More...
 
bool swapEdge (double x, double y) override
 Swaps the edge which is closest to the point with x and y coordinates (if this is possible) and forces recalculation of the concerned normals (if alreadyestimated is true) More...
 
QgsMesh triangulationToMesh (QgsFeedback *feedback=nullptr) const override
 Returns a QgsMesh corresponding to the triangulation. More...
 
- Public Member Functions inherited from TriDecorator
 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 Member Functions

void setState (int pointno, PointState s)
 Sets the state (BreakLine, Normal, EndPoint) of a point. More...
 

Protected Attributes

bool alreadyestimated
 Is true, if the normals already have been estimated. More...
 
TriangleInterpolatormInterpolator = nullptr
 Association with an interpolator object. More...
 
QVector< Vector3D * > * mNormVec
 Vector that stores the normals for the points. If 'estimateFirstDerivatives()' was called and there is nullptr, this means, that the triangle point is on a breakline. More...
 
QVector< PointState > * mPointState
 Vector who stores, it a point is not on a breakline, if it is a normal point of the breakline or if it is an endpoint of a breakline. More...
 
- Protected Attributes inherited from TriDecorator
QgsTriangulationmTIN = nullptr
 Association with a Triangulation object. More...
 

Static Protected Attributes

static const unsigned int DEFAULT_STORAGE_FOR_NORMALS = 100000
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsTriangulation
static QgsFields triangulationFields ()
 Returns the fields output by features when calling saveTriangulation(). More...
 

Detailed Description

Decorator class which adds the functionality of estimating normals at the data points.

Note
Not available in Python bindings.

Definition at line 36 of file NormVecDecorator.h.

Member Enumeration Documentation

◆ PointState

Enumeration for the state of a point. Normal means, that the point is not on a BreakLine, BreakLine means that the point is on a breakline (but not an end point of it) and EndPoint means, that it is an endpoint of a breakline.

Enumerator
Normal 
BreakLine 
EndPoint 

Definition at line 40 of file NormVecDecorator.h.

Constructor & Destructor Documentation

◆ NormVecDecorator() [1/2]

NormVecDecorator::NormVecDecorator ( )
inline

Definition at line 94 of file NormVecDecorator.h.

◆ NormVecDecorator() [2/2]

NormVecDecorator::NormVecDecorator ( QgsTriangulation tin)
inline

Constructor for TriDecorator with an existing triangulation.

Definition at line 101 of file NormVecDecorator.h.

◆ ~NormVecDecorator()

NormVecDecorator::~NormVecDecorator ( )
override

Definition at line 27 of file NormVecDecorator.cpp.

Member Function Documentation

◆ addPoint()

int NormVecDecorator::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 43 of file NormVecDecorator.cpp.

◆ calcNormal()

bool NormVecDecorator::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 83 of file NormVecDecorator.cpp.

◆ calcNormalForPoint()

bool NormVecDecorator::calcNormalForPoint ( double  x,
double  y,
int  pointIndex,
Vector3D result 
)

Calculates the normal of a triangle-point for the point with coordinates x and y. This is needed, if a point is on a break line and there is no unique normal stored in 'mNormVec'. Returns false, it something went wrong and true otherwise.

Definition at line 103 of file NormVecDecorator.cpp.

◆ calcPoint()

bool NormVecDecorator::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 228 of file NormVecDecorator.cpp.

◆ eliminateHorizontalTriangles()

void NormVecDecorator::eliminateHorizontalTriangles ( )
overridevirtual

Eliminates the horizontal triangles by swapping or by insertion of new points. If alreadyestimated is true, a re-estimation of the normals will be done.

Implements QgsTriangulation.

Definition at line 509 of file NormVecDecorator.cpp.

◆ estimateFirstDerivative()

bool NormVecDecorator::estimateFirstDerivative ( int  pointno)

Estimates the first derivative a point. Return true in case of success and false otherwise.

Definition at line 346 of file NormVecDecorator.cpp.

◆ estimateFirstDerivatives()

bool NormVecDecorator::estimateFirstDerivatives ( QgsFeedback feedback = nullptr)

This method adds the functionality of estimating normals at the data points. Return true in the case of success and false otherwise.

Definition at line 494 of file NormVecDecorator.cpp.

◆ getNormal()

Vector3D * NormVecDecorator::getNormal ( int  n) const
inline

Returns a pointer to the normal vector for the point with the number n.

Definition at line 114 of file NormVecDecorator.h.

◆ getState()

NormVecDecorator::PointState NormVecDecorator::getState ( int  pointno) const

Returns the state of the point with the number 'pointno'.

Definition at line 293 of file NormVecDecorator.cpp.

◆ getTriangle() [1/2]

bool NormVecDecorator::getTriangle ( double  x,
double  y,
QgsPoint p1,
int &  ptn1,
Vector3D v1,
PointState state1,
QgsPoint p2,
int &  ptn2,
Vector3D v2,
PointState state2,
QgsPoint p3,
int &  ptn3,
Vector3D v3,
PointState state3 
)

This function behaves similar to the one above. Additionally, the numbers of the points are returned (ptn1, ptn2, ptn3) as well as the PointStates of the triangle points (state1, state2, state3)

Definition at line 307 of file NormVecDecorator.cpp.

◆ getTriangle() [2/2]

bool NormVecDecorator::getTriangle ( double  x,
double  y,
QgsPoint p1,
Vector3D v1,
QgsPoint p2,
Vector3D v2,
QgsPoint p3,
Vector3D v3 
)

Finds out, in which triangle a point with coordinates x and y is and assigns the triangle points to p1, p2, p3 and the estimated normals to v1, v2, v3. The vectors are normally taken from 'mNormVec', except if p1, p2 or p3 is a point on a breakline. In this case, the normal is calculated on-the-fly. Returns false, if something went wrong and true otherwise.

Definition at line 249 of file NormVecDecorator.cpp.

◆ saveTriangulation()

bool NormVecDecorator::saveTriangulation ( QgsFeatureSink sink,
QgsFeedback feedback = nullptr 
) const
overridevirtual

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
See also
triangulationFields()
Since
QGIS 3.0

Implements QgsTriangulation.

Definition at line 571 of file NormVecDecorator.cpp.

◆ setState()

void NormVecDecorator::setState ( int  pointno,
PointState  s 
)
protected

Sets the state (BreakLine, Normal, EndPoint) of a point.

Definition at line 529 of file NormVecDecorator.cpp.

◆ setTriangleInterpolator()

void NormVecDecorator::setTriangleInterpolator ( TriangleInterpolator inter)
inlineoverridevirtual

Sets an interpolator.

Implements QgsTriangulation.

Definition at line 109 of file NormVecDecorator.h.

◆ swapEdge()

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

Swaps the edge which is closest to the point with x and y coordinates (if this is possible) and forces recalculation of the concerned normals (if alreadyestimated is true)

Implements QgsTriangulation.

Definition at line 541 of file NormVecDecorator.cpp.

◆ triangulationToMesh()

QgsMesh NormVecDecorator::triangulationToMesh ( QgsFeedback feedback = nullptr) const
overridevirtual

Returns a QgsMesh corresponding to the triangulation.

Since
QGIS 3.16

Implements QgsTriangulation.

Definition at line 580 of file NormVecDecorator.cpp.

Member Data Documentation

◆ alreadyestimated

bool NormVecDecorator::alreadyestimated
protected

Is true, if the normals already have been estimated.

Definition at line 76 of file NormVecDecorator.h.

◆ DEFAULT_STORAGE_FOR_NORMALS

const unsigned int NormVecDecorator::DEFAULT_STORAGE_FOR_NORMALS = 100000
staticprotected

Definition at line 77 of file NormVecDecorator.h.

◆ mInterpolator

TriangleInterpolator* NormVecDecorator::mInterpolator = nullptr
protected

Association with an interpolator object.

Definition at line 79 of file NormVecDecorator.h.

◆ mNormVec

QVector<Vector3D *>* NormVecDecorator::mNormVec
protected

Vector that stores the normals for the points. If 'estimateFirstDerivatives()' was called and there is nullptr, this means, that the triangle point is on a breakline.

Definition at line 81 of file NormVecDecorator.h.

◆ mPointState

QVector<PointState>* NormVecDecorator::mPointState
protected

Vector who stores, it a point is not on a breakline, if it is a normal point of the breakline or if it is an endpoint of a breakline.

Definition at line 83 of file NormVecDecorator.h.


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