QGIS API Documentation  3.17.0-Master (a035f434f4)
Public Member Functions | List of all members
QgsMeshDataSourceInterface Class Referenceabstract

Interface for mesh data sources. More...

#include <qgsmeshdataprovider.h>

Inheritance diagram for QgsMeshDataSourceInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsMeshDataSourceInterface ()=default
 Dtor. More...
 
bool contains (const QgsMesh::ElementType &type) const
 Returns whether the mesh contains at mesh elements of given type. More...
 
virtual int edgeCount () const =0
 Returns number of edges in the native mesh. More...
 
virtual int faceCount () const =0
 Returns number of faces in the native mesh. More...
 
virtual void populateMesh (QgsMesh *mesh) const =0
 Populates the mesh vertices, edges and faces. More...
 
virtual int vertexCount () const =0
 Returns number of vertices in the native mesh. More...
 

Detailed Description

Interface for mesh data sources.

Mesh is a collection of vertices, edges and faces in 2D or 3D space

Base on the underlying data provider/format, whole mesh is either stored in memory or read on demand

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.2

Definition at line 134 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ ~QgsMeshDataSourceInterface()

virtual QgsMeshDataSourceInterface::~QgsMeshDataSourceInterface ( )
virtualdefault

Dtor.

Member Function Documentation

◆ contains()

bool QgsMeshDataSourceInterface::contains ( const QgsMesh::ElementType type) const

Returns whether the mesh contains at mesh elements of given type.

Since
QGIS 3.14

Definition at line 184 of file qgsmeshdataprovider.cpp.

◆ edgeCount()

virtual int QgsMeshDataSourceInterface::edgeCount ( ) const
pure virtual

Returns number of edges in the native mesh.

Returns
Number of edges in the mesh
Since
QGIS 3.14

◆ faceCount()

virtual int QgsMeshDataSourceInterface::faceCount ( ) const
pure virtual

Returns number of faces in the native mesh.

Returns
Number of faces in the mesh

◆ populateMesh()

virtual void QgsMeshDataSourceInterface::populateMesh ( QgsMesh mesh) const
pure virtual

Populates the mesh vertices, edges and faces.

Since
QGIS 3.6

◆ vertexCount()

virtual int QgsMeshDataSourceInterface::vertexCount ( ) const
pure virtual

Returns number of vertices in the native mesh.

Returns
Number of vertices in the mesh

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