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

3 3D symbol that draws mesh geometry as planar triangles. More...

#include <qgsmesh3dsymbol.h>

Inheritance diagram for QgsMesh3DSymbol:
Inheritance graph
[legend]

Public Member Functions

 QgsMesh3DSymbol ()=default
 Constructor for QgsMesh3DSymbol. More...
 
bool addBackFaces () const
 Returns whether also triangles facing the other side will be created. 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 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...
 
void setAddBackFaces (bool add)
 Sets whether also triangles facing the other side will be created. More...
 
void setAltitudeClamping (Qgs3DTypes::AltitudeClamping altClamping)
 Sets method that determines altitude (whether to clamp to feature to terrain) 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...
 
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 mesh geometry as planar triangles.

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.6

Definition at line 36 of file qgsmesh3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsMesh3DSymbol()

QgsMesh3DSymbol::QgsMesh3DSymbol ( )
default

Constructor for QgsMesh3DSymbol.

Member Function Documentation

◆ addBackFaces()

bool QgsMesh3DSymbol::addBackFaces ( ) const
inline

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

Useful if input data have inconsistent order of vertices

Definition at line 66 of file qgsmesh3dsymbol.h.

◆ altitudeClamping()

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

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

Definition at line 49 of file qgsmesh3dsymbol.h.

◆ clone()

QgsAbstract3DSymbol * QgsMesh3DSymbol::clone ( ) const
overridevirtual

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

Implements QgsAbstract3DSymbol.

Definition at line 20 of file qgsmesh3dsymbol.cpp.

◆ height()

float QgsMesh3DSymbol::height ( ) const
inline

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

Definition at line 54 of file qgsmesh3dsymbol.h.

◆ material()

QgsPhongMaterialSettings QgsMesh3DSymbol::material ( ) const
inline

Returns material used for shading of the symbol.

Definition at line 59 of file qgsmesh3dsymbol.h.

◆ readXml()

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

Reads symbol configuration from the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 46 of file qgsmesh3dsymbol.cpp.

◆ setAddBackFaces()

void QgsMesh3DSymbol::setAddBackFaces ( bool  add)
inline

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

Useful if input data have inconsistent order of vertices

Definition at line 71 of file qgsmesh3dsymbol.h.

◆ setAltitudeClamping()

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

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

Definition at line 51 of file qgsmesh3dsymbol.h.

◆ setHeight()

void QgsMesh3DSymbol::setHeight ( float  height)
inline

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

Definition at line 56 of file qgsmesh3dsymbol.h.

◆ setMaterial()

void QgsMesh3DSymbol::setMaterial ( const QgsPhongMaterialSettings material)
inline

Sets material used for shading of the symbol.

Definition at line 61 of file qgsmesh3dsymbol.h.

◆ type()

QString QgsMesh3DSymbol::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 qgsmesh3dsymbol.h.

◆ writeXml()

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

Writes symbol configuration to the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 25 of file qgsmesh3dsymbol.cpp.


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