QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Friends | List of all members
QgsMeshTransformVerticesByExpression Class Reference

Class that can transform vertices of a mesh by expression. More...

#include <qgsmeshadvancedediting.h>

Inheritance diagram for QgsMeshTransformVerticesByExpression:
Inheritance graph
[legend]

Public Member Functions

 QgsMeshTransformVerticesByExpression ()=default
 Constructor. More...
 
bool calculate (QgsMeshLayer *layer)
 Calculates the transformed vertices of the mesh layer, returns false if this leads to topological or geometrical errors. More...
 
void setExpressions (const QString &expressionX, const QString &expressionY, const QString &expressionZ)
 Sets the expressions for the coordinates transformation. More...
 
QString text () const override
 Returns a short text string describing what this advanced edit does. Default implementation return a void string. More...
 
QgsMeshVertex transformedVertex (QgsMeshLayer *layer, int vertexIndex) const
 Returns the transformed vertex from its index vertexIndex for the mesh layer. More...
 
- Public Member Functions inherited from QgsMeshAdvancedEditing
 QgsMeshAdvancedEditing ()
 Constructor. More...
 
virtual ~QgsMeshAdvancedEditing ()
 Destructor. More...
 
void clear ()
 Removes all data provided to the editing or created by the editing. More...
 
virtual bool isFinished () const
 Returns whether the advanced edit is finished, if not, this edit has to be applied again with QgsMeshEditor::advancedEdit() until is finished returns true. More...
 
QString message () const
 Returns a message that can be provided by the advanced editing when applying is done. More...
 
void setInputFaces (const QList< int > faceIndexes)
 Sets the input faces indexes that will be used for the editing. More...
 
void setInputVertices (const QList< int > verticesIndexes)
 Sets the input vertices indexes that will be used for the editing. More...
 
virtual QString text () const
 Returns a short text string describing what this advanced edit does. Default implementation return a void string. More...
 
- Public Member Functions inherited from QgsTopologicalMesh::Changes
QVector< QgsMeshFaceaddedFaces () const
 Returns the face that are added with this changes. More...
 
QVector< QgsMeshVertexaddedVertices () const
 Returns the added vertices with this changes. More...
 
QList< int > changedCoordinatesVerticesIndexes () const
 Returns the indexes of vertices that have changed coordinates. More...
 
bool isEmpty () const
 Returns whether changes are empty, that there is nothing to change. More...
 
QList< int > nativeFacesIndexesGeometryChanged () const
 Returns a list of the native face indexes that have a geometry changed. More...
 
QList< QgsPointXYnewVerticesXYValues () const
 Returns the new (X,Y) values of vertices that have changed their coordinates. More...
 
QList< double > newVerticesZValues () const
 Returns the new Z values of vertices that have changed their coordinates. More...
 
QList< QgsPointXYoldVerticesXYValues () const
 Returns the old (X,Y) values of vertices that have changed their coordinates. More...
 
QList< int > removedFaceIndexes () const
 Returns the indexes of the faces that are removed with this changes. More...
 
QVector< QgsMeshFaceremovedFaces () const
 Returns the faces that are removed with this changes. More...
 
QList< int > verticesToRemoveIndexes () const
 Returns the indexes of vertices to remove. More...
 

Friends

class TestQgsMeshEditor
 

Additional Inherited Members

virtual QgsTopologicalMesh::Changes apply (QgsMeshEditor *meshEditor)=0
 Apply a change to mesh Editor. More...
 
- Protected Member Functions inherited from QgsTopologicalMesh::Changes
void clearChanges ()
 Clears all changes. More...
 
- Protected Attributes inherited from QgsMeshAdvancedEditing
QList< int > mInputFaces
 
QList< int > mInputVertices
 
bool mIsFinished = false
 
QString mMessage
 
- Protected Attributes inherited from QgsTopologicalMesh::Changes
int mAddedFacesFirstIndex = 0
 
QList< int > mChangeCoordinateVerticesIndexes
 
QList< int > mFaceIndexesToRemove
 
QVector< FaceNeighborsmFacesNeighborhoodToAdd
 
QVector< FaceNeighborsmFacesNeighborhoodToRemove
 
QVector< QgsMeshFacemFacesToAdd
 
QVector< QgsMeshFacemFacesToRemove
 
QList< int > mNativeFacesIndexesGeometryChanged
 
QList< std::array< int, 4 > > mNeighborhoodChanges
 
QList< QgsPointXYmNewXYValues
 
QList< double > mNewZValues
 
QList< QgsPointXYmOldXYValues
 
QList< double > mOldZValues
 
QList< QgsMeshVertexmRemovedVertices
 
QVector< int > mVertexToFaceToAdd
 
QVector< QgsMeshVertexmVerticesToAdd
 
QList< std::array< int, 3 > > mVerticesToFaceChanges
 
QList< int > mVerticesToFaceRemoved
 
QList< int > mVerticesToRemoveIndexes
 

Detailed Description

Class that can transform vertices of a mesh by expression.

Each coordinates are associated with an expression that can be defined with function returning the current coordinates (see setExpressions()):

Example: Transposing a mesh and translate following axe X with a distance of 50 and increase the level of the mesh with an height of 80 when previous X coordinate is under 100 and de crease the level of 150 when X is under 100:

expressionX: "$vertex_y + 50" expressionY: "$vertex_x" expressionZ: "if( $vertex_x <= 100 , $vertex_z + 80 , $vertex_z - 150)"

Since
QGIS 3.22

Definition at line 162 of file qgsmeshadvancedediting.h.

Constructor & Destructor Documentation

◆ QgsMeshTransformVerticesByExpression()

QgsMeshTransformVerticesByExpression::QgsMeshTransformVerticesByExpression ( )
default

Constructor.

Member Function Documentation

◆ calculate()

bool QgsMeshTransformVerticesByExpression::calculate ( QgsMeshLayer layer)

Calculates the transformed vertices of the mesh layer, returns false if this leads to topological or geometrical errors.

The mesh layer must be in edit mode.

Note
this method not apply new vertices to the mesh layer but only store the calculated transformation that can be apply later with QgsMeshEditor::advancedEdit()

Definition at line 626 of file qgsmeshadvancedediting.cpp.

◆ setExpressions()

void QgsMeshTransformVerticesByExpression::setExpressions ( const QString &  expressionX,
const QString &  expressionY,
const QString &  expressionZ 
)

Sets the expressions for the coordinates transformation.

Note
Expressions are optional for each coordinate, the coordinate will not be transformed if the string is void.

Definition at line 766 of file qgsmeshadvancedediting.cpp.

◆ text()

QString QgsMeshTransformVerticesByExpression::text ( ) const
overridevirtual

Returns a short text string describing what this advanced edit does. Default implementation return a void string.

Reimplemented from QgsMeshAdvancedEditing.

Definition at line 761 of file qgsmeshadvancedediting.cpp.

◆ transformedVertex()

QgsMeshVertex QgsMeshTransformVerticesByExpression::transformedVertex ( QgsMeshLayer layer,
int  vertexIndex 
) const

Returns the transformed vertex from its index vertexIndex for the mesh layer.

If layer is not the same than the one used to make the calculation, this will create an undefined behavior

Definition at line 782 of file qgsmeshadvancedediting.cpp.

Friends And Related Function Documentation

◆ TestQgsMeshEditor

friend class TestQgsMeshEditor
friend

Definition at line 202 of file qgsmeshadvancedediting.h.


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