QGIS API Documentation 3.27.0-Master (95e00c50d2)
Public Member Functions | List of all members
QgsMapBoxGlStyleRasterSource Class Reference

Encapsulates a MapBox GL style raster source. More...

#include <qgsmapboxglstyleconverter.h>

Inheritance diagram for QgsMapBoxGlStyleRasterSource:
Inheritance graph
[legend]

Public Member Functions

 QgsMapBoxGlStyleRasterSource (const QString &name)
 Constructor for QgsMapBoxGlStyleRasterSource. More...
 
QString attribution () const
 Returns the source's attribution text. More...
 
int maximumZoom () const
 Returns the maximum tile zoom for which tiles are available. More...
 
int minimumZoom () const
 Returns the minimum tile zoom for which tiles are available. More...
 
bool setFromJson (const QVariantMap &json, QgsMapBoxGlStyleConversionContext *context) override
 Sets the source's state from a json map. More...
 
QStringList tiles () const
 Returns the list of tile sources. More...
 
int tileSize () const
 Returns the associated tile size. More...
 
QgsRasterLayertoRasterLayer () const
 Returns a new raster layer representing the raster source, or nullptr if the source cannot be represented as a raster layer. More...
 
Qgis::MapBoxGlStyleSourceType type () const override
 Returns the source type. More...
 
- Public Member Functions inherited from QgsMapBoxGlStyleAbstractSource
 QgsMapBoxGlStyleAbstractSource (const QString &name)
 Constructor for QgsMapBoxGlStyleAbstractSource. More...
 
virtual ~QgsMapBoxGlStyleAbstractSource ()
 
QString name () const
 Returns the source's name. More...
 
virtual bool setFromJson (const QVariantMap &json, QgsMapBoxGlStyleConversionContext *context)=0
 Sets the source's state from a json map. More...
 
virtual Qgis::MapBoxGlStyleSourceType type () const =0
 Returns the source type. More...
 

Detailed Description

Encapsulates a MapBox GL style raster source.

Warning
This is private API only, and may change in future QGIS versions
Since
QGIS 3.28

Definition at line 225 of file qgsmapboxglstyleconverter.h.

Constructor & Destructor Documentation

◆ QgsMapBoxGlStyleRasterSource()

QgsMapBoxGlStyleRasterSource::QgsMapBoxGlStyleRasterSource ( const QString &  name)

Constructor for QgsMapBoxGlStyleRasterSource.

Definition at line 3618 of file qgsmapboxglstyleconverter.cpp.

Member Function Documentation

◆ attribution()

QString QgsMapBoxGlStyleRasterSource::attribution ( ) const
inline

Returns the source's attribution text.

Definition at line 240 of file qgsmapboxglstyleconverter.h.

◆ maximumZoom()

int QgsMapBoxGlStyleRasterSource::maximumZoom ( ) const
inline

Returns the maximum tile zoom for which tiles are available.

See also
minimumZoom()

Definition at line 254 of file qgsmapboxglstyleconverter.h.

◆ minimumZoom()

int QgsMapBoxGlStyleRasterSource::minimumZoom ( ) const
inline

Returns the minimum tile zoom for which tiles are available.

See also
maximumZoom()

Definition at line 247 of file qgsmapboxglstyleconverter.h.

◆ setFromJson()

bool QgsMapBoxGlStyleRasterSource::setFromJson ( const QVariantMap &  json,
QgsMapBoxGlStyleConversionContext context 
)
overridevirtual

Sets the source's state from a json map.

Implements QgsMapBoxGlStyleAbstractSource.

Definition at line 3629 of file qgsmapboxglstyleconverter.cpp.

◆ tiles()

QStringList QgsMapBoxGlStyleRasterSource::tiles ( ) const
inline

Returns the list of tile sources.

Definition at line 264 of file qgsmapboxglstyleconverter.h.

◆ tileSize()

int QgsMapBoxGlStyleRasterSource::tileSize ( ) const
inline

Returns the associated tile size.

Definition at line 259 of file qgsmapboxglstyleconverter.h.

◆ toRasterLayer()

QgsRasterLayer * QgsMapBoxGlStyleRasterSource::toRasterLayer ( ) const

Returns a new raster layer representing the raster source, or nullptr if the source cannot be represented as a raster layer.

The caller takes ownership of the returned layer.

Definition at line 3657 of file qgsmapboxglstyleconverter.cpp.

◆ type()

Qgis::MapBoxGlStyleSourceType QgsMapBoxGlStyleRasterSource::type ( ) const
overridevirtual

Returns the source type.

Implements QgsMapBoxGlStyleAbstractSource.

Definition at line 3624 of file qgsmapboxglstyleconverter.cpp.


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