Class: QgsAnnotationLayer3DRenderer

3D renderers for annotation layers.

Added in version 4.0.

Class Hierarchy

Base classes

QgsAbstract3DRenderer

Base class for all renderers that participate in 3D views.

class qgis._3d.QgsAnnotationLayer3DRenderer

Bases: QgsAbstract3DRenderer

altitudeClamping(self) → Qgis.AltitudeClamping

Returns the altitude clamping method, which determines the vertical position of annotations.

See also

setAltitudeClamping()

Return type:

Qgis.AltitudeClamping

layer(self) → QgsAnnotationLayer | None

Returns the annotation layer associated with the renderer.

See also

setLayer()

Return type:

Optional[QgsAnnotationLayer]

setAltitudeClamping(self, clamping: Qgis.AltitudeClamping)

Sets the altitude clamping method, which determines the vertical position of annotations.

See also

altitudeClamping()

Parameters:

clamping (Qgis.AltitudeClamping)

setLayer(self, layer: QgsAnnotationLayer | None)

Sets the annotation layer associated with the renderer.

See also

layer()

Parameters:

layer (Optional[QgsAnnotationLayer])

setShowCalloutLines(self, show: bool)

Sets whether callout lines are shown, vertically joining the annotations to the terrain.

See also

showCalloutLines()

Parameters:

show (bool)

setTextFormat(self, format: QgsTextFormat)

Sets the text format to use for rendering text annotations in 3D.

See also

textFormat()

Parameters:

format (QgsTextFormat)

setZOffset(self, offset: float)

Sets the z offset, which is a fixed offset amount which will be added to z values for the annotations.

See also

zOffset()

Parameters:

offset (float)

showCalloutLines(self) → bool

Returns True if callout lines are shown, vertically joining the annotations to the terrain.

See also

setShowCalloutLines()

Return type:

bool

textFormat(self) → QgsTextFormat

Returns the text format to use for rendering text annotations in 3D.

See also

setTextFormat()

Return type:

QgsTextFormat

zOffset(self) → float

Returns the z offset, which is a fixed offset amount which should be added to z values for the annotations.

See also

setZOffset()

Return type:

float