QgsMeshUtils Class Reference

Provides utility functions for working with mesh data. More...

#include <qgsmeshutils.h>

Static Public Member Functions
static QgsMeshVertex	centroid (const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
	Returns the centroid of the face.
static QgsRasterBlock *	exportRasterBlock (const QgsMeshLayer &layer, const QgsMeshDatasetIndex &datasetIndex, const QgsCoordinateReferenceSystem &destinationCrs, const QgsCoordinateTransformContext &transformContext, double mapUnitsPerPixel, const QgsRectangle &extent, QgsRasterBlockFeedback *feedback=nullptr)
	Exports mesh layer's dataset values as raster block.
static QgsRasterBlock *	exportRasterBlock (const QgsTriangularMesh &triangularMesh, const QgsMeshDataBlock &datasetValues, const QgsMeshDataBlock &activeFlags, const QgsMeshDatasetGroupMetadata::DataType dataType, const QgsCoordinateTransform &transform, double mapUnitsPerPixel, const QgsRectangle &extent, QgsRasterBlockFeedback *feedback=nullptr)
	Exports mesh layer's dataset values as raster block.
static bool	isInTriangleFace (const QgsPointXY point, const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
	Tests if point p is on the face defined with vertices.
static QSet< int >	nativeEdgesFromEdges (const QList< int > &edgesIndexes, const QVector< int > &edgesToNativeEdges)
	Returns unique native faces indexes from list of triangle indexes.
static QSet< int >	nativeFacesFromTriangles (const QList< int > &triangleIndexes, const QVector< int > &trianglesToNativeFaces)
	Returns unique native faces indexes from list of triangle indexes.
static QSet< int >	nativeVerticesFromEdges (const QList< int > &edgesIndexes, const QVector< QgsMeshEdge > &edges)
	Returns unique native faces indexes from list of vertices of triangles.
static QSet< int >	nativeVerticesFromTriangles (const QList< int > &triangleIndexes, const QVector< QgsMeshFace > &triangles)
	Returns unique native vertex indexes from list of vertices of triangles.
static void	setCounterClockwise (QgsMeshFace &triangle, const QgsMeshVertex &v0, const QgsMeshVertex &v1, const QgsMeshVertex &v2)
	Checks if the triangle is counter clockwise, if not sets it counter clockwise.
static QgsGeometry	toGeometry (const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
	Returns face as polygon geometry.
static std::unique_ptr< QgsPolygon >	toPolygon (const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
	Returns face as polygon geometry, caller is responsible for delete.

Detailed Description

Provides utility functions for working with mesh data.

Since

QGIS 3.0

Definition at line 59 of file qgsmeshutils.h.

Member Function Documentation

centroid()

QgsMeshVertex QgsMeshUtils::centroid ( const QgsMeshFace &  face, const QVector< QgsMeshVertex > &  vertices  )

static

Returns the centroid of the face.

Note

Not available in Python bindings

Definition at line 290 of file qgsmeshutils.cpp.

exportRasterBlock() [1/2]

QgsRasterBlock * QgsMeshUtils::exportRasterBlock ( const QgsMeshLayer &  layer, const QgsMeshDatasetIndex &  datasetIndex, const QgsCoordinateReferenceSystem &  destinationCrs, const QgsCoordinateTransformContext &  transformContext, double  mapUnitsPerPixel, const QgsRectangle &  extent, QgsRasterBlockFeedback *  feedback = nullptr  )

static

Exports mesh layer's dataset values as raster block.

The function always fetches native mesh and dataset data from data provider and calculates triangular mesh

Parameters

layer	mesh layer
datasetIndex	index from layer defining group and dataset (time) to export
destinationCrs	destination/map CRS. Used to create triangular mesh from native mesh
transformContext	Transform context to transform layer CRS to destination CRS
mapUnitsPerPixel	map units per pixel for block
extent	extent of block in destination CRS
feedback	optional raster feedback object for cancellation/preview

Returns

raster block with Float::64 values. nullptr on error

Since

QGIS 3.6

Definition at line 31 of file qgsmeshutils.cpp.

exportRasterBlock() [2/2]

QgsRasterBlock * QgsMeshUtils::exportRasterBlock ( const QgsTriangularMesh &  triangularMesh, const QgsMeshDataBlock &  datasetValues, const QgsMeshDataBlock &  activeFlags, const QgsMeshDatasetGroupMetadata::DataType  dataType, const QgsCoordinateTransform &  transform, double  mapUnitsPerPixel, const QgsRectangle &  extent, QgsRasterBlockFeedback *  feedback = nullptr  )

static

Exports mesh layer's dataset values as raster block.

Parameters

triangularMesh	the triangular mesh of the mesh layer
datasetValues	dataset values used to build the raster block
activeFlags	active flag values
dataType	the data type iof the dataset values
transform	the coordinate transform used to export the raster block
mapUnitsPerPixel	map units per pixel for block
extent	extent of block in destination CRS
feedback	optional raster feedback object for cancellation/preview

Returns

raster block with Float::64 values. nullptr on error

Since

QGIS 3.18

Definition at line 97 of file qgsmeshutils.cpp.

isInTriangleFace()

bool QgsMeshUtils::isInTriangleFace ( const QgsPointXY  point, const QgsMeshFace &  face, const QVector< QgsMeshVertex > &  vertices  )

static

Tests if point p is on the face defined with vertices.

Note

Not available in Python bindings

Since

QGIS 3.12

Definition at line 194 of file qgsmeshutils.cpp.

nativeEdgesFromEdges()

QSet< int > QgsMeshUtils::nativeEdgesFromEdges ( const QList< int > &  edgesIndexes, const QVector< int > &  edgesToNativeEdges  )

static

Returns unique native faces indexes from list of triangle indexes.

Note

Not available in Python bindings

Since

QGIS 3.14

Definition at line 177 of file qgsmeshutils.cpp.

nativeFacesFromTriangles()

QSet< int > QgsMeshUtils::nativeFacesFromTriangles ( const QList< int > &  triangleIndexes, const QVector< int > &  trianglesToNativeFaces  )

static

Returns unique native faces indexes from list of triangle indexes.

Note

Not available in Python bindings

Since

QGIS 3.4

Definition at line 172 of file qgsmeshutils.cpp.

nativeVerticesFromEdges()

QSet< int > QgsMeshUtils::nativeVerticesFromEdges ( const QList< int > &  edgesIndexes, const QVector< QgsMeshEdge > &  edges  )

static

Returns unique native faces indexes from list of vertices of triangles.

Note

Not available in Python bindings

Since

QGIS 3.14

Definition at line 226 of file qgsmeshutils.cpp.

nativeVerticesFromTriangles()

QSet< int > QgsMeshUtils::nativeVerticesFromTriangles ( const QList< int > &  triangleIndexes, const QVector< QgsMeshFace > &  triangles  )

static

Returns unique native vertex indexes from list of vertices of triangles.

Note

Not available in Python bindings

Since

QGIS 3.14

Definition at line 212 of file qgsmeshutils.cpp.

setCounterClockwise()

void QgsMeshUtils::setCounterClockwise ( QgsMeshFace &  triangle, const QgsMeshVertex &  v0, const QgsMeshVertex &  v1, const QgsMeshVertex &  v2  )

static

Checks if the triangle is counter clockwise, if not sets it counter clockwise.

Note

Not available in Python bindings

Since

QGIS 3.22

Definition at line 305 of file qgsmeshutils.cpp.

toGeometry()

QgsGeometry QgsMeshUtils::toGeometry ( const QgsMeshFace &  face, const QVector< QgsMeshVertex > &  vertices  )

static

Returns face as polygon geometry.

Note

Not available in Python bindings

Definition at line 153 of file qgsmeshutils.cpp.

toPolygon()

std::unique_ptr< QgsPolygon > QgsMeshUtils::toPolygon ( const QgsMeshFace &  face, const QVector< QgsMeshVertex > &  vertices  )

static

Returns face as polygon geometry, caller is responsible for delete.

Note

Not available in Python bindings

Definition at line 138 of file qgsmeshutils.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/mesh/qgsmeshutils.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/mesh/qgsmeshutils.cpp