QGIS API Documentation 3.29.0-Master (8c80f25a4f)
Public Member Functions | List of all members
QgsMeshZValueDataset Class Reference

Convenient class that can be used to obtain a dataset that represents the Z values of mesh vertices. More...

#include <qgsmeshtriangulation.h>

Inheritance diagram for QgsMeshZValueDataset:
Inheritance graph
[legend]

Public Member Functions

 QgsMeshZValueDataset (const QgsMesh &mesh)
 Constructor with the mesh. More...
 
QgsMeshDataBlock areFacesActive (int faceIndex, int count) const override
 Returns whether faces are active. More...
 
QgsMeshDatasetValue datasetValue (int valueIndex) const override
 Returns the value with index valueIndex. More...
 
QgsMeshDataBlock datasetValues (bool isScalar, int valueIndex, int count) const override
 Returns count values from valueIndex. More...
 
bool isActive (int faceIndex) const override
 Returns whether the face is active. More...
 
QgsMeshDatasetMetadata metadata () const override
 Returns the metadata of the dataset. More...
 
int valuesCount () const override
 Returns the values count. More...
 
- Public Member Functions inherited from QgsMeshDataset
 QgsMeshDataset ()=default
 Constructor. More...
 
virtual ~QgsMeshDataset ()=default
 Destructor. More...
 
virtual QgsMeshDataBlock areFacesActive (int faceIndex, int count) const =0
 Returns whether faces are active. More...
 
virtual QgsMeshDatasetValue datasetValue (int valueIndex) const =0
 Returns the value with index valueIndex. More...
 
virtual QgsMeshDataBlock datasetValues (bool isScalar, int valueIndex, int count) const =0
 Returns count values from valueIndex. More...
 
virtual bool isActive (int faceIndex) const =0
 Returns whether the face is active. More...
 
virtual QgsMeshDatasetMetadata metadata () const =0
 Returns the metadata of the dataset. More...
 
virtual int valuesCount () const =0
 Returns the values count. More...
 

Detailed Description

Convenient class that can be used to obtain a dataset that represents the Z values of mesh vertices.

Since
QGIS 3.16

Definition at line 111 of file qgsmeshtriangulation.h.

Constructor & Destructor Documentation

◆ QgsMeshZValueDataset()

QgsMeshZValueDataset::QgsMeshZValueDataset ( const QgsMesh mesh)

Constructor with the mesh.

Definition at line 284 of file qgsmeshtriangulation.cpp.

Member Function Documentation

◆ areFacesActive()

QgsMeshDataBlock QgsMeshZValueDataset::areFacesActive ( int  faceIndex,
int  count 
) const
overridevirtual

Returns whether faces are active.

Implements QgsMeshDataset.

Definition at line 314 of file qgsmeshtriangulation.cpp.

◆ datasetValue()

QgsMeshDatasetValue QgsMeshZValueDataset::datasetValue ( int  valueIndex) const
overridevirtual

Returns the value with index valueIndex.

Implements QgsMeshDataset.

Definition at line 295 of file qgsmeshtriangulation.cpp.

◆ datasetValues()

QgsMeshDataBlock QgsMeshZValueDataset::datasetValues ( bool  isScalar,
int  valueIndex,
int  count 
) const
overridevirtual

Returns count values from valueIndex.

Implements QgsMeshDataset.

Definition at line 303 of file qgsmeshtriangulation.cpp.

◆ isActive()

bool QgsMeshZValueDataset::isActive ( int  faceIndex) const
overridevirtual

Returns whether the face is active.

Implements QgsMeshDataset.

Definition at line 323 of file qgsmeshtriangulation.cpp.

◆ metadata()

QgsMeshDatasetMetadata QgsMeshZValueDataset::metadata ( ) const
overridevirtual

Returns the metadata of the dataset.

Implements QgsMeshDataset.

Definition at line 328 of file qgsmeshtriangulation.cpp.

◆ valuesCount()

int QgsMeshZValueDataset::valuesCount ( ) const
overridevirtual

Returns the values count.

Implements QgsMeshDataset.

Definition at line 333 of file qgsmeshtriangulation.cpp.


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