QGIS API Documentation 3.27.0-Master (9c08adf5ef)
Public Member Functions | Static Public Member Functions | List of all members
QgsLine3DSymbol Class Reference

3 More...

#include <qgsline3dsymbol.h>

Inheritance diagram for QgsLine3DSymbol:
Inheritance graph
[legend]

Public Member Functions

 QgsLine3DSymbol ()
 Constructor for QgsLine3DSymbol. More...
 
 ~QgsLine3DSymbol () override
 
Qgis::AltitudeBinding altitudeBinding () const
 Returns method that determines how altitude is bound to individual vertices. More...
 
Qgis::AltitudeClamping altitudeClamping () const
 Returns method that determines altitude (whether to clamp to feature to terrain) More...
 
QgsAbstract3DSymbolclone () const override SIP_FACTORY
 
QList< QgsWkbTypes::GeometryTypecompatibleGeometryTypes () const override
 
bool exportGeometries (Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix) const override SIP_SKIP
 Exports the geometries contained within the hierarchy of entity. More...
 
float extrusionHeight () const
 Returns extrusion height (in map units) More...
 
float height () const
 Returns height (altitude) of the symbol (in map units) More...
 
QgsAbstractMaterialSettingsmaterial () const
 Returns material used for shading of the symbol. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 
bool renderAsSimpleLines () const
 Returns whether the renderer will render data with simple lines (otherwise it uses buffer) More...
 
void setAltitudeBinding (Qgis::AltitudeBinding altBinding)
 Sets method that determines how altitude is bound to individual vertices. More...
 
void setAltitudeClamping (Qgis::AltitudeClamping altClamping)
 Sets method that determines altitude (whether to clamp to feature to terrain) More...
 
void setDefaultPropertiesFromLayer (const QgsVectorLayer *layer) override
 
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 (QgsAbstractMaterialSettings *material SIP_TRANSFER)
 Sets the material settings 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
 
float width () const
 Returns width of the line symbol (in map units) More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 

Static Public Member Functions

static QgsAbstract3DSymbolcreate () SIP_FACTORY
 Creates a new QgsLine3DSymbol. More...
 

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 ( )

Constructor for QgsLine3DSymbol.

Definition at line 25 of file qgsline3dsymbol.cpp.

◆ ~QgsLine3DSymbol()

QgsLine3DSymbol::~QgsLine3DSymbol ( )
overridedefault

Member Function Documentation

◆ altitudeBinding()

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

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

Definition at line 63 of file qgsline3dsymbol.h.

◆ altitudeClamping()

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

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

Definition at line 58 of file qgsline3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsLine3DSymbol::clone ( ) const
override

Definition at line 33 of file qgsline3dsymbol.cpp.

◆ compatibleGeometryTypes()

QList< QgsWkbTypes::GeometryType > QgsLine3DSymbol::compatibleGeometryTypes ( ) const
override

Definition at line 101 of file qgsline3dsymbol.cpp.

◆ create()

QgsAbstract3DSymbol * QgsLine3DSymbol::create ( )
static

Creates a new QgsLine3DSymbol.

Caller takes ownership of the returned symbol.

Definition at line 116 of file qgsline3dsymbol.cpp.

◆ exportGeometries()

bool QgsLine3DSymbol::exportGeometries ( Qgs3DSceneExporter exporter,
Qt3DCore::QEntity *  entity,
const QString &  objectNamePrefix 
) const
override

Exports the geometries contained within the hierarchy of entity.

Returns whether any objects were exported

Definition at line 121 of file qgsline3dsymbol.cpp.

◆ extrusionHeight()

float QgsLine3DSymbol::extrusionHeight ( ) const
inline

Returns extrusion height (in map units)

Definition at line 78 of file qgsline3dsymbol.h.

◆ height()

float QgsLine3DSymbol::height ( ) const
inline

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

Definition at line 73 of file qgsline3dsymbol.h.

◆ material()

QgsAbstractMaterialSettings * QgsLine3DSymbol::material ( ) const

Returns material used for shading of the symbol.

Definition at line 88 of file qgsline3dsymbol.cpp.

◆ readXml()

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

Definition at line 68 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 83 of file qgsline3dsymbol.h.

◆ setAltitudeBinding()

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

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

Definition at line 65 of file qgsline3dsymbol.h.

◆ setAltitudeClamping()

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

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

Definition at line 60 of file qgsline3dsymbol.h.

◆ setDefaultPropertiesFromLayer()

void QgsLine3DSymbol::setDefaultPropertiesFromLayer ( const QgsVectorLayer layer)
override

Definition at line 106 of file qgsline3dsymbol.cpp.

◆ setExtrusionHeight()

void QgsLine3DSymbol::setExtrusionHeight ( float  extrusionHeight)
inline

Sets extrusion height (in map units)

Definition at line 80 of file qgsline3dsymbol.h.

◆ setHeight()

void QgsLine3DSymbol::setHeight ( float  height)
inline

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

Definition at line 75 of file qgsline3dsymbol.h.

◆ setMaterial()

void QgsLine3DSymbol::setMaterial ( QgsAbstractMaterialSettings *material  SIP_TRANSFER)

Sets the material settings used for shading of the symbol.

Ownership of material is transferred to the symbol.

Definition at line 93 of file qgsline3dsymbol.cpp.

◆ setRenderAsSimpleLines()

void QgsLine3DSymbol::setRenderAsSimpleLines ( bool  enabled)
inline

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

Definition at line 85 of file qgsline3dsymbol.h.

◆ setWidth()

void QgsLine3DSymbol::setWidth ( float  width)
inline

Sets width of the line symbol (in map units)

Definition at line 70 of file qgsline3dsymbol.h.

◆ type()

QString QgsLine3DSymbol::type ( ) const
inlineoverride

Definition at line 49 of file qgsline3dsymbol.h.

◆ width()

float QgsLine3DSymbol::width ( ) const
inline

Returns width of the line symbol (in map units)

Definition at line 68 of file qgsline3dsymbol.h.

◆ writeXml()

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

Definition at line 47 of file qgsline3dsymbol.cpp.


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