Class: QgsHillshadeRendererWidget

Renderer widget for the hill shade renderer.

QgsHillshadeRendererWidget

Class Hierarchy

Base classes

QgsRasterRendererWidget	Abstract base class for widgets which configure a QgsRasterRenderer.
QWidget
QObject
QPaintDevice

class qgis.gui.QgsHillshadeRendererWidget

Bases: QgsRasterRendererWidget

__init__(layer: QgsRasterLayer | None, extent: QgsRectangle = QgsRectangle())

Renderer widget for the hill shade renderer.

Parameters:

• layer (Optional[QgsRasterLayer]) – The layer attached for this widget.

• extent (QgsRectangle = QgsRectangle()) – The current extent.

altitude(self) → float

Returns the angle of the light source over the raster.

See also

setAltitude()

Return type:

float

azimuth(self) → float

Returns the direction of the light over the raster between 0-360.

See also

setAzimuth()

Return type:

float

static create(layer: QgsRasterLayer | None, extent: QgsRectangle) → QgsRasterRendererWidget | None

Factory method to create the renderer for this type.

Parameters:

• layer (Optional[QgsRasterLayer])

• extent (QgsRectangle)

Return type:

Optional[QgsRasterRendererWidget]

multiDirectional(self) → bool

Returns True if the renderer should use the multi-directional hillshade algorithm.

See also

setMultiDirectional()

Return type:

bool

setAltitude(self, altitude: float)

Set the altitude of the light source

Parameters:

altitude (float) – the altitude

See also

altitude()

setAzimuth(self, azimuth: float)

Set the azimuth of the light source.

Parameters:

azimuth (float) – The azimuth of the light source, between 0 and 360.0

See also

azimuth()

setFromRenderer(self, renderer: QgsRasterRenderer | None)

Set the widget state from the given renderer.

Parameters:

renderer (Optional[QgsRasterRenderer]) – The renderer to take the state from.

setMultiDirectional(self, isMultiDirectional: bool)

Sets whether to render using a multi-directional hillshade algorithm.

Parameters:

isMultiDirectional (bool) – set to True to use multi directional rendering

See also

multiDirectional()

setZFactor(self, zfactor: float)

Set the Z scaling factor of the result image.

Parameters:

zfactor (float) – The z factor

See also

zFactor()

zFactor(self) → float

Returns the Z scaling factor.

See also

setZFactor()

Return type:

float