WCSLayer Class Reference

Renders a selected coverage from an OGC Web Coverage Service as a raster basemap layer. More...

#include <wcslayer.h>

Inheritance diagram for WCSLayer:

Collaboration diagram for WCSLayer:

Signals
void	capabilitiesFetched (const WCSServiceInfo &info)
void	capabilitiesError (const QString &errorMessage)
void	coverageReady ()
void	basemapRenderParamsChanged ()
Signals inherited from OpenSWMMVisLayer
void	nameChanged (const QString &newName)
void	layerTypeChanged (OpenSWMMVisLayerType newType)
void	visibilityChanged (bool visible)
void	opacityChanged (double opacity)
void	srsChanged (SpatialReferenceSystem *newSRS)
void	extentChanged (const MapExtent &newExtent)
void	childrenChanged ()
void	repaintRequested ()
void	temporalSpecChanged (const OpenSWMM::Render::TemporalSpec &spec)
void	maskSpecChanged (const OpenSWMM::Render::MaskSpec &spec)
void	auxStorageSpecChanged (const OpenSWMM::Render::AuxiliaryStorageSpec &spec)
void	joinsChanged (const QVector< OpenSWMM::Render::JoinSpec > &joins)
void	diagramSpecChanged (const OpenSWMM::Render::DiagramSpec &spec)
void	labelConfigChanged ()

Public Member Functions
	WCSLayer (const QUrl &serviceUrl, OpenSWMMVisWorkspace *parent=nullptr)
	~WCSLayer () override
QUrl	serviceUrl () const
QString	wcsVersion () const
WCSServiceInfo	serviceInfo () const
bool	capabilitiesReady () const
QString	sourceDescription () const override
	Human-readable source of this layer: a file path, a service URL, or a description for in-memory / derived layers.
void	fetchCapabilities ()
	Asynchronously fetches GetCapabilities; emits capabilitiesFetched() or capabilitiesError() when done.
void	setServiceInfo (const WCSServiceInfo &info)
	Injects already-fetched service info (from the dialog) so the layer can render immediately without a second GetCapabilities round-trip.
QString	activeCoverageId () const
void	setActiveCoverageId (const QString &id)
QString	outputCrs () const
void	setOutputCrs (const QString &crs)
QString	outputFormat () const
void	setOutputFormat (const QString &fmt)
QString	rangeSubset () const
void	setRangeSubset (const QString &subset)
QString	interpolation () const
void	setInterpolation (const QString &interp)
bool	isRasterLayer () const override
	Returns true for layers that render into a raster buffer (WMS, WMTS, GISRaster) rather than populating QGraphicsItems.
bool	isBasemapLayer () const override
	Returns true for world-spanning basemap layers (XYZ tile providers, WMS/WMTS services covering the whole world) that should NOT be included when computing the data-driven full extent.
void	fetchCache (const MapExtent &extent, const QSize &viewportSize, const SpatialReferenceSystem *srs) override
	Triggers any asynchronous (or synchronous) tile/data fetch needed to populate this layer's internal cache for the given view state.
void	render (QPainter *painter, const MapExtent &extent, const QSize &imageSize, const SpatialReferenceSystem *srs) override
	Renders this layer's content directly into painter.
void	populateScene (QGraphicsScene *, const MapExtent &, const SpatialReferenceSystem *) override
	Creates / updates QGraphicsItems representing this layer in the scene.
void	depopulateScene (QGraphicsScene *scene) override
	Removes all QGraphicsItems belonging to this layer from the scene.
void	refreshScene (QGraphicsScene *scene, const MapExtent &canvasExtent, const SpatialReferenceSystem *canvasSRS) override
	Smart scene refresh — updates existing items instead of destroying and recreating.
void	onCanvasCRSChanged (const SpatialReferenceSystem *newCanvasSRS) override
	Called when the user changes the canvas CRS so layers can pre-compute any CRS-dependent transform caches.
const OpenSWMM::Render::BasemapRenderParams &	basemapRenderParams () const
void	setBasemapRenderParams (const OpenSWMM::Render::BasemapRenderParams &p)
Public Member Functions inherited from OpenSWMMVisLayer
	OpenSWMMVisLayer (OpenSWMMVisWorkspace *parent)
	OpenSWMMVisLayer (const QString &name="Unlabeled Layer", OpenSWMMVisWorkspace *parent=nullptr)
virtual	~OpenSWMMVisLayer ()
QString	layerId () const
	Returns the layer's immutable unique identifier (UUID).
QString	name () const
	Returns the user-visible name of this layer.
void	setName (const QString &name)
	Sets the user-visible name.
OpenSWMMVisLayerType	layerType () const
	Returns the layer type discriminator.
bool	isVisible () const
	Returns true when this layer should be drawn.
void	setVisible (bool visible)
	Shows or hides this layer.
double	opacity () const
	Returns the layer opacity in the range [0.0, 1.0]. 0.0 = fully transparent; 1.0 = fully opaque.
void	setOpacity (double opacity)
	Sets the layer opacity. Values are clamped to [0.0, 1.0].
SpatialReferenceSystem *	srs () const
	Returns the spatial reference system for this layer, or nullptr if the layer has no known CRS.
void	setSRS (SpatialReferenceSystem *srs, bool ownsSRS=false)
	Sets (or replaces) the CRS for this layer.
QString	crsDescription () const
	Returns a human-readable summary of this layer's CRS for display in the Properties window.
MapExtent	extent () const
	Returns the layer extent in the layer's own CRS.
void	setExtent (const MapExtent &extent)
	Sets the layer spatial extent (in the layer's CRS).
virtual QVector< QPair< QString, QString > >	extendedMetadata () const
	Ordered key→value pairs of TYPE-SPECIFIC metadata, rendered by the Metadata tab below the common block the dialog builds itself.
void	setViewportSize (int w, int h)
	Called by MapCanvas before refreshScene so layers can request the correct pixel dimensions for tile/image requests.
int	viewportWidth () const
int	viewportHeight () const
QVector< OpenSWMMVisLayer * >	children () const
	Returns the ordered list of child layers.
double	layerZValue () const
	Returns the z-value base assigned to this layer by the canvas. Items within the layer should use z-values relative to this.
virtual std::vector< std::unique_ptr< openswmmvis::ui::ILayerStyleSubject > >	styleSubjects ()
	Slice U-2 — return the styleable subjects for the unified LayerStyleDialog.
void	setLayerZValue (double z)
	Called by the canvas to set this layer's z-value band.
virtual OpenSWMM::Render::IFeatureRenderer *	renderer () const
virtual void	setRenderer (std::unique_ptr< OpenSWMM::Render::IFeatureRenderer >)
virtual OpenSWMM::Render::RuleList *	ruleList ()
virtual const OpenSWMM::Render::RuleList *	ruleList () const
const OpenSWMM::Render::TemporalSpec &	temporalSpec () const
void	setTemporalSpec (const OpenSWMM::Render::TemporalSpec &spec)
const OpenSWMM::Render::LabelConfig &	labelConfig () const
virtual void	setLabelConfig (const OpenSWMM::Render::LabelConfig &cfg)
const OpenSWMM::Render::MaskSpec &	maskSpec () const
void	setMaskSpec (const OpenSWMM::Render::MaskSpec &spec)
const OpenSWMM::Render::AuxiliaryStorageSpec &	auxStorageSpec () const
void	setAuxStorageSpec (const OpenSWMM::Render::AuxiliaryStorageSpec &spec)
const QVector< OpenSWMM::Render::JoinSpec > &	joins () const
void	setJoins (const QVector< OpenSWMM::Render::JoinSpec > &joins)
const OpenSWMM::Render::DiagramSpec &	diagramSpec () const
void	setDiagramSpec (const OpenSWMM::Render::DiagramSpec &spec)
OpenSWMMVisWorkspace *	workspace () const
void	setBasicAuth (const QString &username, const QString &password)
	Sets HTTP Basic authentication for all subsequent network requests.
void	setHttpHeaders (const BasemapHttpHeaders &headers)
	Sets arbitrary extra HTTP headers applied to every request.
BasemapHttpHeaders	httpHeaders () const

Additional Inherited Members
Public Types inherited from OpenSWMMVisLayer
enum	OpenSWMMVisLayerType {   SWMMDefaultLayer = 0 ,   SWMMModelLayer = 1 ,   SWMMResultsLayer = 2 ,   SWMMGISLayer = 3 ,   SWMMVectorLayer = 4 ,   SWMMRasterLayer = 5 ,   SWMMImageryLayer = 6 ,   SWMMTabularDataLayer = 7 ,   SWMMTabularyTimeSeriesLayer = 8 ,   SWMMSubProjectLayer = 9 ,   SWMMWMSLayer = 10 ,   SWMMWMTSLayer = 11 ,   SWMM2DMeshLayer = 12 ,   SWMM2DResultsLayer = 13 ,   SWMMAnnotationLayer = 14 ,   SWMMFeatureLayer = 15 }
	Discriminator for the concrete layer class. More...
Protected Member Functions inherited from OpenSWMMVisLayer
bool	addChild (OpenSWMMVisLayer *child)
bool	removeChild (OpenSWMMVisLayer *child)
void	setLayerType (OpenSWMMVisLayerType type)
Protected Attributes inherited from OpenSWMMVisLayer
QByteArray	m_authHeader
	"Basic <base64>" or empty
BasemapHttpHeaders	m_httpHeaders
	arbitrary headers (incl. "referer")
Properties inherited from OpenSWMMVisLayer
QString	Name
bool	Visible
double	Opacity
QString	LayerId
OpenSWMMVisLayerType	LayerType
QVector< OpenSWMMVisLayer * >	Children
QString	CRS

Detailed Description

Renders a selected coverage from an OGC Web Coverage Service as a raster basemap layer.

Rendering is single-image (like WMSLayer): one GetCoverage request is issued per viewport. The GeoTIFF (or other GDAL-readable) response is decoded in-memory and painted by render().

Typical usage:

auto *layer = new WCSLayer(QUrl("https://example.org/wcs"), workspace);
connect(layer, &WCSLayer::capabilitiesFetched, this, [layer](auto &info) {
    layer->setActiveCoverageId(info.coverages.first().identifier);
});
layer->fetchCapabilities();
canvas->addLayer(layer);

Constructor & Destructor Documentation

WCSLayer()

WCSLayer::WCSLayer ( const QUrl &  serviceUrl, OpenSWMMVisWorkspace *  parent = nullptr  )

explicit

Here is the call graph for this function:

~WCSLayer()

WCSLayer::~WCSLayer ( )

override

Member Function Documentation

activeCoverageId()

QString WCSLayer::activeCoverageId ( ) const

inline

basemapRenderParams()

const OpenSWMM::Render::BasemapRenderParams & WCSLayer::basemapRenderParams ( ) const

inline

Slice X.22 — shared basemap render adjustments.

basemapRenderParamsChanged

void WCSLayer::basemapRenderParamsChanged ( )

signal

Slice X.22 — basemap render adjustments updated.

Here is the caller graph for this function:

capabilitiesError

void WCSLayer::capabilitiesError ( const QString &  errorMessage )

signal

capabilitiesFetched

void WCSLayer::capabilitiesFetched ( const WCSServiceInfo &  info )

signal

capabilitiesReady()

bool WCSLayer::capabilitiesReady ( ) const

inline

coverageReady

void WCSLayer::coverageReady ( )

signal

depopulateScene()

void WCSLayer::depopulateScene ( QGraphicsScene *  scene )

overridevirtual

Removes all QGraphicsItems belonging to this layer from the scene.

Reimplemented from OpenSWMMVisLayer.

fetchCache()

void WCSLayer::fetchCache ( const MapExtent &  extent, const QSize &  viewportSize, const SpatialReferenceSystem *  srs  )

overridevirtual

Triggers any asynchronous (or synchronous) tile/data fetch needed to populate this layer's internal cache for the given view state.

Called by MapCanvas::refreshLayerItems() for every visible raster layer BEFORE the MapRenderJob is started. This decouples tile-requesting (potentially async HTTP) from tile-drawing (synchronous, in the background render thread).

• WMSLayer: issues a GetMap HTTP request if the cached tile is stale, then returns immediately. When the reply arrives the layer emits repaintRequested() to trigger another render pass.
• WMTSLayer: fires fetchTileIfNeeded() for every tile that covers the current viewport; already-cached tiles are skipped.
• GISRasterLayer: runs GDALWarp synchronously (fast for local files) if the cache is stale.

The default implementation is a no-op.

Parameters

extent	Visible geographic extent in canvas-CRS coordinates.
viewportSize	Pixel dimensions of the viewport.
srs	Canvas CRS.

Reimplemented from OpenSWMMVisLayer.

Here is the call graph for this function:

fetchCapabilities()

void WCSLayer::fetchCapabilities

(

)

Asynchronously fetches GetCapabilities; emits capabilitiesFetched() or capabilitiesError() when done.

interpolation()

QString WCSLayer::interpolation ( ) const

inline

isBasemapLayer()

bool WCSLayer::isBasemapLayer ( ) const

inlineoverridevirtual

Returns true for world-spanning basemap layers (XYZ tile providers, WMS/WMTS services covering the whole world) that should NOT be included when computing the data-driven full extent.

MapCanvas::fullExtent() uses this to skip basemap layers so that "Zoom to Full Extent" zooms to the project's data (SWMM network, DTM, bounded WMS coverage) rather than the whole globe. Layers with a specific, bounded geographic footprint (GISRasterLayer, local WMS/WMTS with EX_GeographicBoundingBox) return false so they participate in the extent union.

Reimplemented from OpenSWMMVisLayer.

isRasterLayer()

bool WCSLayer::isRasterLayer ( ) const

inlineoverridevirtual

Returns true for layers that render into a raster buffer (WMS, WMTS, GISRaster) rather than populating QGraphicsItems.

The MapCanvas uses this to decide whether a layer participates in the background render job or in the QGraphicsScene overlay.

Reimplemented from OpenSWMMVisLayer.

onCanvasCRSChanged()

void WCSLayer::onCanvasCRSChanged ( const SpatialReferenceSystem *  newCanvasSRS )

overridevirtual

Called when the user changes the canvas CRS so layers can pre-compute any CRS-dependent transform caches.

Parameters

newCanvasSRS

The new canvas CRS.

Reimplemented from OpenSWMMVisLayer.

outputCrs()

QString WCSLayer::outputCrs ( ) const

inline

outputFormat()

QString WCSLayer::outputFormat ( ) const

inline

populateScene()

void WCSLayer::populateScene ( QGraphicsScene *  scene, const MapExtent &  canvasExtent, const SpatialReferenceSystem *  canvasSRS  )

inlineoverridevirtual

Creates / updates QGraphicsItems representing this layer in the scene.

Derived classes override this to add their items to the scene. Items should be created in scene coordinates (= map CRS coordinates) after reprojecting from the layer's native CRS.

Called by the MapCanvas when:

• The layer is first added.
• The canvas CRS changes (after onCanvasCRSChanged).
• The layer data changes (model loaded, tile fetched, etc.).

Parameters

scene	The shared OpenSWMMVisScene to add items to.
canvasExtent	Visible extent in canvas-CRS coordinates.
canvasSRS	The CRS currently used by the MapCanvas.

Implements OpenSWMMVisLayer.

rangeSubset()

QString WCSLayer::rangeSubset ( ) const

inline

refreshScene()

void WCSLayer::refreshScene ( QGraphicsScene *  scene, const MapExtent &  canvasExtent, const SpatialReferenceSystem *  canvasSRS  )

overridevirtual

Smart scene refresh — updates existing items instead of destroying and recreating.

Override in subclasses to provide efficient incremental updates. The default implementation calls depopulateScene() then populateScene(), which is backward-compatible but causes flicker for raster/tile layers.

Raster/WMS layers should override to keep persistent scene items and update them in-place. Vector layers should override to skip rebuilding when only the view extent has changed (items are already in scene coords).

Reimplemented from OpenSWMMVisLayer.

render()

void WCSLayer::render ( QPainter *  painter, const MapExtent &  extent, const QSize &  imageSize, const SpatialReferenceSystem *  srs  )

overridevirtual

Renders this layer's content directly into painter.

Called by the background MapRenderJob for raster layers. The painter is backed by a QImage of imageSize pixels spanning the geographic area described by extent in CRS srs. Pixel (0,0) maps to (extent.xMin, extent.yMax).

The default implementation is a no-op. Raster layer subclasses (WMS, WMTS, GISRaster) override this to paint their cached tile/image data without touching QGraphicsScene.

Parameters

painter	Target painter (backed by viewport-sized QImage).
extent	Visible geographic extent in canvas-CRS coordinates.
imageSize	Pixel dimensions of the target image.
srs	Canvas CRS.

Reimplemented from OpenSWMMVisLayer.

Here is the call graph for this function:

serviceInfo()

WCSServiceInfo WCSLayer::serviceInfo ( ) const

inline

serviceUrl()

QUrl WCSLayer::serviceUrl ( ) const

inline

setActiveCoverageId()

void WCSLayer::setActiveCoverageId

(

const QString &

id

)

Here is the call graph for this function:

setBasemapRenderParams()

void WCSLayer::setBasemapRenderParams

(

const OpenSWMM::Render::BasemapRenderParams &

p

)

Here is the call graph for this function:

setInterpolation()

void WCSLayer::setInterpolation

(

const QString &

interp

)

setOutputCrs()

void WCSLayer::setOutputCrs

(

const QString &

crs

)

setOutputFormat()

void WCSLayer::setOutputFormat

(

const QString &

fmt

)

setRangeSubset()

void WCSLayer::setRangeSubset

(

const QString &

subset

)

setServiceInfo()

void WCSLayer::setServiceInfo

(

const WCSServiceInfo &

info

)

Injects already-fetched service info (from the dialog) so the layer can render immediately without a second GetCapabilities round-trip.

sourceDescription()

QString WCSLayer::sourceDescription ( ) const

inlineoverridevirtual

Human-readable source of this layer: a file path, a service URL, or a description for in-memory / derived layers.

Default empty — the dialog shows "(none)". Concrete layers override to return their real origin (e.g. modelFilePath(), resultsFilePath(), serviceUrl(), or "(generated mesh)").

Reimplemented from OpenSWMMVisLayer.

wcsVersion()

QString WCSLayer::wcsVersion ( ) const

inline

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/layers/wcslayer.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/layers/wcslayer.cpp