QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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. More...
 
- Public Types inherited from Triangulation
enum  forcedCrossBehaviour { SnappingType_VERTICE, DELETE_FIRST, INSERT_VERTICE }
 Enumeration describing the behaviour, if two forced lines cross. More...
 

Public Member Functions

 NormVecDecorator ()
 
 NormVecDecorator (Triangulation *tin)
 
virtual ~NormVecDecorator ()
 
int addPoint (Point3D *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'. 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. More...
 
bool calcPoint (double x, double y, Point3D *result) override
 Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. More...
 
virtual void eliminateHorizontalTriangles () override
 Eliminates the horizontal triangles by swapping or by insertion of new points. More...
 
bool estimateFirstDerivative (int pointno)
 Estimates the first derivative a point. More...
 
bool estimateFirstDerivatives (QProgressDialog *d=nullptr)
 This method adds the functionality of estimating normals at the data points. 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, Point3D *p1, Vector3D *v1, Point3D *p2, Vector3D *v2, Point3D *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. More...
 
bool getTriangle (double x, double y, Point3D *p1, int *ptn1, Vector3D *v1, pointState *state1, Point3D *p2, int *ptn2, Vector3D *v2, pointState *state2, Point3D *p3, int *ptn3, Vector3D *v3, pointState *state3)
 This function behaves similar to the one above. More...
 
virtual bool saveAsShapefile (const QString &fileName) const override
 Saves the triangulation as a (line) shapefile. More...
 
void setTriangleInterpolator (TriangleInterpolator *inter) override
 Sets an interpolator. More...
 
virtual 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 ()
 
 TriDecorator (Triangulation *t)
 
virtual ~TriDecorator ()
 
virtual void addLine (Line3D *line, bool breakline) override
 Adds a line (e.g. More...
 
virtual void addTriangulation (Triangulation *t)
 Adds an association to a triangulation. More...
 
virtual int getNumberOfPoints () const override
 Returns the number of points. More...
 
virtual 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...
 
virtual Point3DgetPoint (unsigned int i) const override
 Returns a pointer to the point with number i. More...
 
virtual 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...
 
virtual 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, Point3D *p1, int *n1, Point3D *p2, int *n2, Point3D *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, Point3D *p1, Point3D *p2, Point3D *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...
 
virtual double getXMax () const override
 Returns the largest x-coordinate value of the bounding box. More...
 
virtual double getXMin () const override
 Returns the smallest x-coordinate value of the bounding box. More...
 
virtual double getYMax () const override
 Returns the largest y-coordinate value of the bounding box. More...
 
virtual double getYMin () const override
 Returns the smallest x-coordinate value of the bounding box. More...
 
virtual void performConsistencyTest () override
 Performs a consistency check, remove this later. More...
 
virtual 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...
 
virtual void ruppertRefinement () override
 Adds points to make the triangles better shaped (algorithm of ruppert) More...
 
virtual void setBreakEdgeColor (int r, int g, int b) override
 Sets the color of the breaklines. More...
 
virtual void setEdgeColor (int r, int g, int b) override
 Sets the color of the normal edges. More...
 
virtual void setForcedCrossBehaviour (Triangulation::forcedCrossBehaviour b) override
 Draws the points, edges and the forced lines. More...
 
virtual void setForcedEdgeColor (int r, int g, int b) override
 Sets the color of the forced edges. More...
 
- Public Member Functions inherited from Triangulation
virtual ~Triangulation ()
 

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
 Association with an interpolator object. More...
 
QVector< Vector3D * > * mNormVec
 Vector that stores the normals for the points. 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
 Association with a Triangulation object. More...
 

Static Protected Attributes

static const unsigned int mDefaultStorageForNormals = 100000
 

Detailed Description

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

Definition at line 28 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 endpoint of it) and ENDPOINT means, that it is an endpoint of a breakline

Enumerator
NORMAL 
BREAKLINE 
ENDPOINT 

Definition at line 32 of file NormVecDecorator.h.

Constructor & Destructor Documentation

◆ NormVecDecorator() [1/2]

NormVecDecorator::NormVecDecorator ( )
inline

Definition at line 82 of file NormVecDecorator.h.

◆ NormVecDecorator() [2/2]

NormVecDecorator::NormVecDecorator ( Triangulation tin)
inline

Definition at line 87 of file NormVecDecorator.h.

◆ ~NormVecDecorator()

virtual NormVecDecorator::~NormVecDecorator ( )
virtual

Member Function Documentation

◆ addPoint()

int NormVecDecorator::addPoint ( Point3D p)
overridevirtual

Adds a point to the triangulation.

Reimplemented from TriDecorator.

◆ 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

Reimplemented from TriDecorator.

◆ 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

◆ calcPoint()

bool NormVecDecorator::calcPoint ( double  x,
double  y,
Point3D 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

Reimplemented from TriDecorator.

◆ eliminateHorizontalTriangles()

virtual 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

Reimplemented from TriDecorator.

◆ estimateFirstDerivative()

bool NormVecDecorator::estimateFirstDerivative ( int  pointno)

Estimates the first derivative a point.

Return true in case of succes and false otherwise

◆ estimateFirstDerivatives()

bool NormVecDecorator::estimateFirstDerivatives ( QProgressDialog d = nullptr)

This method adds the functionality of estimating normals at the data points.

Return true in the case of success and false otherwise

◆ 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 97 of file NormVecDecorator.h.

◆ getState()

pointState NormVecDecorator::getState ( int  pointno) const

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

◆ getTriangle() [1/2]

bool NormVecDecorator::getTriangle ( double  x,
double  y,
Point3D p1,
Vector3D v1,
Point3D p2,
Vector3D v2,
Point3D 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 normaly taken from 'mNormVec', exept 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

◆ getTriangle() [2/2]

bool NormVecDecorator::getTriangle ( double  x,
double  y,
Point3D p1,
int *  ptn1,
Vector3D v1,
pointState state1,
Point3D p2,
int *  ptn2,
Vector3D v2,
pointState state2,
Point3D 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)

Note
not available in Python bindings

◆ saveAsShapefile()

virtual bool NormVecDecorator::saveAsShapefile ( const QString fileName) const
overridevirtual

Saves the triangulation as a (line) shapefile.

Returns
true in case of success

Implements Triangulation.

◆ setState()

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

Sets the state (BREAKLINE, NORMAL, ENDPOINT) of a point.

◆ setTriangleInterpolator()

void NormVecDecorator::setTriangleInterpolator ( TriangleInterpolator inter)
inlineoverridevirtual

Sets an interpolator.

Reimplemented from TriDecorator.

Definition at line 92 of file NormVecDecorator.h.

◆ swapEdge()

virtual 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)

Reimplemented from TriDecorator.

Member Data Documentation

◆ alreadyestimated

bool NormVecDecorator::alreadyestimated
protected

Is true, if the normals already have been estimated.

Definition at line 70 of file NormVecDecorator.h.

◆ mDefaultStorageForNormals

const unsigned int NormVecDecorator::mDefaultStorageForNormals = 100000
staticprotected

Definition at line 71 of file NormVecDecorator.h.

◆ mInterpolator

TriangleInterpolator* NormVecDecorator::mInterpolator
protected

Association with an interpolator object.

Definition at line 73 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 a null pointer, this means, that the triangle point is on a breakline

Definition at line 75 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 77 of file NormVecDecorator.h.


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