QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | List of all members
QgsLine3DSymbol Class Reference

3 3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness). More...

#include <qgsline3dsymbol.h>

Inheritance diagram for QgsLine3DSymbol:
Inheritance graph
[legend]

Public Member Functions

 QgsLine3DSymbol ()=default
 Constructor for QgsLine3DSymbol. More...
 
Qgs3DTypes::AltitudeBinding altitudeBinding () const
 Returns method that determines how altitude is bound to individual vertices. More...
 
Qgs3DTypes::AltitudeClamping altitudeClamping () const
 Returns method that determines altitude (whether to clamp to feature to terrain) More...
 
QgsAbstract3DSymbolclone () const override
 Returns a new instance of the symbol with the same settings. More...
 
float extrusionHeight () const
 Returns extrusion height (in map units) More...
 
float height () const
 Returns height (altitude) of the symbol (in map units) More...
 
QgsPhongMaterialSettings material () const
 Returns material used for shading of the symbol. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads symbol configuration from the given DOM element. More...
 
bool renderAsSimpleLines () const
 Returns whether the renderer will render data with simple lines (otherwise it uses buffer) More...
 
void setAltitudeBinding (Qgs3DTypes::AltitudeBinding altBinding)
 Sets method that determines how altitude is bound to individual vertices. More...
 
void setAltitudeClamping (Qgs3DTypes::AltitudeClamping altClamping)
 Sets method that determines altitude (whether to clamp to feature to terrain) More...
 
void setExtrusionHeight (float extrusionHeight)
 Sets extrusion height (in map units) More...
 
void setHeight (float height)
 Sets height (altitude) of the symbol (in map units) More...
 
void setMaterial (const QgsPhongMaterialSettings &material)
 Sets material used for shading of the symbol. More...
 
void setRenderAsSimpleLines (bool enabled)
 Sets whether the renderer will render data with simple lines (otherwise it uses buffer) More...
 
void setWidth (float width)
 Sets width of the line symbol (in map units) More...
 
QString type () const override
 Returns identifier of symbol type. Each 3D symbol implementation should return a different type. More...
 
float width () const
 Returns width of the line symbol (in map units) More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 Writes symbol configuration to the given DOM element. More...
 
- Public Member Functions inherited from QgsAbstract3DSymbol
virtual ~QgsAbstract3DSymbol ()=default
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the symbol layer's property collection, used for data defined overrides. More...
 

Additional Inherited Members

- Public Types inherited from QgsAbstract3DSymbol
enum  Property { PropertyHeight = 0, PropertyExtrusionHeight }
 Data definable properties. More...
 
- Static Public Member Functions inherited from QgsAbstract3DSymbol
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 
- Protected Attributes inherited from QgsAbstract3DSymbol
QgsPropertyCollection mDataDefinedProperties
 

Detailed Description

3 3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness).

Warning
This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.
Since
QGIS 3.0

Definition at line 35 of file qgsline3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsLine3DSymbol()

QgsLine3DSymbol::QgsLine3DSymbol ( )
default

Constructor for QgsLine3DSymbol.

Member Function Documentation

◆ altitudeBinding()

Qgs3DTypes::AltitudeBinding QgsLine3DSymbol::altitudeBinding ( ) const
inline

Returns method that determines how altitude is bound to individual vertices.

Definition at line 53 of file qgsline3dsymbol.h.

◆ altitudeClamping()

Qgs3DTypes::AltitudeClamping QgsLine3DSymbol::altitudeClamping ( ) const
inline

Returns method that determines altitude (whether to clamp to feature to terrain)

Definition at line 48 of file qgsline3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsLine3DSymbol::clone ( ) const
overridevirtual

Returns a new instance of the symbol with the same settings.

Implements QgsAbstract3DSymbol.

Definition at line 20 of file qgsline3dsymbol.cpp.

◆ extrusionHeight()

float QgsLine3DSymbol::extrusionHeight ( ) const
inline

Returns extrusion height (in map units)

Definition at line 68 of file qgsline3dsymbol.h.

◆ height()

float QgsLine3DSymbol::height ( ) const
inline

Returns height (altitude) of the symbol (in map units)

Definition at line 63 of file qgsline3dsymbol.h.

◆ material()

QgsPhongMaterialSettings QgsLine3DSymbol::material ( ) const
inline

Returns material used for shading of the symbol.

Definition at line 78 of file qgsline3dsymbol.h.

◆ readXml()

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

Reads symbol configuration from the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 45 of file qgsline3dsymbol.cpp.

◆ renderAsSimpleLines()

bool QgsLine3DSymbol::renderAsSimpleLines ( ) const
inline

Returns whether the renderer will render data with simple lines (otherwise it uses buffer)

Definition at line 73 of file qgsline3dsymbol.h.

◆ setAltitudeBinding()

void QgsLine3DSymbol::setAltitudeBinding ( Qgs3DTypes::AltitudeBinding  altBinding)
inline

Sets method that determines how altitude is bound to individual vertices.

Definition at line 55 of file qgsline3dsymbol.h.

◆ setAltitudeClamping()

void QgsLine3DSymbol::setAltitudeClamping ( Qgs3DTypes::AltitudeClamping  altClamping)
inline

Sets method that determines altitude (whether to clamp to feature to terrain)

Definition at line 50 of file qgsline3dsymbol.h.

◆ setExtrusionHeight()

void QgsLine3DSymbol::setExtrusionHeight ( float  extrusionHeight)
inline

Sets extrusion height (in map units)

Definition at line 70 of file qgsline3dsymbol.h.

◆ setHeight()

void QgsLine3DSymbol::setHeight ( float  height)
inline

Sets height (altitude) of the symbol (in map units)

Definition at line 65 of file qgsline3dsymbol.h.

◆ setMaterial()

void QgsLine3DSymbol::setMaterial ( const QgsPhongMaterialSettings material)
inline

Sets material used for shading of the symbol.

Definition at line 80 of file qgsline3dsymbol.h.

◆ setRenderAsSimpleLines()

void QgsLine3DSymbol::setRenderAsSimpleLines ( bool  enabled)
inline

Sets whether the renderer will render data with simple lines (otherwise it uses buffer)

Definition at line 75 of file qgsline3dsymbol.h.

◆ setWidth()

void QgsLine3DSymbol::setWidth ( float  width)
inline

Sets width of the line symbol (in map units)

Definition at line 60 of file qgsline3dsymbol.h.

◆ type()

QString QgsLine3DSymbol::type ( ) const
inlineoverridevirtual

Returns identifier of symbol type. Each 3D symbol implementation should return a different type.

Implements QgsAbstract3DSymbol.

Definition at line 41 of file qgsline3dsymbol.h.

◆ width()

float QgsLine3DSymbol::width ( ) const
inline

Returns width of the line symbol (in map units)

Definition at line 58 of file qgsline3dsymbol.h.

◆ writeXml()

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

Writes symbol configuration to the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 25 of file qgsline3dsymbol.cpp.


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