QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsTiledSceneDataProvider Class Referenceabstract

Base class for data providers for QgsTiledSceneLayer. More...

#include <qgstiledscenedataprovider.h>

Inheritance diagram for QgsTiledSceneDataProvider:
Inheritance graph
[legend]

Public Member Functions

 QgsTiledSceneDataProvider (const QgsTiledSceneDataProvider &other)
 
 QgsTiledSceneDataProvider (const QString &uri, const QgsDataProvider::ProviderOptions &providerOptions, Qgis::DataProviderReadFlags flags=Qgis::DataProviderReadFlags())
 Constructor for QgsTiledSceneDataProvider.
 
 ~QgsTiledSceneDataProvider () override
 
virtual const QgsTiledSceneBoundingVolumeboundingVolume () const =0
 Returns the bounding volume for the data provider.
 
virtual Qgis::TiledSceneProviderCapabilities capabilities () const
 Returns flags containing the supported capabilities for the data provider.
 
virtual QgsTiledSceneDataProviderclone () const =0
 Returns a clone of the data provider.
 
virtual QgsTiledSceneIndex index () const =0
 Returns the provider's tile index.
 
QgsTiledSceneDataProvideroperator= (const QgsTiledSceneDataProvider &other)=delete
 
virtual const QgsCoordinateReferenceSystem sceneCrs () const =0
 Returns the original coordinate reference system for the tiled scene data.
 
virtual QgsDoubleRange zRange () const
 Returns the provider's z range, or an infinite range if this is not known.
 
- Public Member Functions inherited from QgsDataProvider
 QgsDataProvider (const QString &uri=QString(), const QgsDataProvider::ProviderOptions &providerOptions=QgsDataProvider::ProviderOptions(), Qgis::DataProviderReadFlags flags=Qgis::DataProviderReadFlags())
 Create a new dataprovider with the specified in the uri.
 
virtual QgsCoordinateReferenceSystem crs () const =0
 Returns the coordinate system for the data source.
 
virtual QString dataComment () const
 Returns a short comment for the data that this provider is providing access to (e.g.
 
virtual QString dataSourceUri (bool expandAuthConfig=false) const
 Gets the data source specification.
 
virtual QDateTime dataTimestamp () const
 Current time stamp of data source.
 
virtual QString description () const =0
 Returns description.
 
virtual QgsDataProviderElevationPropertieselevationProperties ()
 Returns the provider's elevation properties.
 
virtual const QgsDataProviderElevationPropertieselevationProperties () const
 Returns the provider's elevation properties.
 
virtual bool enterUpdateMode ()
 Enter update mode.
 
virtual QgsError error () const
 Gets current status error.
 
virtual QgsRectangle extent () const =0
 Returns the extent of the layer.
 
virtual QgsBox3D extent3D () const
 Returns the 3D extent of the layer.
 
virtual QString fileRasterFilters () const
 Returns raster file filter string.
 
virtual QString fileVectorFilters () const
 Returns vector file filter string.
 
virtual Qgis::DataProviderFlags flags () const
 Returns the generic data provider flags.
 
virtual QString htmlMetadata () const
 Obtain a formatted HTML string containing assorted metadata for this data provider.
 
virtual void invalidateConnections (const QString &connection)
 Invalidate connections corresponding to specified name.
 
virtual bool isValid () const =0
 Returns true if this is a valid layer.
 
virtual QgsLayerMetadata layerMetadata () const
 Returns layer metadata collected from the provider's source.
 
virtual bool leaveUpdateMode ()
 Leave update mode.
 
virtual QString name () const =0
 Returns a provider name.
 
QVariant providerProperty (int property, const QVariant &defaultValue) const
 Gets the current value of a certain provider property.
 
QVariant providerProperty (ProviderProperty property, const QVariant &defaultValue=QVariant()) const
 Gets the current value of a certain provider property.
 
virtual void reloadData ()
 Reloads the data from the source for providers with data caches to synchronize, changes in the data source, feature counts and other specific actions.
 
virtual bool renderInPreview (const QgsDataProvider::PreviewContext &context)
 Returns whether the layer must be rendered in preview jobs.
 
virtual void setDataSourceUri (const QString &uri)
 Set the data source specification.
 
virtual void setLayerOrder (const QStringList &layers)
 Reorder the list of layer names to be rendered by this provider (in order from bottom to top)
 
virtual void setListening (bool isListening)
 Set whether the provider will listen to datasource notifications If set, the provider will issue notify signals.
 
void setProviderProperty (int property, const QVariant &value)
 Allows setting arbitrary properties on the provider.
 
void setProviderProperty (ProviderProperty property, const QVariant &value)
 Allows setting arbitrary properties on the provider.
 
virtual void setSubLayerVisibility (const QString &name, bool vis)
 Set the visibility of the given sublayer name.
 
virtual bool setSubsetString (const QString &subset, bool updateFeatureCount=true)
 Set the subset string used to create a subset of features in the layer.
 
virtual void setTransformContext (const QgsCoordinateTransformContext &transformContext)
 Sets data coordinate transform context to transformContext.
 
void setUri (const QgsDataSourceUri &uri)
 Set the data source specification.
 
void setUri (const QString &uri)
 Set the data source specification.
 
virtual Qgis::ProviderStyleStorageCapabilities styleStorageCapabilities () const
 Returns the style storage capabilities.
 
virtual uint subLayerCount () const
 Returns the number of layers for the current data source.
 
virtual QStringList subLayers () const
 Sub-layers handled by this provider, in order from bottom to top.
 
virtual QStringList subLayerStyles () const
 Sub-layer styles for each sub-layer handled by this provider, in order from bottom to top.
 
virtual QString subsetString () const
 Returns the subset definition string currently in use by the layer and used by the provider to limit the feature set.
 
virtual QString subsetStringDialect () const
 Returns a user-friendly string describing the dialect which is supported for subset strings by the provider.
 
virtual QString subsetStringHelpUrl () const
 Returns a URL pointing to documentation describing the dialect which is supported for subset strings by the provider.
 
virtual bool supportsSubsetString () const
 Returns true if the provider supports setting of subset strings.
 
virtual QgsDataProviderTemporalCapabilitiestemporalCapabilities ()
 Returns the provider's temporal capabilities.
 
virtual const QgsDataProviderTemporalCapabilitiestemporalCapabilities () const
 Returns the provider's temporal capabilities.
 
virtual QDateTime timestamp () const
 Time stamp of data source in the moment when data/metadata were loaded by provider.
 
QgsCoordinateTransformContext transformContext () const
 Returns data provider coordinate transform context.
 
virtual void updateExtents ()
 Update the extents of the layer.
 
QgsDataSourceUri uri () const
 Gets the data source specification.
 
virtual bool writeLayerMetadata (const QgsLayerMetadata &metadata)
 Writes layer metadata to the underlying provider source.
 

Additional Inherited Members

- Public Types inherited from QgsDataProvider
enum  ProviderProperty { EvaluateDefaultValues , CustomData = 3000 }
 Properties are used to pass custom configuration options into data providers. More...
 
- Signals inherited from QgsDataProvider
void dataChanged ()
 Emitted whenever a change is made to the data provider which may have caused changes in the provider's data OUTSIDE of QGIS.
 
void fullExtentCalculated ()
 Emitted whenever a deferred extent calculation is completed by the provider.
 
void notify (const QString &msg)
 Emitted when the datasource issues a notification.
 
- Static Public Member Functions inherited from QgsDataProvider
static QString sublayerSeparator ()
 String sequence used for separating components of sublayers strings.
 
- Protected Member Functions inherited from QgsDataProvider
void appendError (const QgsErrorMessage &message)
 Add error message.
 
void setError (const QgsError &error)
 Sets error message.
 
- Protected Attributes inherited from QgsDataProvider
QgsError mError
 Error.
 
Qgis::DataProviderReadFlags mReadFlags
 Read flags. It's up to the subclass to respect these when needed.
 
QDateTime mTimestamp
 Timestamp of data in the moment when the data were loaded by provider.
 

Detailed Description

Base class for data providers for QgsTiledSceneLayer.

Since
QGIS 3.34

Definition at line 35 of file qgstiledscenedataprovider.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneDataProvider() [1/2]

QgsTiledSceneDataProvider::QgsTiledSceneDataProvider ( const QString &  uri,
const QgsDataProvider::ProviderOptions providerOptions,
Qgis::DataProviderReadFlags  flags = Qgis::DataProviderReadFlags() 
)

Constructor for QgsTiledSceneDataProvider.

Definition at line 21 of file qgstiledscenedataprovider.cpp.

◆ ~QgsTiledSceneDataProvider()

QgsTiledSceneDataProvider::~QgsTiledSceneDataProvider ( )
overridedefault

◆ QgsTiledSceneDataProvider() [2/2]

QgsTiledSceneDataProvider::QgsTiledSceneDataProvider ( const QgsTiledSceneDataProvider other)

Definition at line 29 of file qgstiledscenedataprovider.cpp.

Member Function Documentation

◆ boundingVolume()

virtual const QgsTiledSceneBoundingVolume & QgsTiledSceneDataProvider::boundingVolume ( ) const
pure virtual

Returns the bounding volume for the data provider.

This corresponds to the root node bounding volume.

Warning
Coordinates in the returned volume are in the sceneCrs() reference system, not the QgsDataProvider::crs() system.

◆ capabilities()

Qgis::TiledSceneProviderCapabilities QgsTiledSceneDataProvider::capabilities ( ) const
virtual

Returns flags containing the supported capabilities for the data provider.

Definition at line 37 of file qgstiledscenedataprovider.cpp.

◆ clone()

virtual QgsTiledSceneDataProvider * QgsTiledSceneDataProvider::clone ( ) const
pure virtual

Returns a clone of the data provider.

◆ index()

virtual QgsTiledSceneIndex QgsTiledSceneDataProvider::index ( ) const
pure virtual

Returns the provider's tile index.

This is a shallow copy, implicitly shared container for an underlying QgsAbstractTiledSceneIndex implementation.

The index is thread safe and can be used safely across multiple threads or transferred between threads.

◆ operator=()

QgsTiledSceneDataProvider & QgsTiledSceneDataProvider::operator= ( const QgsTiledSceneDataProvider other)
delete

◆ sceneCrs()

virtual const QgsCoordinateReferenceSystem QgsTiledSceneDataProvider::sceneCrs ( ) const
pure virtual

Returns the original coordinate reference system for the tiled scene data.

This may differ from the QgsDataProvider::crs(), which is the best CRS representation for the data provider for 2D use.

Warning
Care must be taken to ensure that sceneCrs() is used instead of crs() whenever transforming bounding volumes or geometries associated with the provider.

◆ zRange()

QgsDoubleRange QgsTiledSceneDataProvider::zRange ( ) const
virtual

Returns the provider's z range, or an infinite range if this is not known.

Definition at line 44 of file qgstiledscenedataprovider.cpp.


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