QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Represents a mesh layer supporting display of data on structured or unstructured meshes. More...
#include <qgsmeshlayer.h>
Classes | |
struct | LayerOptions |
Setting options for loading mesh layers. More... | |
Public Slots | |
void | setTransformContext (const QgsCoordinateTransformContext &transformContext) override |
Sets the coordinate transform context to transformContext. | |
Public Slots inherited from QgsMapLayer | |
void | emitStyleChanged () |
Triggers an emission of the styleChanged() signal. | |
QgsProject * | project () const |
Returns the parent project if this map layer is added to a project. | |
virtual bool | setDependencies (const QSet< QgsMapLayerDependency > &layers) |
Sets the list of dependencies. | |
void | setMaximumScale (double scale) |
Sets the maximum map scale (i.e. | |
void | setMinimumScale (double scale) |
Sets the minimum map scale (i.e. | |
void | setRefreshOnNofifyMessage (const QString &message) |
Set the notification message that triggers repaint If refresh on notification is enabled, the notification will triggerRepaint only if the notification message is equal to. | |
void | setRefreshOnNotifyEnabled (bool enabled) |
Set whether provider notification is connected to triggerRepaint. | |
void | setScaleBasedVisibility (bool enabled) |
Sets whether scale based visibility is enabled for the layer. | |
virtual void | setTransformContext (const QgsCoordinateTransformContext &transformContext)=0 |
Sets the coordinate transform context to transformContext. | |
void | trigger3DUpdate () |
Will advise any 3D maps that this layer requires to be updated in the scene. | |
void | triggerRepaint (bool deferredUpdate=false) |
Will advise the map canvas (and any other interested party) that this layer requires to be repainted. | |
Signals | |
void | activeScalarDatasetGroupChanged (int index) |
Emitted when active scalar group dataset is changed. | |
void | activeVectorDatasetGroupChanged (int index) |
Emitted when active vector group dataset is changed. | |
void | reloaded () |
Emitted when the mesh layer is reloaded, see reload() | |
void | timeSettingsChanged () |
Emitted when time format is changed. | |
Signals inherited from QgsMapLayer | |
void | autoRefreshIntervalChanged (int interval) |
Emitted when the auto refresh interval changes. | |
void | beforeResolveReferences (QgsProject *project) |
Emitted when all layers are loaded and references can be resolved, just before the references of this layer are resolved. | |
void | blendModeChanged (QPainter::CompositionMode blendMode) |
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() | |
void | configChanged () |
Emitted whenever the configuration is changed. | |
void | crs3DChanged () |
Emitted when the crs3D() of the layer has changed. | |
void | crsChanged () |
Emitted when the crs() of the layer has changed. | |
void | customPropertyChanged (const QString &key) |
Emitted when a custom property of the layer has been changed or removed. | |
void | dataChanged () |
Data of layer changed. | |
void | dataSourceChanged () |
Emitted whenever the layer's data source has been changed. | |
void | dependenciesChanged () |
Emitted when dependencies are changed. | |
void | editingStarted () |
Emitted when editing on this layer has started. | |
void | editingStopped () |
Emitted when edited changes have been successfully written to the data provider. | |
void | flagsChanged () |
Emitted when layer's flags have been modified. | |
void | idChanged (const QString &id) |
Emitted when the layer's ID has been changed. | |
void | isValidChanged () |
Emitted when the validity of this layer changed. | |
void | layerModified () |
Emitted when modifications has been done on layer. | |
void | legendChanged () |
Signal emitted when legend of the layer has changed. | |
void | mapTipsEnabledChanged () |
Emitted when map tips are enabled or disabled for the layer. | |
void | mapTipTemplateChanged () |
Emitted when the map tip template changes. | |
void | metadataChanged () |
Emitted when the layer's metadata is changed. | |
void | nameChanged () |
Emitted when the name has been changed. | |
void | opacityChanged (double opacity) |
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (opaque). | |
void | recalculateExtents () const |
This is used to send a request that any mapcanvas using this layer update its extents. | |
void | renderer3DChanged () |
Signal emitted when 3D renderer associated with the layer has changed. | |
void | rendererChanged () |
Signal emitted when renderer is changed. | |
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. | |
void | request3DUpdate () |
Signal emitted when a layer requires an update in any 3D maps. | |
void | statusChanged (const QString &status) |
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar) | |
void | styleChanged () |
Signal emitted whenever a change affects the layer's style. | |
void | styleLoaded (QgsMapLayer::StyleCategories categories) |
Emitted when a style has been loaded. | |
void | verticalCrsChanged () |
Emitted when the verticalCrs() of the layer has changed. | |
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. | |
Public Member Functions | |
QgsMeshLayer (const QgsMeshLayer &rhs)=delete | |
QgsMeshLayer (const QString &path=QString(), const QString &baseName=QString(), const QString &providerLib=QStringLiteral("mesh_memory"), const QgsMeshLayer::LayerOptions &options=QgsMeshLayer::LayerOptions()) | |
Constructor - creates a mesh layer. | |
~QgsMeshLayer () override | |
QgsMeshDatasetIndex | activeScalarDatasetAtTime (const QgsDateTimeRange &timeRange, int group=-1) const |
Returns dataset index from active scalar group depending on the time range. | |
QgsMeshDatasetIndex | activeVectorDatasetAtTime (const QgsDateTimeRange &timeRange, int group=-1) const |
Returns dataset index from active vector group depending on the time range If the temporal properties is not active, return the static dataset. | |
bool | addDatasets (const QString &path, const QDateTime &defaultReferenceTime=QDateTime()) |
Adds datasets to the mesh from file with path. | |
bool | addDatasets (QgsMeshDatasetGroup *datasetGroup) |
Adds extra datasets to the mesh. | |
QgsMeshDataBlock | areFacesActive (const QgsMeshDatasetIndex &index, int faceIndex, int count) const |
Returns whether the faces are active for particular dataset. | |
QgsMeshLayer * | clone () const override |
Returns a new instance equivalent to this one except for the id which is still unique. | |
bool | commitFrameEditing (const QgsCoordinateTransform &transform, bool continueEditing=true) |
Commits editing of the mesh frame, Rebuilds the triangular mesh and its spatial index with transform, Continue editing with the same mesh editor if continueEditing is True. | |
bool | contains (const QgsMesh::ElementType &type) const |
Returns whether the mesh contains at mesh elements of given type. | |
QgsMapLayerRenderer * | createMapRenderer (QgsRenderContext &rendererContext) override |
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context. | |
QgsAbstractProfileGenerator * | createProfileGenerator (const QgsProfileRequest &request) override |
Given a profile request, returns a new profile generator ready for generating elevation profiles. | |
const QgsMeshDataProvider * | dataProvider () const override |
Returns the layer's data provider in a const-correct manner, it may be nullptr . | |
QgsMeshDataProvider * | dataProvider () override |
Returns the layer's data provider, it may be nullptr . | |
QgsMeshDatasetValue | dataset1dValue (const QgsMeshDatasetIndex &index, const QgsPointXY &point, double searchRadius) const |
Returns the value of 1D mesh dataset defined on edge that are in the search area defined by point ans searchRadius. | |
QgsMesh3DDataBlock | dataset3dValue (const QgsMeshDatasetIndex &index, const QgsPointXY &point) const |
Returns the 3d values of stacked 3d mesh defined by the given point. | |
QgsMesh3DDataBlock | dataset3dValues (const QgsMeshDatasetIndex &index, int faceIndex, int count) const |
Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes. | |
int | datasetCount (const QgsMeshDatasetIndex &index) const |
Returns the dataset count in the dataset groups. | |
int | datasetGroupCount () const |
Returns the dataset groups count handle by the layer. | |
QgsMeshDatasetGroupMetadata | datasetGroupMetadata (const QgsMeshDatasetIndex &index) const |
Returns the dataset groups metadata. | |
QList< int > | datasetGroupsIndexes () const |
Returns the list of indexes of dataset groups handled by the layer. | |
QgsMeshDatasetGroupTreeItem * | datasetGroupTreeRootItem () const |
Returns the root items of the dataset group tree item. | |
QgsMeshDatasetIndex | datasetIndexAtRelativeTime (const QgsInterval &relativeTime, int datasetGroupIndex) const |
Returns dataset index from datasets group depending on the relative time from the layer reference time. | |
QgsMeshDatasetIndex | datasetIndexAtTime (const QgsDateTimeRange &timeRange, int datasetGroupIndex) const |
Returns dataset index from datasets group depending on the time range. | |
QList< QgsMeshDatasetIndex > | datasetIndexInRelativeTimeInterval (const QgsInterval &startRelativeTime, const QgsInterval &endRelativeTime, int datasetGroupIndex) const |
Returns a list of dataset indexes from datasets group that are in a interval time from the layer reference time. | |
QgsMeshDatasetMetadata | datasetMetadata (const QgsMeshDatasetIndex &index) const |
Returns the dataset metadata. | |
QgsInterval | datasetRelativeTime (const QgsMeshDatasetIndex &index) |
Returns the relative time of the dataset from the reference time of its group. | |
qint64 | datasetRelativeTimeInMilliseconds (const QgsMeshDatasetIndex &index) |
Returns the relative time (in milliseconds) of the dataset from the reference time of its group. | |
QgsMeshDatasetValue | datasetValue (const QgsMeshDatasetIndex &index, const QgsPointXY &point, double searchRadius=0) const |
Interpolates the value on the given point from given dataset. | |
QgsMeshDatasetValue | datasetValue (const QgsMeshDatasetIndex &index, int valueIndex) const |
Returns vector/scalar value associated with the index from the dataset To read multiple continuous values, use datasetValues() | |
QgsMeshDataBlock | datasetValues (const QgsMeshDatasetIndex &index, int valueIndex, int count) const |
Returns N vector/scalar values from the index from the dataset. | |
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. | |
QgsMapLayerElevationProperties * | elevationProperties () override |
Returns the layer's elevation properties. | |
QList< int > | enabledDatasetGroupsIndexes () const |
Returns the list of indexes of enables dataset groups handled by the layer. | |
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. | |
QgsRectangle | extent () const override |
Returns the extent of the layer. | |
int | extraDatasetGroupCount () const |
Returns the extra dataset groups count handle by the layer. | |
QgsInterval | firstValidTimeStep () const |
Returns the first valid time step of the dataset groups, invalid QgInterval if no time step is present. | |
QString | formatTime (double hours) |
Returns (date) time in hours formatted to human readable form. | |
QString | htmlMetadata () const override |
Obtain a formatted HTML string containing assorted metadata for this layer. | |
bool | isEditable () const override |
Returns true if the layer can be edited. | |
bool | isFaceActive (const QgsMeshDatasetIndex &index, int faceIndex) const |
Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes. | |
bool | isModified () const override |
Returns whether the mesh frame has been modified since the last save. | |
QgsAbstractMeshLayerLabeling * | labeling () |
Access to labeling configuration. | |
const QgsAbstractMeshLayerLabeling * | labeling () const |
Access to const labeling configuration. | |
bool | labelsEnabled () const |
Returns whether the layer contains labels which are enabled and should be drawn. | |
QString | loadDefaultStyle (bool &resultFlag) FINAL |
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) | |
int | meshEdgeCount () const |
Returns the edges count of the mesh frame. | |
QgsMeshEditor * | meshEditor () |
Returns a pointer to the mesh editor own by the mesh layer. | |
int | meshFaceCount () const |
Returns the faces count of the mesh frame. | |
QgsMeshSimplificationSettings | meshSimplificationSettings () const |
Returns mesh simplification settings. | |
int | meshVertexCount () const |
Returns the vertices count of the mesh frame. | |
QgsMesh * | nativeMesh () |
Returns native mesh (nullptr before rendering or calling to updateMesh) | |
const QgsMesh * | nativeMesh () const |
Returns native mesh (nullptr before rendering or calling to updateMesh) | |
QgsMeshLayer & | operator= (QgsMeshLayer const &rhs)=delete |
QString | providerType () const |
Returns the provider type for this layer. | |
bool | readStyle (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) override |
Read the style for the current layer from the DOM node supplied. | |
bool | readSymbology (const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) override |
Read the symbology for the current layer from the DOM node supplied. | |
bool | readXml (const QDomNode &layer_node, QgsReadWriteContext &context) override |
Called by readLayerXML(), used by children to read state specific to them from project files. | |
bool | reindex (const QgsCoordinateTransform &transform, bool renumber) |
Re-indexes the faces and vertices, and renumber the indexes if renumber is true . | |
void | reload () override |
Synchronises with changes in the datasource. | |
QgsMeshLayerRendererCache * | rendererCache () |
Returns native mesh (nullptr before rendering) | |
QgsMeshRendererSettings | rendererSettings () const |
Returns renderer settings. | |
void | resetDatasetGroupTreeItem () |
Reset the dataset group tree item to default from provider. | |
bool | rollBackFrameEditing (const QgsCoordinateTransform &transform, bool continueEditing=true) |
Rolls Back editing of the mesh frame. | |
bool | saveDataset (const QString &path, int datasetGroupIndex, QString driver) |
Saves datasets group on file with the specified driver. | |
QList< int > | selectFacesByExpression (QgsExpression expression) |
Returns a list of faces indexes that meet the condition defined by expression with the context expressionContext. | |
QList< int > | selectVerticesByExpression (QgsExpression expression) |
Returns a list of vertex indexes that meet the condition defined by expression with the context expressionContext. | |
void | setDatasetGroupTreeRootItem (QgsMeshDatasetGroupTreeItem *rootItem) |
Sets the root items of the dataset group tree item. | |
void | setLabeling (QgsAbstractMeshLayerLabeling *labeling) |
Sets labeling configuration. | |
void | setLabelsEnabled (bool enabled) |
Sets whether labels should be enabled for the layer. | |
void | setMeshSimplificationSettings (const QgsMeshSimplificationSettings &meshSimplificationSettings) |
Sets mesh simplification settings. | |
void | setReferenceTime (const QDateTime &referenceTime) |
Sets the reference time of the layer. | |
void | setRendererSettings (const QgsMeshRendererSettings &settings) |
Sets new renderer settings. | |
void | setStaticScalarDatasetIndex (const QgsMeshDatasetIndex &staticScalarDatasetIndex) |
Sets the static scalar dataset index that is rendered if the temporal properties is not active. | |
void | setStaticVectorDatasetIndex (const QgsMeshDatasetIndex &staticVectorDatasetIndex) |
Sets the static vector dataset index that is rendered if the temporal properties is not active. | |
void | setTemporalMatchingMethod (const QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod &matchingMethod) |
Sets the method used to match the temporal dataset from a requested time, see activeVectorDatasetAtTime() | |
void | setTimeSettings (const QgsMeshTimeSettings &settings) |
Sets time format settings. | |
QgsPointXY | snapOnElement (QgsMesh::ElementType elementType, const QgsPointXY &point, double searchRadius) |
Returns the position of the snapped point on the mesh element closest to point intersecting with the searching area defined by point and searchRadius. | |
Q_DECL_DEPRECATED bool | startFrameEditing (const QgsCoordinateTransform &transform) |
Starts editing of the mesh frame. | |
bool | startFrameEditing (const QgsCoordinateTransform &transform, QgsMeshEditingError &error, bool fixErrors) |
Starts editing of the mesh frame. | |
QgsMeshDatasetIndex | staticScalarDatasetIndex (int group=-1) const |
Returns the static scalar dataset index that is rendered if the temporal properties is not active. | |
QgsMeshDatasetIndex | staticVectorDatasetIndex (int group=-1) const |
Returns the static vector dataset index that is rendered if the temporal properties is not active. | |
void | stopFrameEditing (const QgsCoordinateTransform &transform) |
Stops editing of the mesh, re-indexes the faces and vertices, rebuilds the triangular mesh and its spatial index with transform, clean the undostack. | |
QStringList | subLayers () const override |
Returns the sublayers of this layer. | |
bool | supportsEditing () const override |
Returns whether the layer supports editing or not. | |
QgsMapLayerTemporalProperties * | temporalProperties () override |
Returns the layer's temporal properties. | |
QgsMeshTimeSettings | timeSettings () const |
Returns time format settings. | |
QgsTriangularMesh * | triangularMesh (double minimumTriangleSize=0) const |
Returns triangular mesh (nullptr before rendering or calling to updateMesh). | |
QgsTriangularMesh * | triangularMeshByLodIndex (int lodIndex) const |
Returns triangular corresponding to the index of level of details. | |
int | triangularMeshLevelOfDetailCount () const |
Returns the count of levels of detail of the mesh simplification. | |
void | updateTriangularMesh (const QgsCoordinateTransform &transform=QgsCoordinateTransform()) |
Gets native mesh and updates (creates if it doesn't exist) the base triangular mesh. | |
bool | writeStyle (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const override |
Write just the symbology information for the layer into the document. | |
bool | writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const override |
Write the style for the layer into the document provided. | |
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. | |
Public Member Functions inherited from QgsMapLayer | |
QgsMapLayer (const QgsMapLayer &)=delete | |
QgsMapLayer (Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString()) | |
Constructor for QgsMapLayer. | |
~QgsMapLayer () override | |
Q_DECL_DEPRECATED QString | abstract () const |
Returns the abstract of the layer used by QGIS Server in GetCapabilities request. | |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer. | |
Q_DECL_DEPRECATED QString | attribution () const |
Returns the attribution of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | attributionUrl () const |
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request. | |
int | autoRefreshInterval () const |
Returns the auto refresh interval (in milliseconds). | |
Qgis::AutoRefreshMode | autoRefreshMode () const |
Returns the layer's automatic refresh mode. | |
QPainter::CompositionMode | blendMode () const |
Returns the current blending mode for a layer. | |
QgsCoordinateReferenceSystem | crs () const |
Returns the layer's spatial reference system. | |
QgsCoordinateReferenceSystem | crs3D () const |
Returns the CRS to use for the layer when transforming 3D data, or when z/elevation value handling is important. | |
template<class T > | |
T | customEnumProperty (const QString &key, const T &defaultValue) |
Returns the property value for a property based on an enum. | |
template<class T > | |
T | customFlagProperty (const QString &key, const T &defaultValue) |
Returns the property value for a property based on a flag. | |
const QgsObjectCustomProperties & | customProperties () const |
Read all custom properties from layer. | |
Q_INVOKABLE QVariant | customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const |
Read a custom property from layer. | |
Q_INVOKABLE QStringList | customPropertyKeys () const |
Returns list of all keys within custom properties. | |
Q_DECL_DEPRECATED QString | dataUrl () const |
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | dataUrlFormat () const |
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request. | |
virtual bool | deleteStyleFromDatabase (const QString &styleId, QString &msgError) |
Deletes a style from the database. | |
virtual QSet< QgsMapLayerDependency > | dependencies () const |
Gets the list of dependencies. | |
virtual QgsError | error () const |
Gets current status error. | |
void | exportNamedMetadata (QDomDocument &doc, QString &errorMsg) const |
Export the current metadata of this layer as named metadata in a QDomDocument. | |
virtual void | exportNamedStyle (QDomDocument &doc, QString &errorMsg, const QgsReadWriteContext &context=QgsReadWriteContext(), QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const |
Export the properties of this layer as named style in a QDomDocument. | |
virtual void | exportSldStyle (QDomDocument &doc, QString &errorMsg) const |
Export the properties of this layer as SLD style in a QDomDocument. | |
virtual void | exportSldStyleV2 (QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext) const |
Export the properties of this layer as SLD style in a QDomDocument. | |
virtual QgsBox3D | extent3D () const |
Returns the 3D extent of the layer. | |
QgsMapLayer::LayerFlags | flags () const |
Returns the flags for this layer. | |
virtual QString | getStyleFromDatabase (const QString &styleId, QString &msgError) |
Returns the named style corresponding to style id provided. | |
Q_DECL_DEPRECATED bool | hasAutoRefreshEnabled () const |
Returns true if auto refresh is enabled for the layer. | |
virtual bool | hasMapTips () const |
Returns true if the layer contains map tips. | |
bool | hasScaleBasedVisibility () const |
Returns whether scale based visibility is enabled for the layer. | |
QString | id () const |
Returns the layer's unique ID, which is used to access this layer from QgsProject. | |
bool | importNamedMetadata (QDomDocument &document, QString &errorMessage) |
Import the metadata of this layer from a QDomDocument. | |
virtual bool | importNamedStyle (QDomDocument &doc, QString &errorMsg, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
Import the properties of this layer from a QDomDocument. | |
bool | isInScaleRange (double scale) const |
Tests whether the layer should be visible at the specified scale. | |
bool | isRefreshOnNotifyEnabled () const |
Returns true if the refresh on provider nofification is enabled. | |
virtual bool | isSpatial () const |
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. | |
virtual bool | isTemporary () const |
Returns true if the layer is considered a temporary layer. | |
bool | isValid () const |
Returns the status of the layer. | |
Q_DECL_DEPRECATED QString | keywordList () const |
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request. | |
QgsMapLayerLegend * | legend () const |
Can be nullptr . | |
QString | legendPlaceholderImage () const |
Returns path to the placeholder image or an empty string if a generated legend is shown. | |
QString | legendUrl () const |
Returns the URL for the layer's legend. | |
QString | legendUrlFormat () const |
Returns the format for a URL based layer legend. | |
virtual int | listStylesInDatabase (QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError) |
Lists all the style in db split into related to the layer and not related to. | |
virtual 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) | |
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) | |
bool | loadNamedMetadataFromDatabase (const QString &db, const QString &uri, QString &qmd) |
Retrieve a named metadata for this layer from a sqlite database. | |
virtual QString | loadNamedStyle (const QString &theURI, bool &resultFlag, bool loadFromLocalDb, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags()) |
Loads a named style from file/local db/datasource db. | |
virtual QString | loadNamedStyle (const QString &uri, bool &resultFlag, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags=Qgis::LoadStyleFlags()) |
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) | |
virtual bool | loadNamedStyleFromDatabase (const QString &db, const QString &uri, QString &qml) |
Retrieve a named style for this layer from a sqlite database. | |
virtual QString | loadSldStyle (const QString &uri, bool &resultFlag) |
Attempts to style the layer using the formatting from an SLD type file. | |
bool | mapTipsEnabled () const |
Returns true if map tips are enabled for this layer. | |
QString | mapTipTemplate () const |
The mapTip is a pretty, html representation for feature information. | |
double | maximumScale () const |
Returns the maximum map scale (i.e. | |
virtual const QgsLayerMetadata & | metadata () const |
Returns a reference to the layer's metadata store. | |
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) | |
Q_DECL_DEPRECATED QString | metadataUrl () const |
Returns the metadata URL of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | metadataUrlFormat () const |
Returns the metadata format of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED QString | metadataUrlType () const |
Returns the metadata type of the layer used by QGIS Server in GetCapabilities request. | |
double | minimumScale () const |
Returns the minimum map scale (i.e. | |
QString | name () const |
Returns the display name of the layer. | |
virtual double | opacity () const |
Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). | |
QgsMapLayer & | operator= (const QgsMapLayer &)=delete |
QString | originalXmlProperties () const |
Returns the XML properties of the original layer as they were when the layer was first read from the project file. | |
virtual Qgis::MapLayerProperties | properties () const |
Returns the map layer properties of this layer. | |
QgsProviderMetadata * | providerMetadata () const |
Returns the layer data provider's metadata, it may be nullptr . | |
QString | providerType () const |
Returns the provider type (provider key) for this layer. | |
QString | publicSource (bool hidePassword=false) const |
Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). | |
bool | readLayerXml (const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags=QgsMapLayer::ReadFlags(), QgsDataProvider *preloadedProvider=nullptr) |
Sets state from DOM document. | |
bool | readOnly () const |
Returns if this layer is read only. | |
virtual bool | readSld (const QDomNode &node, QString &errorMessage) |
QString | refreshOnNotifyMessage () const |
Returns the message that should be notified by the provider to triggerRepaint. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from layer. | |
QgsAbstract3DRenderer * | renderer3D () const |
Returns 3D renderer associated with the layer. | |
virtual void | resolveReferences (QgsProject *project) |
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. | |
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) | |
virtual Q_DECL_DEPRECATED 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) | |
virtual QString | saveDefaultStyle (bool &resultFlag, StyleCategories categories) |
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) | |
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) | |
virtual QString | saveNamedStyle (const QString &uri, bool &resultFlag, StyleCategories categories=AllStyleCategories) |
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) | |
virtual QString | saveSldStyle (const QString &uri, bool &resultFlag) const |
Saves the properties of this layer to an SLD format file. | |
virtual QString | saveSldStyleV2 (bool &resultFlag, const QgsSldExportContext &exportContext) const |
Saves the properties of this layer to an SLD format file. | |
virtual void | saveStyleToDatabase (const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) |
Saves named and sld style of the layer to the style table in the db. | |
virtual QgsMapLayerSelectionProperties * | selectionProperties () |
Returns the layer's selection properties. | |
QgsMapLayerServerProperties * | serverProperties () |
Returns QGIS Server Properties for the map layer. | |
const QgsMapLayerServerProperties * | serverProperties () const |
Returns QGIS Server Properties const for the map layer. | |
Q_DECL_DEPRECATED void | setAbstract (const QString &abstract) |
Sets the abstract of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setAttribution (const QString &attrib) |
Sets the attribution of the layerused by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setAttributionUrl (const QString &attribUrl) |
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setAutoRefreshEnabled (bool enabled) |
Sets whether auto refresh is enabled for the layer. | |
void | setAutoRefreshInterval (int interval) |
Sets the auto refresh interval (in milliseconds) for the layer. | |
void | setAutoRefreshMode (Qgis::AutoRefreshMode mode) |
Sets the automatic refresh mode for the layer. | |
void | setBlendMode (QPainter::CompositionMode blendMode) |
Set the blending mode used for rendering a layer. | |
void | setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true) |
Sets layer's spatial reference system. | |
template<class T > | |
void | setCustomEnumProperty (const QString &key, const T &value) |
Set the value of a property based on an enum. | |
template<class T > | |
void | setCustomFlagProperty (const QString &key, const T &value) |
Set the value of a property based on a flag. | |
void | setCustomProperties (const QgsObjectCustomProperties &properties) |
Set custom properties for layer. | |
Q_INVOKABLE void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for layer. | |
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag=false) |
Updates the data source of the layer. | |
void | setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags) |
Updates the data source of the layer. | |
void | setDataSource (const QString &dataSource, const QString &baseName=QString(), const QString &provider=QString(), bool loadDefaultStyleFlag=false) |
Updates the data source of the layer. | |
Q_DECL_DEPRECATED void | setDataUrl (const QString &dataUrl) |
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setDataUrlFormat (const QString &dataUrlFormat) |
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request. | |
void | setFlags (QgsMapLayer::LayerFlags flags) |
Returns the flags for this layer. | |
bool | setId (const QString &id) |
Sets the layer's id. | |
Q_DECL_DEPRECATED void | setKeywordList (const QString &keywords) |
Sets the keyword list of the layerused by QGIS Server in GetCapabilities request. | |
virtual void | setLayerOrder (const QStringList &layers) |
Reorders the previously selected sublayers of this layer from bottom to top. | |
void | setLegend (QgsMapLayerLegend *legend) |
Assign a legend controller to the map layer. | |
void | setLegendPlaceholderImage (const QString &imgPath) |
Set placeholder image for legend. | |
void | setLegendUrl (const QString &legendUrl) |
Sets the URL for the layer's legend. | |
void | setLegendUrlFormat (const QString &legendUrlFormat) |
Sets the format for a URL based layer legend. | |
void | setMapTipsEnabled (bool enabled) |
Enable or disable map tips for this layer. | |
void | setMapTipTemplate (const QString &mapTipTemplate) |
The mapTip is a pretty, html representation for feature information. | |
virtual void | setMetadata (const QgsLayerMetadata &metadata) |
Sets the layer's metadata store. | |
Q_DECL_DEPRECATED void | setMetadataUrl (const QString &metaUrl) |
Sets the metadata URL of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED void | setMetadataUrlFormat (const QString &metaUrlFormat) |
Sets the metadata format of the layer used by QGIS Server in GetCapabilities request. | |
Q_DECL_DEPRECATED 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. | |
void | setName (const QString &name) |
Set the display name of the layer. | |
virtual void | setOpacity (double opacity) |
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). | |
void | setOriginalXmlProperties (const QString &originalXmlProperties) |
Sets the original XML properties for the layer to originalXmlProperties. | |
void | setRenderer3D (QgsAbstract3DRenderer *renderer) |
Sets 3D renderer for the layer. | |
Q_DECL_DEPRECATED void | setShortName (const QString &shortName) |
Sets the short name of the layer used by QGIS Server to identify the layer. | |
virtual void | setSubLayerVisibility (const QString &name, bool visible) |
Set the visibility of the given sublayer name. | |
Q_DECL_DEPRECATED void | setTitle (const QString &title) |
Sets the title of the layer used by QGIS Server in GetCapabilities request. | |
bool | setVerticalCrs (const QgsCoordinateReferenceSystem &crs, QString *errorMessage=nullptr) |
Sets the layer's vertical coordinate reference system. | |
Q_DECL_DEPRECATED QString | shortName () const |
Returns the short name of the layer used by QGIS Server to identify the layer. | |
QString | source () const |
Returns the source for the layer. | |
QgsMapLayerStyleManager * | styleManager () const |
Gets access to the layer's style manager. | |
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) | |
virtual QDateTime | timestamp () const |
Time stamp of data source in the moment when data/metadata were loaded by provider. | |
Q_DECL_DEPRECATED QString | title () const |
Returns the title of the layer used by QGIS Server in GetCapabilities request. | |
QgsCoordinateTransformContext | transformContext () const |
Returns the layer data provider coordinate transform context or a default transform context if the layer does not have a valid data provider. | |
Qgis::LayerType | type () const |
Returns the type of the layer. | |
QUndoStack * | undoStack () |
Returns pointer to layer's undo stack. | |
QUndoStack * | undoStackStyles () |
Returns pointer to layer's style undo stack. | |
QgsCoordinateReferenceSystem | verticalCrs () const |
Returns the layer's vertical coordinate reference system. | |
QgsRectangle | wgs84Extent (bool forceRecalculate=false) const |
Returns the WGS84 extent (EPSG:4326) of the layer according to ReadFlag::FlagTrustLayerMetadata. | |
bool | writeLayerXml (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores state in DOM node. | |
Public Member Functions inherited from QgsAbstractProfileSource | |
virtual | ~QgsAbstractProfileSource () |
Additional Inherited Members | |
Public Types inherited from QgsMapLayer | |
enum | LayerFlag { Identifiable = 1 << 0 , Removable = 1 << 1 , Searchable = 1 << 2 , Private = 1 << 3 } |
Flags for the map layer. More... | |
typedef QFlags< LayerFlag > | LayerFlags |
enum | PropertyType { Style = 0 , Metadata } |
Maplayer has a style and a metadata property. More... | |
enum | ReadFlag { FlagDontResolveLayers = 1 << 0 , FlagTrustLayerMetadata = 1 << 1 , FlagReadExtentFromXml = 1 << 2 , FlagForceReadOnly = 1 << 3 } |
Flags which control project read behavior. More... | |
typedef QFlags< ReadFlag > | ReadFlags |
typedef QFlags< StyleCategory > | StyleCategories |
enum | StyleCategory { LayerConfiguration = 1 << 0 , Symbology = 1 << 1 , Symbology3D = 1 << 2 , Labeling = 1 << 3 , Fields = 1 << 4 , Forms = 1 << 5 , Actions = 1 << 6 , MapTips = 1 << 7 , Diagrams = 1 << 8 , AttributeTable = 1 << 9 , Rendering = 1 << 10 , CustomProperties = 1 << 11 , GeometryOptions = 1 << 12 , Relations = 1 << 13 , Temporal = 1 << 14 , Legend = 1 << 15 , Elevation = 1 << 16 , Notes = 1 << 17 , AllStyleCategories } |
Categories of style to distinguish appropriate sections for import/export. More... | |
Static Public Member Functions inherited from QgsMapLayer | |
static QString | extensionPropertyType (PropertyType type) |
Returns the extension of a Property. | |
static QString | formatLayerName (const QString &name) |
A convenience function to capitalize and format a layer name. | |
static QString | generateId (const QString &layerName) |
Generates an unique identifier for this layer, the generate ID is prefixed by layerName. | |
static Qgis::DataProviderReadFlags | providerReadFlags (const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags) |
Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that describes a layer (corresponding to maplayer tag in a DOM document project file read by QgsProject). | |
Protected Member Functions inherited from QgsMapLayer | |
void | appendError (const QgsErrorMessage &error) |
Add error message. | |
void | clone (QgsMapLayer *layer) const |
Copies attributes like name, short name, ... into another layer. | |
QString | crsHtmlMetadata () const |
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method. | |
QString | customPropertyHtmlMetadata () const |
Returns an HTML fragment containing custom property information, for use in the htmlMetadata() method. | |
QString | generalHtmlMetadata () const |
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() method. | |
Q_DECL_DEPRECATED bool | hasDependencyCycle (const QSet< QgsMapLayerDependency > &) const |
Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return false , because circular dependencies are now correctly managed. | |
void | invalidateWgs84Extent () |
Invalidates the WGS84 extent. | |
void | readCommonStyle (const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) |
Read style data common to all layer types. | |
void | readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith=QString()) |
Read custom properties from project file. | |
void | readStyleManager (const QDomNode &layerNode) |
Read style manager's configuration (if any). To be called by subclasses. | |
void | setError (const QgsError &error) |
Sets error message. | |
virtual void | setExtent (const QgsRectangle &rect) |
Sets the extent. | |
virtual void | setExtent3D (const QgsBox3D &box) |
Sets the extent. | |
void | setProviderType (const QString &providerType) |
Sets the providerType (provider key) | |
void | setValid (bool valid) |
Sets whether layer is valid or not. | |
void | writeCommonStyle (QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const |
Write style data common to all layer types. | |
void | writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const |
Write custom properties to project file. | |
void | writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const |
Write style manager's configuration (if exists). To be called by subclasses. | |
Protected Attributes inherited from QgsMapLayer | |
int | mBlockStyleChangedSignal = 0 |
If non-zero, the styleChanged signal should not be emitted. | |
QString | mDataSource |
Data source description string, varies by layer type. | |
QSet< QgsMapLayerDependency > | mDependencies |
List of layers that may modify this layer on modification. | |
QgsError | mError |
Error. | |
bool | mIsRefreshOnNofifyEnabled = false |
QString | mLayerName |
Name of the layer - used for display. | |
double | mLayerOpacity = 1.0 |
Layer opacity. | |
QString | mLegendUrl |
WMS legend. | |
QString | mLegendUrlFormat |
std::unique_ptr< QgsDataProvider > | mPreloadedProvider |
Optionally used when loading a project, it is released when the layer is effectively created. | |
QString | mProviderKey |
Data provider key (name of the data provider) | |
QgsMapLayer::ReadFlags | mReadFlags = QgsMapLayer::ReadFlags() |
Read flags. It's up to the subclass to respect these when restoring state from XML. | |
QString | mRefreshOnNofifyMessage |
bool | mShouldValidateCrs = true |
true if the layer's CRS should be validated and invalid CRSes are not permitted. | |
bool | mValid = false |
Indicates if the layer is valid and can be drawn. | |
Properties inherited from QgsMapLayer | |
int | autoRefreshInterval |
QgsCoordinateReferenceSystem | crs |
QgsCoordinateReferenceSystem | crs3D |
QString | id |
bool | isValid |
bool | mapTipsEnabled |
QString | mapTipTemplate |
QgsLayerMetadata | metadata |
QString | name |
double | opacity |
Qgis::LayerType | type |
QgsCoordinateReferenceSystem | verticalCrs |
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.
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
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.
Definition at line 100 of file qgsmeshlayer.h.
|
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.
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 52 of file qgsmeshlayer.cpp.
|
override |
Definition at line 108 of file qgsmeshlayer.cpp.
|
delete |
QgsMeshDatasetIndex QgsMeshLayer::activeScalarDatasetAtTime | ( | const QgsDateTimeRange & | timeRange, |
int | group = -1 |
||
) | const |
Returns dataset index from active scalar group depending on the time range.
If the temporal properties is not active, return the static dataset
Since QGIS 3.38, the group argument can be used to specify a fixed group to use. If this is not specified, then the active group from the layer's renderer will be used.
Definition at line 800 of file qgsmeshlayer.cpp.
|
signal |
Emitted when active scalar group dataset is changed.
QgsMeshDatasetIndex QgsMeshLayer::activeVectorDatasetAtTime | ( | const QgsDateTimeRange & | timeRange, |
int | group = -1 |
||
) | const |
Returns dataset index from active vector group depending on the time range If the temporal properties is not active, return the static dataset.
Since QGIS 3.38, the group argument can be used to specify a fixed group to use. If this is not specified, then the active group from the layer's renderer will be used.
Definition at line 810 of file qgsmeshlayer.cpp.
|
signal |
Emitted when active vector group dataset is changed.
bool QgsMeshLayer::addDatasets | ( | const QString & | path, |
const QDateTime & | defaultReferenceTime = QDateTime() |
||
) |
Adds datasets to the mesh from file with path.
Use the the time defaultReferenceTime as reference time is not provided in the file
path | the path to the atasets file |
defaultReferenceTime | reference time used if not provided in the file |
Definition at line 255 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::addDatasets | ( | QgsMeshDatasetGroup * | datasetGroup | ) |
Adds extra datasets to the mesh.
Take ownership.
datasetGroup | the extra dataset group |
Definition at line 287 of file qgsmeshlayer.cpp.
QgsMeshDataBlock QgsMeshLayer::areFacesActive | ( | const QgsMeshDatasetIndex & | index, |
int | faceIndex, | ||
int | count | ||
) | const |
Returns whether the faces are active for particular dataset.
index | index of the dataset |
faceIndex | index of the face |
count | number of values to return |
Definition at line 509 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns a new instance equivalent to this one except for the id which is still unique.
Implements QgsMapLayer.
Definition at line 128 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::commitFrameEditing | ( | const QgsCoordinateTransform & | transform, |
bool | continueEditing = true |
||
) |
Commits editing of the mesh frame, Rebuilds the triangular mesh and its spatial index with transform, Continue editing with the same mesh editor if continueEditing is True.
true
if the commit succeeds Definition at line 1164 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::contains | ( | const QgsMesh::ElementType & | type | ) | const |
Returns whether the mesh contains at mesh elements of given type.
Definition at line 1297 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
Implements QgsMapLayer.
Definition at line 1649 of file qgsmeshlayer.cpp.
|
overridevirtual |
Given a profile request, returns a new profile generator ready for generating elevation profiles.
The caller takes ownership of the returned generator.
May return nullptr
if the source cannot generate a profile at this time.
Implements QgsAbstractProfileSource.
Definition at line 1666 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns the layer's data provider in a const-correct manner, it may be nullptr
.
Reimplemented from QgsMapLayer.
Definition at line 121 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns the layer's data provider, it may be nullptr
.
Reimplemented from QgsMapLayer.
Definition at line 114 of file qgsmeshlayer.cpp.
QgsMeshDatasetValue QgsMeshLayer::dataset1dValue | ( | const QgsMeshDatasetIndex & | index, |
const QgsPointXY & | point, | ||
double | searchRadius | ||
) | const |
Returns the value of 1D mesh dataset defined on edge that are in the search area defined by point ans searchRadius.
index | dataset index specifying group and dataset to extract value from |
point | the center point of the search area |
searchRadius | the radius of the searc area in map unit |
Definition at line 619 of file qgsmeshlayer.cpp.
QgsMesh3DDataBlock QgsMeshLayer::dataset3dValue | ( | const QgsMeshDatasetIndex & | index, |
const QgsPointXY & | point | ||
) | const |
Returns the 3d values of stacked 3d mesh defined by the given point.
index | dataset index specifying group and dataset to extract value from |
point | point to query in map coordinates |
Definition at line 595 of file qgsmeshlayer.cpp.
QgsMesh3DDataBlock QgsMeshLayer::dataset3dValues | ( | const QgsMeshDatasetIndex & | index, |
int | faceIndex, | ||
int | count | ||
) | const |
Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes.
See QgsMeshDatasetMetadata::isVector() to check if the returned value is vector or scalar
returns invalid block for DataOnFaces and DataOnVertices.
index | index of the dataset |
faceIndex | index of the face |
count | number of values to return |
Definition at line 502 of file qgsmeshlayer.cpp.
int QgsMeshLayer::datasetCount | ( | const QgsMeshDatasetIndex & | index | ) | const |
Returns the dataset count in the dataset groups.
index | index of the dataset in the group |
Definition at line 474 of file qgsmeshlayer.cpp.
int QgsMeshLayer::datasetGroupCount | ( | ) | const |
Returns the dataset groups count handle by the layer.
Definition at line 439 of file qgsmeshlayer.cpp.
QgsMeshDatasetGroupMetadata QgsMeshLayer::datasetGroupMetadata | ( | const QgsMeshDatasetIndex & | index | ) | const |
Returns the dataset groups metadata.
Definition at line 467 of file qgsmeshlayer.cpp.
QList< int > QgsMeshLayer::datasetGroupsIndexes | ( | ) | const |
Returns the list of indexes of dataset groups handled by the layer.
Definition at line 453 of file qgsmeshlayer.cpp.
QgsMeshDatasetGroupTreeItem * QgsMeshLayer::datasetGroupTreeRootItem | ( | ) | const |
Returns the root items of the dataset group tree item.
Definition at line 859 of file qgsmeshlayer.cpp.
QgsMeshDatasetIndex QgsMeshLayer::datasetIndexAtRelativeTime | ( | const QgsInterval & | relativeTime, |
int | datasetGroupIndex | ||
) | const |
Returns dataset index from datasets group depending on the relative time from the layer reference time.
Dataset index is valid even the temporal properties is inactive. This method is used for calculation on mesh layer.
relativeTime | the relative from the mesh layer reference time |
datasetGroupIndex | the index of the dataset group |
Definition at line 683 of file qgsmeshlayer.cpp.
QgsMeshDatasetIndex QgsMeshLayer::datasetIndexAtTime | ( | const QgsDateTimeRange & | timeRange, |
int | datasetGroupIndex | ||
) | const |
Returns dataset index from datasets group depending on the time range.
If the temporal properties is not active, returns invalid dataset index. This method is used for rendering mesh layer.
timeRange | the time range |
datasetGroupIndex | the index of the dataset group |
Definition at line 667 of file qgsmeshlayer.cpp.
QList< QgsMeshDatasetIndex > QgsMeshLayer::datasetIndexInRelativeTimeInterval | ( | const QgsInterval & | startRelativeTime, |
const QgsInterval & | endRelativeTime, | ||
int | datasetGroupIndex | ||
) | const |
Returns a list of dataset indexes from datasets group that are in a interval time from the layer reference time.
Dataset index is valid even the temporal properties is inactive. This method is used for calculation on mesh layer.
startRelativeTime | the start time of the relative interval from the reference time. |
endRelativeTime | the end time of the relative interval from the reference time. |
datasetGroupIndex | the index of the dataset group |
Definition at line 690 of file qgsmeshlayer.cpp.
QgsMeshDatasetMetadata QgsMeshLayer::datasetMetadata | ( | const QgsMeshDatasetIndex & | index | ) | const |
Returns the dataset metadata.
index | index of the dataset |
Definition at line 481 of file qgsmeshlayer.cpp.
QgsInterval QgsMeshLayer::datasetRelativeTime | ( | const QgsMeshDatasetIndex & | index | ) |
Returns the relative time of the dataset from the reference time of its group.
Definition at line 1045 of file qgsmeshlayer.cpp.
qint64 QgsMeshLayer::datasetRelativeTimeInMilliseconds | ( | const QgsMeshDatasetIndex & | index | ) |
Returns the relative time (in milliseconds) of the dataset from the reference time of its group.
Definition at line 1057 of file qgsmeshlayer.cpp.
QgsMeshDatasetValue QgsMeshLayer::datasetValue | ( | const QgsMeshDatasetIndex & | index, |
const QgsPointXY & | point, | ||
double | searchRadius = 0 |
||
) | const |
Interpolates the value on the given point from given dataset.
For 3D datasets, it uses dataset3dValue(),
For 1D datasets, it uses dataset1dValue() with searchRadius
index | dataset index specifying group and dataset to extract value from |
point | point to query in map coordinates |
searchRadius | the radius of the search area in map unit |
Definition at line 523 of file qgsmeshlayer.cpp.
QgsMeshDatasetValue QgsMeshLayer::datasetValue | ( | const QgsMeshDatasetIndex & | index, |
int | valueIndex | ||
) | const |
Returns vector/scalar value associated with the index from the dataset To read multiple continuous values, use datasetValues()
See QgsMeshDatasetMetadata::isVector() or QgsMeshDataBlock::type() to check if the returned value is vector or scalar
Returns invalid value for DataOnVolumes
index | index of the dataset |
valueIndex | index of the value |
Definition at line 488 of file qgsmeshlayer.cpp.
QgsMeshDataBlock QgsMeshLayer::datasetValues | ( | const QgsMeshDatasetIndex & | index, |
int | valueIndex, | ||
int | count | ||
) | const |
Returns N vector/scalar values from the index from the dataset.
See QgsMeshDatasetMetadata::isVector() or QgsMeshDataBlock::type() to check if the returned value is vector or scalar
Returns invalid block for DataOnVolumes. Use QgsMeshLayerUtils::datasetValues() if you need block for any type of data type
index | index of the dataset |
valueIndex | index of the value |
count | number of values to return |
Definition at line 495 of file qgsmeshlayer.cpp.
|
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:")
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) |
Reimplemented from QgsMapLayer.
Definition at line 1835 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns the layer's elevation properties.
This may be nullptr
, depending on the layer type.
Reimplemented from QgsMapLayer.
Definition at line 2180 of file qgsmeshlayer.cpp.
QList< int > QgsMeshLayer::enabledDatasetGroupsIndexes | ( | ) | const |
Returns the list of indexes of enables dataset groups handled by the layer.
Definition at line 460 of file qgsmeshlayer.cpp.
|
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:")
source | data source to encode, typically QgsMapLayer::source() |
context | writing context (e.g. for conversion between relative and absolute paths) |
Reimplemented from QgsMapLayer.
Definition at line 1842 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns the extent of the layer.
Reimplemented from QgsMapLayer.
Definition at line 152 of file qgsmeshlayer.cpp.
int QgsMeshLayer::extraDatasetGroupCount | ( | ) | const |
Returns the extra dataset groups count handle by the layer.
Definition at line 446 of file qgsmeshlayer.cpp.
QgsInterval QgsMeshLayer::firstValidTimeStep | ( | ) | const |
Returns the first valid time step of the dataset groups, invalid QgInterval if no time step is present.
Definition at line 1028 of file qgsmeshlayer.cpp.
QString QgsMeshLayer::formatTime | ( | double | hours | ) |
Returns (date) time in hours formatted to human readable form.
hours | time in double in hours |
Definition at line 429 of file qgsmeshlayer.cpp.
|
overridevirtual |
Obtain a formatted HTML string containing assorted metadata for this layer.
Reimplemented from QgsMapLayer.
Definition at line 2010 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns true
if the layer can be edited.
Reimplemented from QgsMapLayer.
Definition at line 2093 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::isFaceActive | ( | const QgsMeshDatasetIndex & | index, |
int | faceIndex | ||
) | const |
Returns N vector/scalar values from the face index from the dataset for 3d stacked meshes.
See QgsMeshDatasetMetadata::isVector() to check if the returned value is vector or scalar
returns invalid block for DataOnFaces and DataOnVertices.
Definition at line 516 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns whether the mesh frame has been modified since the last save.
Reimplemented from QgsMapLayer.
Definition at line 1287 of file qgsmeshlayer.cpp.
|
inline |
Access to labeling configuration.
May be nullptr
if labeling is not used.
true
. Definition at line 927 of file qgsmeshlayer.h.
|
inline |
Access to const labeling configuration.
May be nullptr
if labeling is not used.
true
.Definition at line 919 of file qgsmeshlayer.h.
bool QgsMeshLayer::labelsEnabled | ( | ) | const |
Returns whether the layer contains labels which are enabled and should be drawn.
true
if layer contains enabled labelsDefinition at line 2187 of file qgsmeshlayer.cpp.
|
virtual |
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)
resultFlag | a reference to a flag that will be set to false if we did not manage to load the default style. |
Reimplemented from QgsMapLayer.
Definition at line 191 of file qgsmeshlayer.cpp.
int QgsMeshLayer::meshEdgeCount | ( | ) | const |
Returns the edges count of the mesh frame.
Definition at line 1335 of file qgsmeshlayer.cpp.
QgsMeshEditor * QgsMeshLayer::meshEditor | ( | ) |
Returns a pointer to the mesh editor own by the mesh layer.
Definition at line 1280 of file qgsmeshlayer.cpp.
int QgsMeshLayer::meshFaceCount | ( | ) | const |
Returns the faces count of the mesh frame.
Definition at line 1324 of file qgsmeshlayer.cpp.
QgsMeshSimplificationSettings QgsMeshLayer::meshSimplificationSettings | ( | ) | const |
Returns mesh simplification settings.
Definition at line 1581 of file qgsmeshlayer.cpp.
int QgsMeshLayer::meshVertexCount | ( | ) | const |
Returns the vertices count of the mesh frame.
Definition at line 1313 of file qgsmeshlayer.cpp.
QgsMesh * QgsMeshLayer::nativeMesh | ( | ) |
Returns native mesh (nullptr
before rendering or calling to updateMesh)
Definition at line 306 of file qgsmeshlayer.cpp.
const QgsMesh * QgsMeshLayer::nativeMesh | ( | ) | const |
Returns native mesh (nullptr
before rendering or calling to updateMesh)
Definition at line 313 of file qgsmeshlayer.cpp.
|
delete |
QString QgsMeshLayer::providerType | ( | ) | const |
Returns the provider type for this layer.
Definition at line 169 of file qgsmeshlayer.cpp.
|
overridevirtual |
Read the style for the current layer from the DOM node supplied.
node | node that will contain the style 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) |
categories | the style categories to be read |
true
in case of success. false
. Reimplemented from QgsMapLayer.
Definition at line 1828 of file qgsmeshlayer.cpp.
|
overridevirtual |
Read the symbology for the current layer from the DOM node supplied.
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) |
categories | the style categories to be read |
true
in case of success. Implements QgsMapLayer.
Definition at line 1694 of file qgsmeshlayer.cpp.
|
overridevirtual |
Called by readLayerXML(), used by children to read state specific to them from project files.
Reimplemented from QgsMapLayer.
Definition at line 1849 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::reindex | ( | const QgsCoordinateTransform & | transform, |
bool | renumber | ||
) |
Re-indexes the faces and vertices, and renumber the indexes if renumber is true
.
rebuilds the triangular mesh and its spatial index with transform, clean the undostack
Returns false
if the operation fails
Definition at line 1261 of file qgsmeshlayer.cpp.
|
overridevirtual |
Synchronises with changes in the datasource.
Reimplemented from QgsMapLayer.
Definition at line 1970 of file qgsmeshlayer.cpp.
|
signal |
Emitted when the mesh layer is reloaded, see reload()
QgsMeshLayerRendererCache * QgsMeshLayer::rendererCache | ( | ) |
Returns native mesh (nullptr
before rendering)
Definition at line 382 of file qgsmeshlayer.cpp.
QgsMeshRendererSettings QgsMeshLayer::rendererSettings | ( | ) | const |
Returns renderer settings.
Definition at line 389 of file qgsmeshlayer.cpp.
void QgsMeshLayer::resetDatasetGroupTreeItem | ( | ) |
Reset the dataset group tree item to default from provider.
Definition at line 1020 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::rollBackFrameEditing | ( | const QgsCoordinateTransform & | transform, |
bool | continueEditing = true |
||
) |
Rolls Back editing of the mesh frame.
Reload mesh from file, rebuilds the triangular mesh and its spatial index with transform, Continue editing with the same mesh editor if continueEditing is true
true
if the rollback succeeds Definition at line 1214 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::saveDataset | ( | const QString & | path, |
int | datasetGroupIndex, | ||
QString | driver | ||
) |
Saves datasets group on file with the specified driver.
path | the path of the file |
datasetGroupIndex | the index of the dataset group |
driver | the driver to used for saving |
Definition at line 299 of file qgsmeshlayer.cpp.
QList< int > QgsMeshLayer::selectFacesByExpression | ( | QgsExpression | expression | ) |
Returns a list of faces indexes that meet the condition defined by expression with the context expressionContext.
To express the relation with a face, the expression can be defined with function returning value linked to the current face, like " $face_area "
Definition at line 1515 of file qgsmeshlayer.cpp.
QList< int > QgsMeshLayer::selectVerticesByExpression | ( | QgsExpression | expression | ) |
Returns a list of vertex indexes that meet the condition defined by expression with the context expressionContext.
To express the relation with a vertex, the expression can be defined with function returning value linked to the current vertex, like " $vertex_z ", "$vertex_as_point"
Definition at line 1482 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setDatasetGroupTreeRootItem | ( | QgsMeshDatasetGroupTreeItem * | rootItem | ) |
Sets the root items of the dataset group tree item.
Changes active dataset groups if those one are not enabled anymore :
Doesn't take ownership of the pointed item, the root item is cloned.
rootItem | the new root item |
Definition at line 866 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setLabeling | ( | QgsAbstractMeshLayerLabeling * | labeling | ) |
Sets labeling configuration.
Takes ownership of the object.
Definition at line 2201 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setLabelsEnabled | ( | bool | enabled | ) |
Sets whether labels should be enabled for the layer.
true
and a labeling object is returned by labeling().Definition at line 2194 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setMeshSimplificationSettings | ( | const QgsMeshSimplificationSettings & | meshSimplificationSettings | ) |
void QgsMeshLayer::setReferenceTime | ( | const QDateTime & | referenceTime | ) |
Sets the reference time of the layer.
referenceTime | the reference time |
Definition at line 913 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setRendererSettings | ( | const QgsMeshRendererSettings & | settings | ) |
Sets new renderer settings.
Definition at line 396 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setStaticScalarDatasetIndex | ( | const QgsMeshDatasetIndex & | staticScalarDatasetIndex | ) |
Sets the static scalar dataset index that is rendered if the temporal properties is not active.
staticScalarDatasetIndex | the scalar data set index |
Definition at line 1568 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setStaticVectorDatasetIndex | ( | const QgsMeshDatasetIndex & | staticVectorDatasetIndex | ) |
Sets the static vector dataset index that is rendered if the temporal properties is not active.
staticVectorDatasetIndex | the vector data set index |
Definition at line 1555 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setTemporalMatchingMethod | ( | const QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod & | matchingMethod | ) |
Sets the method used to match the temporal dataset from a requested time, see activeVectorDatasetAtTime()
matchingMethod | the matching method |
Definition at line 923 of file qgsmeshlayer.cpp.
void QgsMeshLayer::setTimeSettings | ( | const QgsMeshTimeSettings & | settings | ) |
|
overrideslot |
Sets the coordinate transform context to transformContext.
Definition at line 658 of file qgsmeshlayer.cpp.
QgsPointXY QgsMeshLayer::snapOnElement | ( | QgsMesh::ElementType | elementType, |
const QgsPointXY & | point, | ||
double | searchRadius | ||
) |
Returns the position of the snapped point on the mesh element closest to point intersecting with the searching area defined by point and searchRadius.
For vertex, the snapped position is the vertex position For edge, the snapped position is the projected point on the edge, extremity of edge if outside the edge For face, the snapped position is the centroid of the face The returned position is in map coordinates.
elementType | the type of element to snap |
point | the center of the search area in map coordinates |
searchRadius | the radius of the search area in map units |
Definition at line 1466 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::startFrameEditing | ( | const QgsCoordinateTransform & | transform | ) |
Starts editing of the mesh frame.
Coordinate transform used to initialize the triangular mesh if needed. This operation will disconnect the mesh layer from the data provider and removes all existing dataset group
Definition at line 1095 of file qgsmeshlayer.cpp.
bool QgsMeshLayer::startFrameEditing | ( | const QgsCoordinateTransform & | transform, |
QgsMeshEditingError & | error, | ||
bool | fixErrors | ||
) |
Starts editing of the mesh frame.
Coordinate transform used to initialize the triangular mesh if needed. This operation will disconnect the mesh layer from the data provider and removes all existing dataset group. Returns false
if starting fails and the error that is the reason (No error, if the mesh is not editable or already in edit mode).
If fixErrors is set to true
, errors will be attempted to be fixed. In that case returns false
if there is an error that could not be fixed and the remaining error.
Definition at line 1103 of file qgsmeshlayer.cpp.
QgsMeshDatasetIndex QgsMeshLayer::staticScalarDatasetIndex | ( | int | group = -1 | ) | const |
Returns the static scalar dataset index that is rendered if the temporal properties is not active.
Since QGIS 3.38, the group argument can be used to specify a fixed group to use. If this is not specified, then the active group from the layer's renderer will be used.
Definition at line 1548 of file qgsmeshlayer.cpp.
QgsMeshDatasetIndex QgsMeshLayer::staticVectorDatasetIndex | ( | int | group = -1 | ) | const |
Returns the static vector dataset index that is rendered if the temporal properties is not active.
Since QGIS 3.38, the group argument can be used to specify a fixed group to use. If this is not specified, then the active group from the layer's renderer will be used.
Definition at line 906 of file qgsmeshlayer.cpp.
void QgsMeshLayer::stopFrameEditing | ( | const QgsCoordinateTransform & | transform | ) |
Stops editing of the mesh, re-indexes the faces and vertices, rebuilds the triangular mesh and its spatial index with transform, clean the undostack.
Definition at line 1249 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns the sublayers of this layer.
(Useful for providers that manage their own layers, such as WMS).
Reimplemented from QgsMapLayer.
Definition at line 2000 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns whether the layer supports editing or not.
false
if the layer is read only or the data provider has no editing capabilities. false
. Reimplemented from QgsMapLayer.
Definition at line 176 of file qgsmeshlayer.cpp.
|
overridevirtual |
Returns the layer's temporal properties.
This may be nullptr
, depending on the layer type.
Reimplemented from QgsMapLayer.
Definition at line 2173 of file qgsmeshlayer.cpp.
QgsMeshTimeSettings QgsMeshLayer::timeSettings | ( | ) | const |
|
signal |
Emitted when time format is changed.
QgsTriangularMesh * QgsMeshLayer::triangularMesh | ( | double | minimumTriangleSize = 0 | ) | const |
Returns triangular mesh (nullptr
before rendering or calling to updateMesh).
If the parameter triangleSize is provided, among the base triangular mesh and the simplified triangular meshes, the one returned is which has the average triangle size just greater than triangleSize. The size of a triangle is the maximum between the height and the width of the triangle bounding box For default parameter (=0), it returns base triangular mesh.
minimumTriangleSize | is the average size criteria in canvas map units |
Definition at line 320 of file qgsmeshlayer.cpp.
QgsTriangularMesh * QgsMeshLayer::triangularMeshByLodIndex | ( | int | lodIndex | ) | const |
Returns triangular corresponding to the index of level of details.
If lodIndex is greater than the count of levels of detail, returns the last one (with lesser triangles) If lodIndex is lesser or equal to 0, returns the original triangular mesh
lodIndex | the level od detail index |
Definition at line 343 of file qgsmeshlayer.cpp.
int QgsMeshLayer::triangularMeshLevelOfDetailCount | ( | ) | const |
Returns the count of levels of detail of the mesh simplification.
Definition at line 336 of file qgsmeshlayer.cpp.
void QgsMeshLayer::updateTriangularMesh | ( | const QgsCoordinateTransform & | transform = QgsCoordinateTransform() | ) |
Gets native mesh and updates (creates if it doesn't exist) the base triangular mesh.
transform | Transformation from layer CRS to destination (e.g. map) CRS. With invalid transform, it keeps the native mesh CRS |
Definition at line 358 of file qgsmeshlayer.cpp.
|
overridevirtual |
Write just the symbology information for the layer into the document.
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) |
categories | the style categories to be written |
true
in case of success. false
. Reimplemented from QgsMapLayer.
Definition at line 1821 of file qgsmeshlayer.cpp.
|
overridevirtual |
Write the style for the layer into the document provided.
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) |
categories | the style categories to be written |
true
in case of success. Implements QgsMapLayer.
Definition at line 1765 of file qgsmeshlayer.cpp.
|
overridevirtual |
Called by writeLayerXML(), used by children to write state specific to them to project files.
Reimplemented from QgsMapLayer.
Definition at line 1920 of file qgsmeshlayer.cpp.