QGIS API Documentation  3.8.0-Zanzibar (11aff65)
Public Member Functions | List of all members
QgsPolygon3DSymbol Class Reference

3 3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls). More...

#include <qgspolygon3dsymbol.h>

Inheritance diagram for QgsPolygon3DSymbol:
Inheritance graph
[legend]

Public Member Functions

 QgsPolygon3DSymbol ()=default
 Constructor for QgsPolygon3DSymbol. More...
 
bool addBackFaces () const
 Returns whether also triangles facing the other side will be created. 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...
 
Qgs3DTypes::CullingMode cullingMode () const
 Returns front/back culling mode. More...
 
QColor edgeColor () const
 Returns edge lines color. More...
 
bool edgesEnabled () const
 Returns whether edge highlighting is enabled. More...
 
float edgeWidth () const
 Returns width of edge lines (in pixels) More...
 
float extrusionHeight () const
 Returns extrusion height (in map units) More...
 
float height () const
 Returns height (altitude) of the symbol (in map units) More...
 
bool invertNormals () const
 Returns whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders) 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...
 
void setAddBackFaces (bool add)
 Sets whether also triangles facing the other side will be created. 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 setCullingMode (Qgs3DTypes::CullingMode mode)
 Sets front/back culling mode. More...
 
void setEdgeColor (const QColor &color)
 Sets edge lines color. More...
 
void setEdgesEnabled (bool enabled)
 Sets whether edge highlighting is enabled. More...
 
void setEdgeWidth (float width)
 Sets width of edge lines (in pixels) 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 setInvertNormals (bool invert)
 Sets whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders) More...
 
void setMaterial (const QgsPhongMaterialSettings &material)
 Sets material used for shading of the symbol. More...
 
QString type () const override
 Returns identifier of symbol type. Each 3D symbol implementation should return a different type. 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 polygon geometries as planar polygons, optionally extruded (with added walls).

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 36 of file qgspolygon3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsPolygon3DSymbol()

QgsPolygon3DSymbol::QgsPolygon3DSymbol ( )
default

Constructor for QgsPolygon3DSymbol.

Member Function Documentation

◆ addBackFaces()

bool QgsPolygon3DSymbol::addBackFaces ( ) const
inline

Returns whether also triangles facing the other side will be created.

Useful if input data have inconsistent order of vertices

Since
QGIS 3.2

Definition at line 87 of file qgspolygon3dsymbol.h.

◆ altitudeBinding()

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

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

Definition at line 54 of file qgspolygon3dsymbol.h.

◆ altitudeClamping()

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

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

Definition at line 49 of file qgspolygon3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsPolygon3DSymbol::clone ( ) const
overridevirtual

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

Implements QgsAbstract3DSymbol.

Definition at line 21 of file qgspolygon3dsymbol.cpp.

◆ cullingMode()

Qgs3DTypes::CullingMode QgsPolygon3DSymbol::cullingMode ( ) const
inline

Returns front/back culling mode.

Definition at line 74 of file qgspolygon3dsymbol.h.

◆ edgeColor()

QColor QgsPolygon3DSymbol::edgeColor ( ) const
inline

Returns edge lines color.

Since
QGIS 3.8

Definition at line 123 of file qgspolygon3dsymbol.h.

◆ edgesEnabled()

bool QgsPolygon3DSymbol::edgesEnabled ( ) const
inline

Returns whether edge highlighting is enabled.

Since
QGIS 3.8

Definition at line 99 of file qgspolygon3dsymbol.h.

◆ edgeWidth()

float QgsPolygon3DSymbol::edgeWidth ( ) const
inline

Returns width of edge lines (in pixels)

Since
QGIS 3.8

Definition at line 111 of file qgspolygon3dsymbol.h.

◆ extrusionHeight()

float QgsPolygon3DSymbol::extrusionHeight ( ) const
inline

Returns extrusion height (in map units)

Definition at line 64 of file qgspolygon3dsymbol.h.

◆ height()

float QgsPolygon3DSymbol::height ( ) const
inline

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

Definition at line 59 of file qgspolygon3dsymbol.h.

◆ invertNormals()

bool QgsPolygon3DSymbol::invertNormals ( ) const
inline

Returns whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders)

Definition at line 79 of file qgspolygon3dsymbol.h.

◆ material()

QgsPhongMaterialSettings QgsPolygon3DSymbol::material ( ) const
inline

Returns material used for shading of the symbol.

Definition at line 69 of file qgspolygon3dsymbol.h.

◆ readXml()

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

Reads symbol configuration from the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 57 of file qgspolygon3dsymbol.cpp.

◆ setAddBackFaces()

void QgsPolygon3DSymbol::setAddBackFaces ( bool  add)
inline

Sets whether also triangles facing the other side will be created.

Useful if input data have inconsistent order of vertices

Since
QGIS 3.2

Definition at line 93 of file qgspolygon3dsymbol.h.

◆ setAltitudeBinding()

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

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

Definition at line 56 of file qgspolygon3dsymbol.h.

◆ setAltitudeClamping()

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

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

Definition at line 51 of file qgspolygon3dsymbol.h.

◆ setCullingMode()

void QgsPolygon3DSymbol::setCullingMode ( Qgs3DTypes::CullingMode  mode)
inline

Sets front/back culling mode.

Definition at line 76 of file qgspolygon3dsymbol.h.

◆ setEdgeColor()

void QgsPolygon3DSymbol::setEdgeColor ( const QColor &  color)
inline

Sets edge lines color.

Since
QGIS 3.8

Definition at line 129 of file qgspolygon3dsymbol.h.

◆ setEdgesEnabled()

void QgsPolygon3DSymbol::setEdgesEnabled ( bool  enabled)
inline

Sets whether edge highlighting is enabled.

Since
QGIS 3.8

Definition at line 105 of file qgspolygon3dsymbol.h.

◆ setEdgeWidth()

void QgsPolygon3DSymbol::setEdgeWidth ( float  width)
inline

Sets width of edge lines (in pixels)

Since
QGIS 3.8

Definition at line 117 of file qgspolygon3dsymbol.h.

◆ setExtrusionHeight()

void QgsPolygon3DSymbol::setExtrusionHeight ( float  extrusionHeight)
inline

Sets extrusion height (in map units)

Definition at line 66 of file qgspolygon3dsymbol.h.

◆ setHeight()

void QgsPolygon3DSymbol::setHeight ( float  height)
inline

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

Definition at line 61 of file qgspolygon3dsymbol.h.

◆ setInvertNormals()

void QgsPolygon3DSymbol::setInvertNormals ( bool  invert)
inline

Sets whether the normals of triangles will be inverted (useful for fixing clockwise / counter-clockwise face vertex orders)

Definition at line 81 of file qgspolygon3dsymbol.h.

◆ setMaterial()

void QgsPolygon3DSymbol::setMaterial ( const QgsPhongMaterialSettings material)
inline

Sets material used for shading of the symbol.

Definition at line 71 of file qgspolygon3dsymbol.h.

◆ type()

QString QgsPolygon3DSymbol::type ( ) const
inlineoverridevirtual

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

Implements QgsAbstract3DSymbol.

Definition at line 42 of file qgspolygon3dsymbol.h.

◆ writeXml()

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

Writes symbol configuration to the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 26 of file qgspolygon3dsymbol.cpp.


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