Represents a mesh layer supporting display of data on structured or unstructured meshes. More...

#include <qgsmeshlayer.h>

Inheritance diagram for QgsMeshLayer:

Classes
struct	LayerOptions
	Setting options for loading mesh layers. More...

Public Member Functions
	QgsMeshLayer (const QString &path=QString(), const QString &baseName=QString(), const QString &providerLib="mesh_memory", const QgsMeshLayer::LayerOptions &options=QgsMeshLayer::LayerOptions())
	Constructor - creates a mesh layer. More...

	QgsMeshLayer (const QgsMeshLayer &rhs)=delete
	QgsMeshLayer cannot be copied. More...

	~QgsMeshLayer () override

int	activeScalarDataset () const
	Returns active scalar dataset. More...

int	activeVectorDataset () const
	Returns active vector dataset. More...

QgsMeshLayer *	clone () const override
	Returns a new instance equivalent to this one except for the id which is still unique. More...

QgsMapLayerRenderer *	createMapRenderer (QgsRenderContext &rendererContext) override
	Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context. More...

QgsMeshDataProvider *	dataProvider () override
	Returns the layer's data provider. More...

const QgsMeshDataProvider *	dataProvider () const override
	Returns the layer's data provider in a const-correct manner. More...

QString	decodedSource (const QString &source, const QString &provider, const QgsReadWriteContext &context) const override
	Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files. More...

QString	encodedSource (const QString &source, const QgsReadWriteContext &context) const override
	Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files. More...

QgsRectangle	extent () const override
	Returns the extent of the layer. More...

QgsMesh *	nativeMesh ()
	Returns native mesh (nullptr before rendering) More...

QgsMeshLayer &	operator= (QgsMeshLayer const &rhs)=delete
	QgsMeshLayer cannot be copied. More...

QString	providerType () const
	Returns the provider type for this layer. More...

bool	readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context) override
	Read the symbology for the current layer from the Dom node supplied. More...

bool	readXml (const QDomNode &layer_node, QgsReadWriteContext &context) override
	Called by readLayerXML(), used by children to read state specific to them from project files. More...

QgsMeshRendererMeshSettings	rendererNativeMeshSettings () const
	Returns renderer settings. More...

QgsMeshRendererScalarSettings	rendererScalarSettings () const
	Returns renderer settings. More...

QgsMeshRendererMeshSettings	rendererTriangularMeshSettings () const
	Returns renderer settings. More...

QgsMeshRendererVectorSettings	rendererVectorSettings () const
	Returns renderer settings. More...

void	setActiveScalarDataset (int index=NO_ACTIVE_MESH_DATASET)
	Sets active scalar dataset for rendering. More...

void	setActiveVectorDataset (int index=NO_ACTIVE_MESH_DATASET)
	Sets active vector dataset for rendering. More...

void	setRendererNativeMeshSettings (const QgsMeshRendererMeshSettings &settings)
	Sets new renderer settings, triggers repaint. More...

void	setRendererScalarSettings (const QgsMeshRendererScalarSettings &settings)
	Sets new renderer settings, triggers repaint. More...

void	setRendererTriangularMeshSettings (const QgsMeshRendererMeshSettings &settings)
	Sets new renderer settings, triggers repaint. More...

void	setRendererVectorSettings (const QgsMeshRendererVectorSettings &settings)
	Sets new renderer settings, triggers repaint. More...

QgsTriangularMesh *	triangularMesh ()
	Returns triangular mesh (nullptr before rendering) More...

bool	writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context) const override
	Write the symbology for the layer into the docment provided. More...

bool	writeXml (QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const override
	Called by writeLayerXML(), used by children to write state specific to them to project files. More...

Public Member Functions inherited from QgsMapLayer
	QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, const QString &name=QString(), const QString &source=QString())
	Constructor for QgsMapLayer. More...

	QgsMapLayer (QgsMapLayer const &)=delete
	QgsMapLayer cannot be copied. More...

	~QgsMapLayer () override

QString	abstract () const
	Returns the abstract of the layer used by QGIS Server in GetCapabilities request. More...

QString	attribution () const
	Returns the attribution of the layer used by QGIS Server in GetCapabilities request. More...

QString	attributionUrl () const
	Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. More...

int	autoRefreshInterval () const
	Returns the auto refresh interval (in milliseconds). More...

QPainter::CompositionMode	blendMode () const
	Returns the current blending mode for a layer. More...

QgsCoordinateReferenceSystem	crs () const
	Returns the layer's spatial reference system. More...

QVariant	customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const
	Read a custom property from layer. More...

QStringList	customPropertyKeys () const
	Returns list of all keys within custom properties. More...

QString	dataUrl () const
	Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. More...

QString	dataUrlFormat () const
	Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More...

virtual QSet< QgsMapLayerDependency >	dependencies () const
	Gets the list of dependencies. More...

virtual QgsError	error () const
	Gets current status error. More...

void	exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const
	Export the current metadata of this layer as named metadata in a QDomDocument. More...

virtual void	exportNamedStyle (QDomDocument &doc, QString &errorMsg) const
	Export the properties of this layer as named style in a QDomDocument. More...

virtual void	exportSldStyle (QDomDocument &doc, QString &errorMsg) const
	Export the properties of this layer as SLD style in a QDomDocument. More...

bool	hasAutoRefreshEnabled () const
	Returns true if auto refresh is enabled for the layer. More...

bool	hasScaleBasedVisibility () const
	Returns whether scale based visibility is enabled for the layer. More...

virtual QString	htmlMetadata () const
	Obtain a formatted HTML string containing assorted metadata for this layer. More...

QString	id () const
	Returns the layer's unique ID, which is used to access this layer from QgsProject. More...

bool	importNamedMetadata (QDomDocument &document, QString &errorMessage)
	Import the metadata of this layer from a QDomDocument. More...

virtual bool	importNamedStyle (QDomDocument &doc, QString &errorMsg)
	Import the properties of this layer from a QDomDocument. More...

virtual bool	isEditable () const
	Returns true if the layer can be edited. More...

bool	isInScaleRange (double scale) const
	Tests whether the layer should be visible at the specified scale. More...

bool	isRefreshOnNotifyEnabled () const
	Returns true if the refresh on provider nofification is enabled. More...

virtual bool	isSpatial () const
	Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. More...

bool	isValid () const
	Returns the status of the layer. More...

QString	keywordList () const
	Returns the keyword list of the layer used by QGIS Server in GetCapabilities request. More...

QgsMapLayerLegend *	legend () const
	Can be null. More...

QString	legendUrl () const
	Returns the URL for the layer's legend. More...

QString	legendUrlFormat () const
	Returns the format for a URL based layer legend. More...

QString	loadDefaultMetadata (bool &resultFlag)
	Retrieve the default metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users metadata table in their personal qgis.db) More...

virtual QString	loadDefaultStyle (bool &resultFlag)
	Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...

virtual QString	loadNamedMetadata (const QString &uri, bool &resultFlag)
	Retrieve a named metadata for this layer if one exists (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...

bool	loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd)
	Retrieve a named metadata for this layer from a sqlite database. More...

virtual QString	loadNamedStyle (const QString &uri, bool &resultFlag)
	Retrieve a named style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...

virtual bool	loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml)
	Retrieve a named style for this layer from a sqlite database. More...

virtual QString	loadSldStyle (const QString &uri, bool &resultFlag)
	Attempts to style the layer using the formatting from an SLD type file. More...

double	maximumScale () const
	Returns the maximum map scale (i.e. More...

virtual const QgsLayerMetadata &	metadata () const
	Returns a reference to the layer's metadata store. More...

virtual QString	metadataUri () const
	Retrieve the metadata URI for this layer (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...

QString	metadataUrl () const
	Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. More...

QString	metadataUrlFormat () const
	Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. More...

QString	metadataUrlType () const
	Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. More...

double	minimumScale () const
	Returns the minimum map scale (i.e. More...

QString	name () const
	Returns the display name of the layer. More...

QgsMapLayer &	operator= (QgsMapLayer const &)=delete
	QgsMapLayer cannot be copied. More...

QString	publicSource () const
	Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). More...

bool	readLayerXml (const QDomElement &layerElement, QgsReadWriteContext &context)
	Sets state from Dom document. More...

bool	readOnly () const
	Returns if this layer is read only. More...

virtual bool	readSld (const QDomNode &node, QString &errorMessage)

virtual bool	readStyle (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context)
	Read the style for the current layer from the Dom node supplied. More...

QString	refreshOnNotifyMessage () const
	Returns the message that should be notified by the provider to triggerRepaint. More...

virtual void	reload ()
	Synchronises with changes in the datasource. More...

void	removeCustomProperty (const QString &key)
	Remove a custom property from layer. More...

QgsAbstract3DRenderer *	renderer3D () const
	Returns 3D renderer associated with the layer. More...

virtual void	resolveReferences (QgsProject *project)
	Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. More...

virtual QString	saveDefaultMetadata (bool &resultFlag)
	Save the current metadata of this layer as the default metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...

virtual QString	saveDefaultStyle (bool &resultFlag)
	Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...

QString	saveNamedMetadata (const QString &uri, bool &resultFlag)
	Save the current metadata of this layer as a named metadata (either as a .qmd file on disk or as a record in the users style table in their personal qgis.db) More...

virtual QString	saveNamedStyle (const QString &uri, bool &resultFlag)
	Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...

virtual QString	saveSldStyle (const QString &uri, bool &resultFlag) const
	Saves the properties of this layer to an SLD format file. More...

void	setAbstract (const QString &abstract)
	Sets the abstract of the layer used by QGIS Server in GetCapabilities request. More...

void	setAttribution (const QString &attrib)
	Sets the attribution of the layer used by QGIS Server in GetCapabilities request. More...

void	setAttributionUrl (const QString &attribUrl)
	Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. More...

void	setAutoRefreshEnabled (bool enabled)
	Sets whether auto refresh is enabled for the layer. More...

void	setAutoRefreshInterval (int interval)
	Sets the auto refresh interval (in milliseconds) for the layer. More...

void	setBlendMode (QPainter::CompositionMode blendMode)
	Set the blending mode used for rendering a layer. More...

void	setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
	Sets layer's spatial reference system. More...

void	setCustomProperties (const QgsObjectCustomProperties &properties)
	Set custom properties for layer. More...

void	setCustomProperty (const QString &key, const QVariant &value)
	Set a custom property for layer. More...

void	setDataUrl (const QString &dataUrl)
	Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. More...

void	setDataUrlFormat (const QString &dataUrlFormat)
	Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. More...

void	setKeywordList (const QString &keywords)
	Sets the keyword list of the layer used by QGIS Server in GetCapabilities request. More...

virtual void	setLayerOrder (const QStringList &layers)
	Reorders the previously selected sublayers of this layer from bottom to top. More...

void	setLegend (QgsMapLayerLegend *legend)
	Assign a legend controller to the map layer. More...

void	setLegendUrl (const QString &legendUrl)
	Sets the URL for the layer's legend. More...

void	setLegendUrlFormat (const QString &legendUrlFormat)
	Sets the format for a URL based layer legend. More...

virtual void	setMetadata (const QgsLayerMetadata &metadata)
	Sets the layer's metadata store. More...

void	setMetadataUrl (const QString &metaUrl)
	Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. More...

void	setMetadataUrlFormat (const QString &metaUrlFormat)
	Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. More...

void	setMetadataUrlType (const QString &metaUrlType)
	Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More...

void	setName (const QString &name)
	Set the display name of the layer. More...

void	setRenderer3D (QgsAbstract3DRenderer *renderer)
	Sets 3D renderer for the layer. More...

void	setShortName (const QString &shortName)
	Sets the short name of the layer used by QGIS Server to identify the layer. More...

virtual void	setSubLayerVisibility (const QString &name, bool visible)
	Set the visibility of the given sublayer name. More...

void	setTitle (const QString &title)
	Sets the title of the layer used by QGIS Server in GetCapabilities request. More...

QString	shortName () const
	Returns the short name of the layer used by QGIS Server to identify the layer. More...

QString	source () const
	Returns the source for the layer. More...

QgsMapLayerStyleManager *	styleManager () const
	Gets access to the layer's style manager. More...

virtual QString	styleURI () const
	Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...

virtual QStringList	subLayers () const
	Returns the sublayers of this layer. More...

virtual QDateTime	timestamp () const
	Time stamp of data source in the moment when data/metadata were loaded by provider. More...

QString	title () const
	Returns the title of the layer used by QGIS Server in GetCapabilities request. More...

QgsMapLayer::LayerType	type () const
	Returns the type of the layer. More...

QUndoStack *	undoStack ()
	Returns pointer to layer's undo stack. More...

QUndoStack *	undoStackStyles ()
	Returns pointer to layer's style undo stack. More...

bool	writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const
	Stores state in Dom node. More...

virtual bool	writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context) const
	Write just the style information for the layer into the document. More...

Additional Inherited Members
Public Types inherited from QgsMapLayer
enum	LayerType { VectorLayer, RasterLayer, PluginLayer, MeshLayer }
	Types of layers that can be added to a map. More...

enum	PropertyType { Style = 0, Metadata }
	Maplayer has a style and a metadata property. More...

Public Slots inherited from QgsMapLayer
void	emitStyleChanged ()
	Triggers an emission of the styleChanged() signal. More...

virtual bool	setDependencies (const QSet< QgsMapLayerDependency > &layers)
	Sets the list of dependencies. More...

void	setMaximumScale (double scale)
	Sets the maximum map scale (i.e. More...

void	setMinimumScale (double scale)
	Sets the minimum map scale (i.e. More...

void	setRefreshOnNofifyMessage (const QString &message)
	Set the notification message that triggers repaine If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to. More...

void	setRefreshOnNotifyEnabled (bool enabled)
	Set whether provider notification is connected to triggerRepaint. More...

void	setScaleBasedVisibility (bool enabled)
	Sets whether scale based visibility is enabled for the layer. More...

void	triggerRepaint (bool deferredUpdate=false)
	Will advise the map canvas (and any other interested party) that this layer requires to be repainted. More...

Signals inherited from QgsMapLayer
void	autoRefreshIntervalChanged (int interval)
	Emitted when the auto refresh interval changes. More...

void	blendModeChanged (QPainter::CompositionMode blendMode)
	Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() More...

void	configChanged ()
	Emitted whenever the configuration is changed. More...

void	crsChanged ()
	Emit a signal that layer's CRS has been reset. More...

void	dataChanged ()
	Data of layer changed. More...

void	dependenciesChanged ()
	Emitted when dependencies are changed. More...

void	legendChanged ()
	Signal emitted when legend of the layer has changed. More...

void	metadataChanged ()
	Emitted when the layer's metadata is changed. More...

void	nameChanged ()
	Emitted when the name has been changed. More...

void	recalculateExtents () const
	This is used to send a request that any mapcanvas using this layer update its extents. More...

void	renderer3DChanged ()
	Signal emitted when 3D renderer associated with the layer has changed. More...

void	rendererChanged ()
	Signal emitted when renderer is changed. More...

void	repaintRequested (bool deferredUpdate=false)
	By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself. More...

void	statusChanged (const QString &status)
	Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) More...

void	styleChanged ()
	Signal emitted whenever a change affects the layer's style. More...

void	willBeDeleted ()
	Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid state: the last chance for other pieces of code for some cleanup if they use the layer. More...

Static Public Member Functions inherited from QgsMapLayer
static QString	extensionPropertyType (PropertyType type)
	Returns the extension of a Property. More...

static QString	formatLayerName (const QString &name)
	A convenience function to capitalize and format a layer name. More...

Protected Member Functions inherited from QgsMapLayer
void	appendError (const QgsErrorMessage &error)
	Add error message. More...

void	clone (QgsMapLayer *layer) const
	Copies attributes like name, short name, ... More...

bool	hasDependencyCycle (const QSet< QgsMapLayerDependency > &layers) const
	Checks whether a new set of dependencies will introduce a cycle. More...

void	readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context)
	Read style data common to all layer types. More...

void	readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith=QString())
	Read custom properties from project file. More...

void	readStyleManager (const QDomNode &layerNode)
	Read style manager's configuration (if any). To be called by subclasses. More...

void	setError (const QgsError &error)
	Sets error message. More...

virtual void	setExtent (const QgsRectangle &rect)
	Sets the extent. More...

void	setValid (bool valid)
	Sets whether layer is valid or not - should be used in constructor. More...

void	writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const
	Write style data common to all layer types. More...

void	writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const
	Write custom properties to project file. More...

void	writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const
	Write style manager's configuration (if exists). To be called by subclasses. More...

Protected Attributes inherited from QgsMapLayer
QString	mAbstract
	Description of the layer. More...

QString	mAttribution
	Attribution of the layer. More...

QString	mAttributionUrl

QString	mDataSource
	Data source description string, varies by layer type. More...

QString	mDataUrl
	DataUrl of the layer. More...

QString	mDataUrlFormat

QSet< QgsMapLayerDependency >	mDependencies
	List of layers that may modify this layer on modification. More...

QgsError	mError
	Error. More...

QgsRectangle	mExtent
	Extent of the layer. More...

bool	mIsRefreshOnNofifyEnabled = false

QString	mKeywordList

QString	mLayerName
	Name of the layer - used for display. More...

QString	mLegendUrl
	WMS legend. More...

QString	mLegendUrlFormat

QString	mMetadataUrl
	MetadataUrl of the layer. More...

QString	mMetadataUrlFormat

QString	mMetadataUrlType

QString	mRefreshOnNofifyMessage

QString	mShortName

QString	mTitle

bool	mValid = false
	Indicates if the layer is valid and can be drawn. More...

Properties inherited from QgsMapLayer
int	autoRefreshInterval

QgsLayerMetadata	metadata

QString	name

Detailed Description

Represents a mesh layer supporting display of data on structured or unstructured meshes.

The QgsMeshLayer is instantiated by specifying the name of a data provider, such as mdal, and url defining the specific data set to connect to. The vector layer constructor in turn instantiates a QgsMeshDataProvider subclass corresponding to the provider type, and passes it the url. The data provider connects to the data source.

The QgsMeshLayer provides a common interface to the different data types. It does not yet support editing transactions.

The main data providers supported by QGIS are listed below.

Mesh data providers

Memory data providerType (mesh_memory)

The memory data provider is used to construct in memory data, for example scratch data. There is no inherent persistent storage of the data. The data source uri is constructed. Data can be populated by setMesh(const QString &vertices, const QString &faces), where vertices and faces is comma separated coordinates and connections for mesh. E.g. to create mesh with one quad and one triangle

QString uri(
    "1.0, 2.0 \n" \
    "2.0, 2.0 \n" \
    "3.0, 2.0 \n" \
    "2.0, 3.0 \n" \
    "1.0, 3.0 \n" \
    "---"
    "0, 1, 3, 4 \n" \
    "1, 2, 3 \n"
  );
  QgsMeshLayer *scratchLayer = new QgsMeshLayer(uri, "My Scratch layer", "memory_mesh");

MDAL data provider (mdal)

Accesses data using the MDAL drivers (https://github.com/lutraconsulting/MDAL). The url is the MDAL connection string. QGIS must be built with MDAL support to allow this provider.

QString uri = "test/land.2dm";

QgsMeshLayer *scratchLayer = new QgsMeshLayer(uri, "My Scratch Layer", "mdal");

Note: The API is considered EXPERIMENTAL and can be changed without a notice

Since: QGIS 3.2

Definition at line 90 of file qgsmeshlayer.h.

Constructor & Destructor Documentation

◆ QgsMeshLayer() [1/2]

QgsMeshLayer::QgsMeshLayer	(	const QString &	path = `QString()`,
		const QString &	baseName = `QString()`,
		const QString &	providerLib = `"mesh_memory"`,
		const QgsMeshLayer::LayerOptions &	options = `QgsMeshLayer::LayerOptions()`
	)

explicit

Constructor - creates a mesh layer.

The QgsMeshLayer is constructed by instantiating a data provider. The provider interprets the supplied path (url) of the data source to connect to and access the data.

Parameters

path	The path or url of the parameter. Typically this encodes parameters used by the data provider as url query items.
baseName	The name used to represent the layer in the legend
providerLib	The name of the data provider, e.g., "mesh_memory", "mdal"
options	general mesh layer options

Definition at line 31 of file qgsmeshlayer.cpp.

◆ ~QgsMeshLayer()

QgsMeshLayer::~QgsMeshLayer ( )

override

Definition at line 49 of file qgsmeshlayer.cpp.

◆ QgsMeshLayer() [2/2]

QgsMeshLayer::QgsMeshLayer ( const QgsMeshLayer & rhs )

delete

QgsMeshLayer cannot be copied.

Member Function Documentation

◆ activeScalarDataset()

int QgsMeshLayer::activeScalarDataset ( ) const

inline

Returns active scalar dataset.

Definition at line 177 of file qgsmeshlayer.h.

◆ activeVectorDataset()

int QgsMeshLayer::activeVectorDataset ( ) const

inline

Returns active vector dataset.

Definition at line 186 of file qgsmeshlayer.h.

◆ clone()

QgsMeshLayer * QgsMeshLayer::clone ( ) const

overridevirtual

Returns a new instance equivalent to this one except for the id which is still unique.

Returns: a new layer instance

Since: QGIS 3.0

Implements QgsMapLayer.

Definition at line 65 of file qgsmeshlayer.cpp.

◆ createMapRenderer()

QgsMapLayerRenderer * QgsMeshLayer::createMapRenderer ( QgsRenderContext & rendererContext )

overridevirtual

Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.

Since: QGIS 2.4

Implements QgsMapLayer.

Definition at line 203 of file qgsmeshlayer.cpp.

◆ dataProvider() [1/2]

QgsMeshDataProvider * QgsMeshLayer::dataProvider ( )

overridevirtual

Returns the layer's data provider.

Reimplemented from QgsMapLayer.

Definition at line 55 of file qgsmeshlayer.cpp.

◆ dataProvider() [2/2]

const QgsMeshDataProvider * QgsMeshLayer::dataProvider ( ) const

overridevirtual

Returns the layer's data provider in a const-correct manner.

Note: not available in Python bindings

Reimplemented from QgsMapLayer.

Definition at line 60 of file qgsmeshlayer.cpp.

◆ decodedSource()

QString QgsMeshLayer::decodedSource	(	const QString &	source,
		const QString &	dataProvider,
		const QgsReadWriteContext &	context
	)		const

overridevirtual

Called by readLayerXML(), used by derived classes to decode provider's specific data source from project files.

Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes ("HDF5:")

Parameters

source	data source to decode, typically read from layer's dom element "datasource"
dataProvider	string identification of data provider (e.g. "ogr"), typically read from layer's dom element
context	reading context (e.g. for conversion between relative and absolute paths)

Returns: decoded source, typically to be used as the layer's datasource

Since: QGIS 3.2

Reimplemented from QgsMapLayer.

Definition at line 235 of file qgsmeshlayer.cpp.

◆ encodedSource()

QString QgsMeshLayer::encodedSource	(	const QString &	source,
		const QgsReadWriteContext &	context
	)		const

overridevirtual

Called by writeLayerXML(), used by derived classes to encode provider's specific data source to project files.

Typically resolving absolute or relative paths, usernames and passwords or drivers prefixes ("HDF5:")

Parameters

source	data source to encode, typically QgsMapLayer::source()
context	writing context (e.g. for conversion between relative and absolute paths)

Returns: encoded source, typically to be written in the dom element "datasource"

Since: QGIS 3.2

Reimplemented from QgsMapLayer.

Definition at line 245 of file qgsmeshlayer.cpp.

◆ extent()

QgsRectangle QgsMeshLayer::extent ( ) const

overridevirtual

Returns the extent of the layer.

Reimplemented from QgsMapLayer.

Definition at line 72 of file qgsmeshlayer.cpp.

◆ nativeMesh()

QgsMesh * QgsMeshLayer::nativeMesh ( )

Returns native mesh (nullptr before rendering)

Definition at line 89 of file qgsmeshlayer.cpp.

◆ operator=()

QgsMeshLayer& QgsMeshLayer::operator= ( QgsMeshLayer const & rhs )

delete

QgsMeshLayer cannot be copied.

◆ providerType()

QString QgsMeshLayer::providerType ( ) const

Returns the provider type for this layer.

Definition at line 84 of file qgsmeshlayer.cpp.

◆ readSymbology()

bool QgsMeshLayer::readSymbology	(	const QDomNode &	node,
		QString &	errorMessage,
		QgsReadWriteContext &	context
	)

overridevirtual

Read the symbology for the current layer from the Dom node supplied.

Parameters

node	node that will contain the symbology definition for this layer.
errorMessage	reference to string that will be updated with any error messages
context	reading context (used for transform from relative to absolute paths)

Returns: true in case of success.

Implements QgsMapLayer.

Definition at line 218 of file qgsmeshlayer.cpp.

◆ readXml()

bool QgsMeshLayer::readXml	(	const QDomNode &	layer_node,
		QgsReadWriteContext &	context
	)

overridevirtual

Called by readLayerXML(), used by children to read state specific to them from project files.

Reimplemented from QgsMapLayer.

Definition at line 255 of file qgsmeshlayer.cpp.

◆ rendererNativeMeshSettings()

QgsMeshRendererMeshSettings QgsMeshLayer::rendererNativeMeshSettings ( ) const

Returns renderer settings.

Definition at line 101 of file qgsmeshlayer.cpp.

◆ rendererScalarSettings()

QgsMeshRendererScalarSettings QgsMeshLayer::rendererScalarSettings ( ) const

Returns renderer settings.

Definition at line 123 of file qgsmeshlayer.cpp.

◆ rendererTriangularMeshSettings()

QgsMeshRendererMeshSettings QgsMeshLayer::rendererTriangularMeshSettings ( ) const

Returns renderer settings.

Definition at line 112 of file qgsmeshlayer.cpp.

◆ rendererVectorSettings()

QgsMeshRendererVectorSettings QgsMeshLayer::rendererVectorSettings ( ) const

Returns renderer settings.

Definition at line 135 of file qgsmeshlayer.cpp.

◆ setActiveScalarDataset()

void QgsMeshLayer::setActiveScalarDataset ( int index = NO_ACTIVE_MESH_DATASET )

Sets active scalar dataset for rendering.

Triggers repaint

Definition at line 147 of file qgsmeshlayer.cpp.

◆ setActiveVectorDataset()

void QgsMeshLayer::setActiveVectorDataset ( int index = NO_ACTIVE_MESH_DATASET )

Sets active vector dataset for rendering.

If dataset is not vector based, do nothing. Triggers repaint

Definition at line 160 of file qgsmeshlayer.cpp.

◆ setRendererNativeMeshSettings()

void QgsMeshLayer::setRendererNativeMeshSettings ( const QgsMeshRendererMeshSettings & settings )

Sets new renderer settings, triggers repaint.

Definition at line 106 of file qgsmeshlayer.cpp.

◆ setRendererScalarSettings()

void QgsMeshLayer::setRendererScalarSettings ( const QgsMeshRendererScalarSettings & settings )

Sets new renderer settings, triggers repaint.

Definition at line 128 of file qgsmeshlayer.cpp.

◆ setRendererTriangularMeshSettings()

void QgsMeshLayer::setRendererTriangularMeshSettings ( const QgsMeshRendererMeshSettings & settings )

Sets new renderer settings, triggers repaint.

Definition at line 117 of file qgsmeshlayer.cpp.

◆ setRendererVectorSettings()

void QgsMeshLayer::setRendererVectorSettings ( const QgsMeshRendererVectorSettings & settings )

Sets new renderer settings, triggers repaint.

Definition at line 140 of file qgsmeshlayer.cpp.

◆ triangularMesh()

QgsTriangularMesh * QgsMeshLayer::triangularMesh ( )

Returns triangular mesh (nullptr before rendering)

Definition at line 95 of file qgsmeshlayer.cpp.

◆ writeSymbology()

bool QgsMeshLayer::writeSymbology	(	QDomNode &	node,
		QDomDocument &	doc,
		QString &	errorMessage,
		const QgsReadWriteContext &	context
	)		const

overridevirtual

Write the symbology for the layer into the docment provided.

Parameters

node	the node that will have the style element added to it.
doc	the document that will have the QDomNode added.
errorMessage	reference to string that will be updated with any error messages
context	writing context (used for transform from absolute to relative paths)

Returns: true in case of success.

Implements QgsMapLayer.

Definition at line 226 of file qgsmeshlayer.cpp.

◆ writeXml()

bool QgsMeshLayer::writeXml	(	QDomNode &	layer_node,
		QDomDocument &	document,
		const QgsReadWriteContext &	context
	)		const

overridevirtual

Called by writeLayerXML(), used by children to write state specific to them to project files.

Reimplemented from QgsMapLayer.

Definition at line 283 of file qgsmeshlayer.cpp.

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

/tmp/buildd/qgis-3.2.0+99unstable/src/core/mesh/qgsmeshlayer.h
/tmp/buildd/qgis-3.2.0+99unstable/src/core/mesh/qgsmeshlayer.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Mesh data providers

Memory data providerType (mesh_memory)

MDAL data provider (mdal)

Constructor & Destructor Documentation

◆ QgsMeshLayer() [1/2]

◆ ~QgsMeshLayer()

◆ QgsMeshLayer() [2/2]

Member Function Documentation

◆ activeScalarDataset()

◆ activeVectorDataset()

◆ clone()

◆ createMapRenderer()

◆ dataProvider() [1/2]

◆ dataProvider() [2/2]

◆ decodedSource()

◆ encodedSource()

◆ extent()

◆ nativeMesh()

◆ operator=()

◆ providerType()

◆ readSymbology()

◆ readXml()

◆ rendererNativeMeshSettings()

◆ rendererScalarSettings()

◆ rendererTriangularMeshSettings()

◆ rendererVectorSettings()

◆ setActiveScalarDataset()

◆ setActiveVectorDataset()

◆ setRendererNativeMeshSettings()

◆ setRendererScalarSettings()

◆ setRendererTriangularMeshSettings()

◆ setRendererVectorSettings()

◆ triangularMesh()

◆ writeSymbology()

◆ writeXml()