Class derived from QgsMeshEditForceByLine that forces mesh based on polyline. More...

#include <qgsmeshforcebypolylines.h>

Inheritance diagram for QgsMeshEditForceByPolylines:

Public Member Functions
	QgsMeshEditForceByPolylines ()=default
	Constructor.

void	addLineFromGeometry (const QgsGeometry &geom)
	Adds a input forcing line geometry in rendering coordinates.

void	addLinesFromGeometries (const QList< QgsGeometry > geometries)
	Adds a list of input forcing lines geometry in rendering coordinates.

bool	isFinished () const override
	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	text () const override
	Returns a short text string describing what this advanced edit does. Default implementation return a void string.

Public Member Functions inherited from QgsMeshEditForceByLine
	QgsMeshEditForceByLine ()=default
	Constructor.

void	setAddVertexOnIntersection (bool addVertex)
	Sets whether vertices will be added when the lines will intersect internal edges of faces, default is `false`.

void	setDefaultZValue (double defaultZValue)
	Sets the default value of Z coordinate to use for new vertices, this value will be used if the Z value.

void	setInputLine (const QgsPoint &pt1, const QgsPoint &pt2, double tolerance, bool newVertexOnIntersection)
	Sets the input forcing line in rendering coordinates.

void	setInterpolateZValueOnMesh (bool interpolateZValueOnMesh)
	Sets whether the new created vertices will have their value interpolated from the existing mesh.

void	setTolerance (double tolerance)
	Sets the tolerance in redering coordinate system unit.

Public Member Functions inherited from QgsMeshAdvancedEditing
	QgsMeshAdvancedEditing ()
	Constructor.

virtual	~QgsMeshAdvancedEditing ()
	Destructor.

void	clear ()
	Removes all data provided to the editing or created by the editing.

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.

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.

Additional Inherited Members
Protected Member Functions inherited from QgsTopologicalMesh::Changes
void	clearChanges ()
	Clears all changes.

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

Detailed Description

Class derived from QgsMeshEditForceByLine that forces mesh based on polyline.

Forcing lines consist of line that the faces are forced to follow, that is edges of encountered faces have to be on theses lines.

Caller of this class has to add the lines from QgsGeometry instances with addLineFromGeometry() or addLinesFromGeometries() before applying the edition with QgsMeshEditor::advancedEdit()

Since: QGIS 3.22

Definition at line 144 of file qgsmeshforcebypolylines.h.

Constructor & Destructor Documentation

◆ QgsMeshEditForceByPolylines()

QgsMeshEditForceByPolylines::QgsMeshEditForceByPolylines ( )

default

Constructor.

Member Function Documentation

◆ addLineFromGeometry()

void QgsMeshEditForceByPolylines::addLineFromGeometry ( const QgsGeometry & geom )

Adds a input forcing line geometry in rendering coordinates.

Note: if the geometry is not 3D, the default Z value will be used for the Z value of the geometry's vertices. This default Z value has to be set before adding the geometry (

See also: setDefaultZValue()

Definition at line 1152 of file qgsmeshforcebypolylines.cpp.

◆ addLinesFromGeometries()

void QgsMeshEditForceByPolylines::addLinesFromGeometries ( const QList< QgsGeometry > geometries )

Adds a list of input forcing lines geometry in rendering coordinates.

Note: if the geometry is not 3D, the default Z value will be used for the Z value of the geometry's vertices. This default Z value has to be set before adding the geometry (

See also: setDefaultZValue()

Definition at line 1212 of file qgsmeshforcebypolylines.cpp.

◆ isFinished()

bool QgsMeshEditForceByPolylines::isFinished ( ) const

overridevirtual

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 from QgsMeshAdvancedEditing.

Definition at line 1118 of file qgsmeshforcebypolylines.cpp.