QGIS API Documentation  3.7.0-Master (a888986)
NormVecDecorator Class Reference

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

`#include <NormVecDecorator.h>`

Inheritance diagram for NormVecDecorator: [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 Triangulation
enum  ForcedCrossBehavior { SnappingTypeVertex, DeleteFirst, InsertVertex }
Enumeration describing the behavior, if two forced lines cross. More...

## Public Member Functions

NormVecDecorator ()

NormVecDecorator (Triangulation *tin)

~NormVecDecorator () override

int addPoint (const QgsPoint &p) override
Adds a point to the 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'. Returns `true` in case of success and `false` in case of failure. More...

bool calcNormalForPoint (double x, double y, int point, 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, 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 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 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... Public Member Functions inherited from TriDecorator
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

## 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
TriangulationmTIN = 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 Triangulation
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.

## ◆ 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.

## ◆ NormVecDecorator() [1/2]

 NormVecDecorator::NormVecDecorator ( )
inline

Definition at line 87 of file NormVecDecorator.h.

## ◆ NormVecDecorator() [2/2]

 NormVecDecorator::NormVecDecorator ( Triangulation * tin )
inline

Definition at line 94 of file NormVecDecorator.h.

## ◆ ~NormVecDecorator()

 NormVecDecorator::~NormVecDecorator ( )
override

Definition at line 27 of file NormVecDecorator.cpp.

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

Definition at line 43 of file NormVecDecorator.cpp.

## ◆ calcNormal()

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

## ◆ calcNormalForPoint()

 bool NormVecDecorator::calcNormalForPoint ( double x, double y, int point, 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 Triangulation.

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

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 107 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, 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.

## ◆ getTriangle() [2/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.

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

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

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

Definition at line 541 of file NormVecDecorator.cpp.

## ◆ alreadyestimated

 bool NormVecDecorator::alreadyestimated
protected

Is `true`, if the normals already have been estimated.

Definition at line 73 of file NormVecDecorator.h.

## ◆ DEFAULT_STORAGE_FOR_NORMALS

 const unsigned int NormVecDecorator::DEFAULT_STORAGE_FOR_NORMALS = 100000
staticprotected

Definition at line 74 of file NormVecDecorator.h.

## ◆ mInterpolator

 TriangleInterpolator* NormVecDecorator::mInterpolator = nullptr
protected

Association with an interpolator object.

Definition at line 76 of file NormVecDecorator.h.

## ◆ mNormVec

 QVector* 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 78 of file NormVecDecorator.h.

## ◆ mPointState

 QVector* 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 80 of file NormVecDecorator.h.

The documentation for this class was generated from the following files:
• /tmp/buildd/qgis-3.7.0+git20190524+a888986+15buster/src/analysis/interpolation/NormVecDecorator.h
• /tmp/buildd/qgis-3.7.0+git20190524+a888986+15buster/src/analysis/interpolation/NormVecDecorator.cpp
{"ft_lang_label":"__label__en","ft_lang_prob":0.72633785,"math_prob":0.93542826,"size":14015,"snap":"2019-13-2019-22","text_gpt3_token_len":3560,"char_repetition_ratio":0.18050103,"word_repetition_ratio":0.504298,"special_character_ratio":0.23931502,"punctuation_ratio":0.18794326,"nsfw_num_words":0,"has_unicode_error":false,"math_prob_llama3":0.9508452,"pos_list":[0,1,2,3,4,5,6,7,8,9,10,11,12],"im_url_duplicate_count":[null,2,null,null,null,null,null,null,null,null,null,null,null],"WARC_HEADER":"{\"WARC-Type\":\"response\",\"WARC-Date\":\"2019-05-26T12:05:25Z\",\"WARC-Record-ID\":\"<urn:uuid:d45907e9-741b-4a4d-9167-3fa9f3b7218c>\",\"Content-Length\":\"88094\",\"Content-Type\":\"application/http; msgtype=response\",\"WARC-Warcinfo-ID\":\"<urn:uuid:bd67ad9f-95da-456a-8509-4e6706a539bd>\",\"WARC-Concurrent-To\":\"<urn:uuid:c36cb4df-b487-4dc7-a03d-74132340cb34>\",\"WARC-IP-Address\":\"104.27.139.220\",\"WARC-Target-URI\":\"https://qgis.org/api/classNormVecDecorator.html\",\"WARC-Payload-Digest\":\"sha1:ZFRUYZHX4CQ4PWUKXLOIXBURDXMJRBIP\",\"WARC-Block-Digest\":\"sha1:BQOJNH3AZYJXFPDVYANTQMFHRACGTL5U\",\"WARC-Identified-Payload-Type\":\"application/xhtml+xml\",\"warc_filename\":\"/cc_download/warc_2019/CC-MAIN-2019-22/CC-MAIN-2019-22_segments_1558232259126.83_warc_CC-MAIN-20190526105248-20190526131248-00108.warc.gz\"}"}