QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsAnnotationLayer3DRenderer Class Reference
3D library

3D renderers for annotation layers. More...

#include <qgsannotationlayer3drenderer.h>

Inheritance diagram for QgsAnnotationLayer3DRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsAnnotationLayer3DRenderer ()
Qgis::AltitudeClamping altitudeClamping () const
 Returns the altitude clamping method, which determines the vertical position of annotations.
QColor calloutLineColor () const
 Returns the callout line color.
double calloutLineWidth () const
 Returns the callout line width.
QgsAnnotationLayer3DRenderer * clone () const override
 Returns a cloned instance.
Qt3DCore::QEntity * createEntity (Qgs3DMapSettings *map) const override
 Returns a 3D entity that will be used to show renderer's data in 3D scene.
QgsAnnotationLayer * layer () const
 Returns the annotation layer associated with the renderer.
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads renderer's properties from given XML element.
void resolveReferences (const QgsProject &project) override
 Resolves references to other objects - second phase of loading - after readXml().
void setAltitudeClamping (Qgis::AltitudeClamping clamping)
 Sets the altitude clamping method, which determines the vertical position of annotations.
void setCalloutLineColor (const QColor &color)
 Sets the callout line color.
void setCalloutLineWidth (double width)
 Sets the callout line width.
void setLayer (QgsAnnotationLayer *layer)
 Sets the annotation layer associated with the renderer.
void setShowCalloutLines (bool show)
 Sets whether callout lines are shown, vertically joining the annotations to the terrain.
void setTextFormat (const QgsTextFormat &format)
 Sets the text format to use for rendering text annotations in 3D.
void setZOffset (double offset)
 Sets the z offset, which is a fixed offset amount which will be added to z values for the annotations.
bool showCalloutLines () const
 Returns true if callout lines are shown, vertically joining the annotations to the terrain.
QgsTextFormat textFormat () const
 Returns the text format to use for rendering text annotations in 3D.
QString type () const override
 Returns unique identifier of the renderer class (used to identify subclass).
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 Writes renderer's properties to given XML element.
double zOffset () const
 Returns the z offset, which is a fixed offset amount which should be added to z values for the annotations.
Public Member Functions inherited from QgsAbstract3DRenderer
virtual ~QgsAbstract3DRenderer ()=default

Additional Inherited Members

Protected Member Functions inherited from QgsAbstract3DRenderer
 QgsAbstract3DRenderer ()=default

Detailed Description

3D renderers for annotation layers.

Since
QGIS 4.0

Definition at line 59 of file qgsannotationlayer3drenderer.h.

Constructor & Destructor Documentation

◆ QgsAnnotationLayer3DRenderer()

QgsAnnotationLayer3DRenderer::QgsAnnotationLayer3DRenderer ( )

Definition at line 44 of file qgsannotationlayer3drenderer.cpp.

Member Function Documentation

◆ altitudeClamping()

Qgis::AltitudeClamping QgsAnnotationLayer3DRenderer::altitudeClamping ( ) const
inline

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

See also
setAltitudeClamping()

Definition at line 100 of file qgsannotationlayer3drenderer.h.

◆ calloutLineColor()

QColor QgsAnnotationLayer3DRenderer::calloutLineColor ( ) const

Returns the callout line color.

See also
setCalloutLineColor()
Note
Not available in Python bindings

Definition at line 81 of file qgsannotationlayer3drenderer.cpp.

◆ calloutLineWidth()

double QgsAnnotationLayer3DRenderer::calloutLineWidth ( ) const

Returns the callout line width.

See also
setCalloutLineWidth()
Note
Not available in Python bindings

Definition at line 91 of file qgsannotationlayer3drenderer.cpp.

◆ clone()

QgsAnnotationLayer3DRenderer * QgsAnnotationLayer3DRenderer::clone ( ) const
overridevirtual

Returns a cloned instance.

Implements QgsAbstract3DRenderer.

Definition at line 111 of file qgsannotationlayer3drenderer.cpp.

◆ createEntity()

Qt3DCore::QEntity * QgsAnnotationLayer3DRenderer::createEntity ( Qgs3DMapSettings * map) const
overridevirtual

Returns a 3D entity that will be used to show renderer's data in 3D scene.

Implements QgsAbstract3DRenderer.

Definition at line 124 of file qgsannotationlayer3drenderer.cpp.

◆ layer()

QgsAnnotationLayer * QgsAnnotationLayer3DRenderer::layer ( ) const

Returns the annotation layer associated with the renderer.

See also
setLayer()

Definition at line 56 of file qgsannotationlayer3drenderer.cpp.

◆ readXml()

void QgsAnnotationLayer3DRenderer::readXml ( const QDomElement & elem,
const QgsReadWriteContext & context )
overridevirtual

Reads renderer's properties from given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 172 of file qgsannotationlayer3drenderer.cpp.

◆ resolveReferences()

void QgsAnnotationLayer3DRenderer::resolveReferences ( const QgsProject & project)
overridevirtual

Resolves references to other objects - second phase of loading - after readXml().

Reimplemented from QgsAbstract3DRenderer.

Definition at line 61 of file qgsannotationlayer3drenderer.cpp.

◆ setAltitudeClamping()

void QgsAnnotationLayer3DRenderer::setAltitudeClamping ( Qgis::AltitudeClamping clamping)
inline

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

See also
altitudeClamping()

Definition at line 107 of file qgsannotationlayer3drenderer.h.

◆ setCalloutLineColor()

void QgsAnnotationLayer3DRenderer::setCalloutLineColor ( const QColor & color)

Sets the callout line color.

See also
calloutLineColor()
Note
Not available in Python bindings

Definition at line 76 of file qgsannotationlayer3drenderer.cpp.

◆ setCalloutLineWidth()

void QgsAnnotationLayer3DRenderer::setCalloutLineWidth ( double width)

Sets the callout line width.

See also
calloutLineWidth()
Note
Not available in Python bindings

Definition at line 86 of file qgsannotationlayer3drenderer.cpp.

◆ setLayer()

void QgsAnnotationLayer3DRenderer::setLayer ( QgsAnnotationLayer * layer)

Sets the annotation layer associated with the renderer.

See also
layer()

Definition at line 51 of file qgsannotationlayer3drenderer.cpp.

◆ setShowCalloutLines()

void QgsAnnotationLayer3DRenderer::setShowCalloutLines ( bool show)

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

See also
showCalloutLines()

Definition at line 71 of file qgsannotationlayer3drenderer.cpp.

◆ setTextFormat()

void QgsAnnotationLayer3DRenderer::setTextFormat ( const QgsTextFormat & format)

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

See also
textFormat()

Definition at line 101 of file qgsannotationlayer3drenderer.cpp.

◆ setZOffset()

void QgsAnnotationLayer3DRenderer::setZOffset ( double offset)
inline

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

See also
zOffset()

Definition at line 121 of file qgsannotationlayer3drenderer.h.

◆ showCalloutLines()

bool QgsAnnotationLayer3DRenderer::showCalloutLines ( ) const

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

See also
setShowCalloutLines()

Definition at line 66 of file qgsannotationlayer3drenderer.cpp.

◆ textFormat()

QgsTextFormat QgsAnnotationLayer3DRenderer::textFormat ( ) const

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

See also
setTextFormat()

Definition at line 96 of file qgsannotationlayer3drenderer.cpp.

◆ type()

QString QgsAnnotationLayer3DRenderer::type ( ) const
overridevirtual

Returns unique identifier of the renderer class (used to identify subclass).

Implements QgsAbstract3DRenderer.

Definition at line 106 of file qgsannotationlayer3drenderer.cpp.

◆ writeXml()

void QgsAnnotationLayer3DRenderer::writeXml ( QDomElement & elem,
const QgsReadWriteContext & context ) const
overridevirtual

Writes renderer's properties to given XML element.

Implements QgsAbstract3DRenderer.

Definition at line 156 of file qgsannotationlayer3drenderer.cpp.

◆ zOffset()

double QgsAnnotationLayer3DRenderer::zOffset ( ) const
inline

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

See also
setZOffset()

Definition at line 114 of file qgsannotationlayer3drenderer.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0