QgsMeshAdvancedEditing Class Reference

Abstract class that can be derived to implement advanced editing on mesh. More...

#include <qgsmeshadvancedediting.h>

Inheritance diagram for QgsMeshAdvancedEditing:

Public Member Functions
	QgsMeshAdvancedEditing ()
virtual	~QgsMeshAdvancedEditing ()
void	clear ()
	Removes all data provided to the editing or created by the editing.
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.
QString	message () const
	Returns a message that can be provided by the advanced editing when applying is done.
void	setInputFaces (const QList< int > faceIndexes)
	Sets the input faces indexes that will be used for the editing.
void	setInputVertices (const QList< int > verticesIndexes)
	Sets the input vertices indexes that will be used for the editing.
virtual QString	text () const
	Returns a short text string describing what this advanced edit does. Default implementation return a void string.
Public Member Functions inherited from QgsTopologicalMesh::Changes
QVector< QgsMeshFace >	addedFaces () const
	Returns the face that are added with this changes.
QVector< QgsMeshVertex >	addedVertices () const
	Returns the added vertices with this changes.
QList< int >	changedCoordinatesVerticesIndexes () const
	Returns the indexes of vertices that have changed coordinates.
bool	isEmpty () const
	Returns whether changes are empty, that there is nothing to change.
QList< int >	nativeFacesIndexesGeometryChanged () const
	Returns a list of the native face indexes that have a geometry changed.
QList< QgsPointXY >	newVerticesXYValues () const
	Returns the new (X,Y) values of vertices that have changed their coordinates.
QList< double >	newVerticesZValues () const
	Returns the new Z values of vertices that have changed their coordinates.
QList< QgsPointXY >	oldVerticesXYValues () const
	Returns the old (X,Y) values of vertices that have changed their coordinates.
QList< int >	removedFaceIndexes () const
	Returns the indexes of the faces that are removed with this changes.
QVector< QgsMeshFace >	removedFaces () const
	Returns the faces that are removed with this changes.
QList< int >	verticesToRemoveIndexes () const
	Returns the indexes of vertices to remove.

Protected Member Functions
virtual QgsTopologicalMesh::Changes	apply (QgsMeshEditor *meshEditor)=0
	Apply a change to mesh Editor.
Protected Member Functions inherited from QgsTopologicalMesh::Changes
void	clearChanges ()
	Clears all changes.

Protected Attributes
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< FaceNeighbors >	mFacesNeighborhoodToAdd
QVector< FaceNeighbors >	mFacesNeighborhoodToRemove
QVector< QgsMeshFace >	mFacesToAdd
QVector< QgsMeshFace >	mFacesToRemove
QList< int >	mNativeFacesIndexesGeometryChanged
QList< std::array< int, 4 > >	mNeighborhoodChanges
QList< QgsPointXY >	mNewXYValues
QList< double >	mNewZValues
QList< QgsPointXY >	mOldXYValues
QList< double >	mOldZValues
QList< QgsMeshVertex >	mRemovedVertices
QVector< int >	mVertexToFaceToAdd
QVector< QgsMeshVertex >	mVerticesToAdd
QList< std::array< int, 3 > >	mVerticesToFaceChanges
QList< int >	mVerticesToFaceRemoved
QList< int >	mVerticesToRemoveIndexes

Friends
class	QgsMeshEditor

Detailed Description

Abstract class that can be derived to implement advanced editing on mesh.

To apply the advanced editing, a pointer to an instance of a derived class is passed in the method QgsMeshEditor::advancedEdit().

Since

QGIS 3.22

Definition at line 38 of file qgsmeshadvancedediting.h.

Constructor & Destructor Documentation

QgsMeshAdvancedEditing()

QgsMeshAdvancedEditing::QgsMeshAdvancedEditing ( )

default

~QgsMeshAdvancedEditing()

QgsMeshAdvancedEditing::~QgsMeshAdvancedEditing ( )

virtualdefault

Member Function Documentation

apply()

virtual QgsTopologicalMesh::Changes QgsMeshAdvancedEditing::apply ( QgsMeshEditor *  meshEditor )

protectedpure virtual

Apply a change to mesh Editor.

This method is called by the QgsMeshEditor to apply the editing on the topological mesh

The method has to be implemented in the derived class to provide the changes of the advanced editing

clear()

void QgsMeshAdvancedEditing::clear

(

)

Removes all data provided to the editing or created by the editing.

Definition at line 46 of file qgsmeshadvancedediting.cpp.

isFinished()

bool QgsMeshAdvancedEditing::isFinished ( ) const

virtual

Returns whether the advanced edit is finished, if not, this edit has to be applied again with QgsMeshEditor::advancedEdit() until is finished returns true.

Reimplemented in QgsMeshEditForceByPolylines.

Definition at line 55 of file qgsmeshadvancedediting.cpp.

message()

QString QgsMeshAdvancedEditing::message

(

)

const

Returns a message that can be provided by the advanced editing when applying is done.

Definition at line 41 of file qgsmeshadvancedediting.cpp.

setInputFaces()

void QgsMeshAdvancedEditing::setInputFaces

(

const QList< int >

faceIndexes

)

Sets the input faces indexes that will be used for the editing.

Definition at line 36 of file qgsmeshadvancedediting.cpp.

setInputVertices()

void QgsMeshAdvancedEditing::setInputVertices

(

const QList< int >

verticesIndexes

)

Sets the input vertices indexes that will be used for the editing.

Definition at line 31 of file qgsmeshadvancedediting.cpp.

text()

QString QgsMeshAdvancedEditing::text ( ) const

virtual

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

Reimplemented in QgsMeshEditingDelaunayTriangulation, QgsMeshEditRefineFaces, QgsMeshTransformVerticesByExpression, and QgsMeshEditForceByPolylines.

Definition at line 60 of file qgsmeshadvancedediting.cpp.

Friends And Related Symbol Documentation

QgsMeshEditor

friend class QgsMeshEditor

friend

Definition at line 79 of file qgsmeshadvancedediting.h.

Member Data Documentation

mInputFaces

QList<int> QgsMeshAdvancedEditing::mInputFaces

protected

Definition at line 68 of file qgsmeshadvancedediting.h.

mInputVertices

QList<int> QgsMeshAdvancedEditing::mInputVertices

protected

Definition at line 67 of file qgsmeshadvancedediting.h.

mIsFinished

bool QgsMeshAdvancedEditing::mIsFinished = false

protected

Definition at line 70 of file qgsmeshadvancedediting.h.

mMessage

QString QgsMeshAdvancedEditing::mMessage

protected

Definition at line 69 of file qgsmeshadvancedediting.h.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/mesh/qgsmeshadvancedediting.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/mesh/qgsmeshadvancedediting.cpp