QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Class that wraps a QgsMesh to ensure the consistency of the mesh during editing and help to access to elements from other elements. More...
#include <qgstopologicalmesh.h>
Classes | |
class | Changes |
Class that contains topological differences between two states of a topological mesh, only accessible from the QgsTopologicalMesh class. More... | |
class | TopologicalFaces |
Class that contains independent faces an topological information about this faces. More... | |
Public Types | |
using | FaceNeighbors = QVector< int > |
Public Member Functions | |
Changes | addFaces (const TopologicalFaces &topologicFaces) |
Adds faces topologicFaces to the topologic mesh. | |
Changes | addFreeVertex (const QgsMeshVertex &vertex) |
Adds a free vertex in the face, that is a vertex that is not included or linked with any faces. | |
Changes | addVertexInFace (int faceIndex, const QgsMeshVertex &vertex) |
Adds a vertex in the face with index faceIndex. | |
void | applyChanges (const Changes &changes) |
Applies the changes. | |
bool | canBeMerged (int vertexIndex1, int vertexIndex2) const |
Returns true if faces separated by vertices with indexes vertexIndex1 and vertexIndex2 can be merged. | |
bool | canBeSplit (int faceIndex) const |
Returns true if face with index faceIndex can be split. | |
Changes | changeXYValue (const QList< int > &verticesIndexes, const QList< QgsPointXY > &newValues) |
Changes the (X,Y) values of the vertices with indexes in vertices indexes with the values in newValues. | |
Changes | changeZValue (const QList< int > &verticesIndexes, const QList< double > &newValues) |
Changes the Z values of the vertices with indexes in vertices indexes with the values in newValues. | |
QgsMeshEditingError | checkConsistency () const |
Checks the consistency of the topological mesh and return false if there is a consistency issue. | |
bool | edgeCanBeFlipped (int vertexIndex1, int vertexIndex2) const |
Returns true if the edge can be flipped (only available for edge shared by two faces with 3 vertices) | |
QList< int > | facesAroundVertex (int vertexIndex) const |
Returns the indexes of faces that are around the vertex with index vertexIndex. | |
QgsMeshEditingError | facesCanBeAdded (const TopologicalFaces &topologicalFaces) const |
Returns whether the faces can be added to the mesh. | |
QgsMeshEditingError | facesCanBeRemoved (const QList< int > &facesIndexes) |
Returns whether faces with index in faceIndexes can be removed/ The method an error object with type QgsMeshEditingError::NoError if the faces can be removed, otherwise returns the corresponding error. | |
int | firstFaceLinked (int vertexIndex) const |
Returns the index of the first face linked, returns -1 if it is a free vertex or out of range index. | |
Changes | flipEdge (int vertexIndex1, int vertexIndex2) |
Flips edge (vertexIndex1, vertexIndex2) The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation. | |
QList< int > | freeVerticesIndexes () const |
Returns a list of vertices are not linked to any faces. | |
Changes | insertVertexInFacesEdge (int faceIndex, int position, const QgsMeshVertex &vertex) |
Inserts a vertex in the edge of face with index faceIndex at position . | |
bool | isVertexFree (int vertexIndex) const |
Returns whether the vertex is a free vertex. | |
bool | isVertexOnBoundary (int vertexIndex) const |
Returns whether the vertex is on a boundary. | |
Changes | merge (int vertexIndex1, int vertexIndex2) |
Merges faces separated by vertices with indexes vertexIndex1 and vertexIndex2 The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation. | |
QgsMesh * | mesh () const |
Returns a pointer to the wrapped mesh. | |
QVector< int > | neighborsOfFace (int faceIndex) const |
Returns the indexes of neighbor faces of the face with index faceIndex. | |
void | reindex () |
Reindexes faces and vertices, after this operation, the topological mesh can't be edited anymore and only the method mesh can be used to access to the raw mesh. | |
Changes | removeFaces (const QList< int > &facesIndexes) |
Removes faces with index in faceIndexes. | |
Changes | removeVertexFillHole (int vertexIndex) |
Removes the vertex with index vertexIndex. | |
Changes | removeVertices (const QList< int > &vertices) |
Removes all the vertices with index in the list vertices If vertices in linked with faces, the operation leads also to remove the faces without filling holes. | |
bool | renumber () |
Renumbers the indexes of vertices and faces using the Reverse CutHill McKee Algorithm. | |
void | reverseChanges (const Changes &changes) |
Reverses the changes. | |
Changes | splitFace (int faceIndex) |
Splits face with index faceIndex The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation. | |
QgsMeshVertexCirculator | vertexCirculator (int vertexIndex) const |
Returns a vertex circulator linked to this mesh around the vertex with index vertexIndex. | |
Static Public Member Functions | |
static QgsMeshEditingError | checkTopology (const QgsMesh &mesh, int maxVerticesPerFace) |
Checks the topology of the mesh mesh, if error occurs, this mesh can't be edited. | |
static QgsMeshEditingError | checkTopologyOfVerticesAsFace (const QVector< QgsMeshVertex > &vertices, bool &clockwise) |
Checks the topology of the vertices as they are contained in a face and returns indication on direction. | |
static QgsMeshEditingError | counterClockwiseFaces (QgsMeshFace &face, QgsMesh *mesh) |
Checks the topology of the face and sets it counter clockwise if necessary. | |
static TopologicalFaces | createNewTopologicalFaces (const QVector< QgsMeshFace > &faces, bool uniqueSharedVertexAllowed, QgsMeshEditingError &error) |
Creates new topological faces that are not yet included in the mesh. | |
static QgsTopologicalMesh | createTopologicalMesh (QgsMesh *mesh, int maxVerticesPerFace, QgsMeshEditingError &error) |
Creates a topologicaly consistent mesh with mesh, this static method modifies mesh to be topological consistent and return a QgsTopologicalMesh instance that contains and handles this mesh (does not take ownership). | |
Friends | |
class | QgsMeshVertexCirculator |
Class that wraps a QgsMesh to ensure the consistency of the mesh during editing and help to access to elements from other elements.
A topological face need to:
Definition at line 47 of file qgstopologicalmesh.h.
using QgsTopologicalMesh::FaceNeighbors = QVector<int> |
Definition at line 51 of file qgstopologicalmesh.h.
QgsTopologicalMesh::Changes QgsTopologicalMesh::addFaces | ( | const TopologicalFaces & | topologicFaces | ) |
Adds faces topologicFaces to the topologic mesh.
The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 287 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::addFreeVertex | ( | const QgsMeshVertex & | vertex | ) |
Adds a free vertex in the face, that is a vertex that is not included or linked with any faces.
The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 1138 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::addVertexInFace | ( | int | faceIndex, |
const QgsMeshVertex & | vertex | ||
) |
Adds a vertex in the face with index faceIndex.
The including face is removed and new faces surrounding the added vertex are added. The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 2300 of file qgstopologicalmesh.cpp.
void QgsTopologicalMesh::applyChanges | ( | const Changes & | changes | ) |
Applies the changes.
Definition at line 360 of file qgstopologicalmesh.cpp.
bool QgsTopologicalMesh::canBeMerged | ( | int | vertexIndex1, |
int | vertexIndex2 | ||
) | const |
Returns true
if faces separated by vertices with indexes vertexIndex1 and vertexIndex2 can be merged.
Definition at line 2080 of file qgstopologicalmesh.cpp.
bool QgsTopologicalMesh::canBeSplit | ( | int | faceIndex | ) | const |
Returns true
if face with index faceIndex can be split.
Definition at line 2213 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::changeXYValue | ( | const QList< int > & | verticesIndexes, |
const QList< QgsPointXY > & | newValues | ||
) |
Changes the (X,Y) values of the vertices with indexes in vertices indexes with the values in newValues.
Definition at line 2569 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::changeZValue | ( | const QList< int > & | verticesIndexes, |
const QList< double > & | newValues | ||
) |
Changes the Z values of the vertices with indexes in vertices indexes with the values in newValues.
Definition at line 2550 of file qgstopologicalmesh.cpp.
QgsMeshEditingError QgsTopologicalMesh::checkConsistency | ( | ) | const |
Checks the consistency of the topological mesh and return false
if there is a consistency issue.
Definition at line 548 of file qgstopologicalmesh.cpp.
|
static |
Checks the topology of the mesh mesh, if error occurs, this mesh can't be edited.
Definition at line 593 of file qgstopologicalmesh.cpp.
|
static |
Checks the topology of the vertices as they are contained in a face and returns indication on direction.
If the face is clockwise, clockwise is true
Definition at line 639 of file qgstopologicalmesh.cpp.
|
static |
Checks the topology of the face and sets it counter clockwise if necessary.
Definition at line 682 of file qgstopologicalmesh.cpp.
|
static |
Creates new topological faces that are not yet included in the mesh.
Definition at line 1711 of file qgstopologicalmesh.cpp.
|
static |
Creates a topologicaly consistent mesh with mesh, this static method modifies mesh to be topological consistent and return a QgsTopologicalMesh instance that contains and handles this mesh (does not take ownership).
Definition at line 1669 of file qgstopologicalmesh.cpp.
bool QgsTopologicalMesh::edgeCanBeFlipped | ( | int | vertexIndex1, |
int | vertexIndex2 | ||
) | const |
Returns true
if the edge can be flipped (only available for edge shared by two faces with 3 vertices)
Definition at line 1945 of file qgstopologicalmesh.cpp.
QList< int > QgsTopologicalMesh::facesAroundVertex | ( | int | vertexIndex | ) | const |
Returns the indexes of faces that are around the vertex with index vertexIndex.
Definition at line 1812 of file qgstopologicalmesh.cpp.
QgsMeshEditingError QgsTopologicalMesh::facesCanBeAdded | ( | const TopologicalFaces & | topologicalFaces | ) | const |
Returns whether the faces can be added to the mesh.
Definition at line 1529 of file qgstopologicalmesh.cpp.
QgsMeshEditingError QgsTopologicalMesh::facesCanBeRemoved | ( | const QList< int > & | facesIndexes | ) |
Returns whether faces with index in faceIndexes can be removed/ The method an error object with type QgsMeshEditingError::NoError if the faces can be removed, otherwise returns the corresponding error.
Definition at line 1819 of file qgstopologicalmesh.cpp.
int QgsTopologicalMesh::firstFaceLinked | ( | int | vertexIndex | ) | const |
Returns the index of the first face linked, returns -1 if it is a free vertex or out of range index.
Definition at line 606 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::flipEdge | ( | int | vertexIndex1, |
int | vertexIndex2 | ||
) |
Flips edge (vertexIndex1, vertexIndex2) The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 1986 of file qgstopologicalmesh.cpp.
QList< int > QgsTopologicalMesh::freeVerticesIndexes | ( | ) | const |
Returns a list of vertices are not linked to any faces.
Definition at line 634 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::insertVertexInFacesEdge | ( | int | faceIndex, |
int | position, | ||
const QgsMeshVertex & | vertex | ||
) |
Inserts a vertex in the edge of face with index faceIndex at position .
The faces that are on each side of the edge are removed and replaced by new faces constructed by a triangulation.
Definition at line 2363 of file qgstopologicalmesh.cpp.
bool QgsTopologicalMesh::isVertexFree | ( | int | vertexIndex | ) | const |
Returns whether the vertex is a free vertex.
Definition at line 623 of file qgstopologicalmesh.cpp.
bool QgsTopologicalMesh::isVertexOnBoundary | ( | int | vertexIndex | ) | const |
Returns whether the vertex is on a boundary.
Definition at line 613 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::merge | ( | int | vertexIndex1, |
int | vertexIndex2 | ||
) |
Merges faces separated by vertices with indexes vertexIndex1 and vertexIndex2 The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 2123 of file qgstopologicalmesh.cpp.
QgsMesh * QgsTopologicalMesh::mesh | ( | ) | const |
Returns a pointer to the wrapped mesh.
Definition at line 601 of file qgstopologicalmesh.cpp.
QVector< int > QgsTopologicalMesh::neighborsOfFace | ( | int | faceIndex | ) | const |
Returns the indexes of neighbor faces of the face with index faceIndex.
Definition at line 1807 of file qgstopologicalmesh.cpp.
void QgsTopologicalMesh::reindex | ( | ) |
Reindexes faces and vertices, after this operation, the topological mesh can't be edited anymore and only the method mesh can be used to access to the raw mesh.
Definition at line 719 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::removeFaces | ( | const QList< int > & | facesIndexes | ) |
Removes faces with index in faceIndexes.
The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 1838 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::removeVertexFillHole | ( | int | vertexIndex | ) |
Removes the vertex with index vertexIndex.
If the vertex in linked with faces, the operation leads also to remove the faces. In this case, the hole is filled by a triangulation. The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 1183 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::removeVertices | ( | const QList< int > & | vertices | ) |
Removes all the vertices with index in the list vertices If vertices in linked with faces, the operation leads also to remove the faces without filling holes.
The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 1499 of file qgstopologicalmesh.cpp.
bool QgsTopologicalMesh::renumber | ( | ) |
Renumbers the indexes of vertices and faces using the Reverse CutHill McKee Algorithm.
Definition at line 769 of file qgstopologicalmesh.cpp.
void QgsTopologicalMesh::reverseChanges | ( | const Changes & | changes | ) |
Reverses the changes.
Definition at line 442 of file qgstopologicalmesh.cpp.
QgsTopologicalMesh::Changes QgsTopologicalMesh::splitFace | ( | int | faceIndex | ) |
Splits face with index faceIndex The method returns a instance of the class QgsTopologicalMesh::Change that can be used to reverse or reapply the operation.
Definition at line 2220 of file qgstopologicalmesh.cpp.
QgsMeshVertexCirculator QgsTopologicalMesh::vertexCirculator | ( | int | vertexIndex | ) | const |
Returns a vertex circulator linked to this mesh around the vertex with index vertexIndex.
Definition at line 516 of file qgstopologicalmesh.cpp.
|
friend |
Definition at line 376 of file qgstopologicalmesh.h.