#include <qgspoint3dsymbol.h>

Inheritance diagram for QgsPoint3DSymbol:

Public Types
enum	Shape { Cylinder, Sphere, Cone, Cube, Torus, Plane, ExtrudedText, Model, Billboard }
	3D shape types supported by the symbol More...

Public Types inherited from QgsAbstract3DSymbol
enum	Property { PropertyHeight = 0, PropertyExtrusionHeight }
	Data definable properties. More...

Public Member Functions
	QgsPoint3DSymbol ()
	Constructor for QgsPoint3DSymbol with default QgsMarkerSymbol as the billboardSymbol. More...

	QgsPoint3DSymbol (const QgsPoint3DSymbol &other)
	Copy Constructor for QgsPoint3DSymbol. More...

Qgs3DTypes::AltitudeClamping	altitudeClamping () const
	Returns method that determines altitude (whether to clamp to feature to terrain) More...

QgsMarkerSymbol *	billboardSymbol () const
	Returns a symbol for billboard. More...

QMatrix4x4	billboardTransform () const
	Returns transform for billboards. More...

QgsAbstract3DSymbol *	clone () const override
	Returns a new instance of the symbol with the same settings. 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	setAltitudeClamping (Qgs3DTypes::AltitudeClamping altClamping)
	Sets method that determines altitude (whether to clamp to feature to terrain) More...

void	setBillboardSymbol (QgsMarkerSymbol *symbol)
	Set symbol for billboard and the ownership is transferred. More...

void	setMaterial (const QgsPhongMaterialSettings &material)
	Sets material used for shading of the symbol. More...

void	setShape (Shape shape)
	Sets 3D shape for points. More...

void	setShapeProperties (const QVariantMap &properties)
	Sets a key-value dictionary of point shape properties. More...

void	setTransform (const QMatrix4x4 &transform)
	Sets transform for individual objects represented by the symbol. More...

Shape	shape () const
	Returns 3D shape for points. More...

QVariantMap	shapeProperties () const
	Returns a key-value dictionary of point shape properties. More...

QMatrix4x4	transform () const
	Returns transform for individual objects represented by 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

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the symbol layer's property collection, used for data defined overrides. More...

const QgsPropertyCollection &	dataDefinedProperties () 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...

Static Public Member Functions
static Shape	shapeFromString (const QString &shape)
	Returns shape enum value from a string. More...

static QString	shapeToString (Shape shape)
	Returns string from a shape enum value. More...

Static Public Member Functions inherited from QgsAbstract3DSymbol
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions. More...

Additional Inherited Members
Protected Attributes inherited from QgsAbstract3DSymbol
QgsPropertyCollection	mDataDefinedProperties

Detailed Description

3 3D symbol that draws point geometries as 3D objects using one of the predefined shapes.

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 37 of file qgspoint3dsymbol.h.

Member Enumeration Documentation

◆ Shape

enum QgsPoint3DSymbol::Shape

3D shape types supported by the symbol

Enumerator
Cylinder
Sphere
Cone
Cube
Torus
Plane
ExtrudedText	Supported in Qt 5.9+.
Model
Billboard

Definition at line 76 of file qgspoint3dsymbol.h.

Constructor & Destructor Documentation

◆ QgsPoint3DSymbol() [1/2]

QgsPoint3DSymbol::QgsPoint3DSymbol ( )

Constructor for QgsPoint3DSymbol with default QgsMarkerSymbol as the billboardSymbol.

Definition at line 29 of file qgspoint3dsymbol.cpp.

◆ QgsPoint3DSymbol() [2/2]

QgsPoint3DSymbol::QgsPoint3DSymbol ( const QgsPoint3DSymbol & other )

Copy Constructor for QgsPoint3DSymbol.

Definition at line 34 of file qgspoint3dsymbol.cpp.

Member Function Documentation

◆ altitudeClamping()

Qgs3DTypes::AltitudeClamping QgsPoint3DSymbol::altitudeClamping ( ) const

inline

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

Definition at line 66 of file qgspoint3dsymbol.h.

◆ billboardSymbol()

QgsMarkerSymbol* QgsPoint3DSymbol::billboardSymbol ( ) const

inline

Returns a symbol for billboard.

Definition at line 105 of file qgspoint3dsymbol.h.

◆ billboardTransform()

QMatrix4x4 QgsPoint3DSymbol::billboardTransform ( ) const

Returns transform for billboards.

Definition at line 139 of file qgspoint3dsymbol.cpp.

◆ clone()

QgsAbstract3DSymbol * QgsPoint3DSymbol::clone ( ) const

overridevirtual

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

Implements QgsAbstract3DSymbol.

Definition at line 24 of file qgspoint3dsymbol.cpp.

◆ material()

QgsPhongMaterialSettings QgsPoint3DSymbol::material ( ) const

inline

Returns material used for shading of the symbol.

Definition at line 71 of file qgspoint3dsymbol.h.

◆ readXml()

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

overridevirtual

Reads symbol configuration from the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 78 of file qgspoint3dsymbol.cpp.

◆ setAltitudeClamping()

void QgsPoint3DSymbol::setAltitudeClamping ( Qgs3DTypes::AltitudeClamping altClamping )

inline

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

Definition at line 68 of file qgspoint3dsymbol.h.

◆ setBillboardSymbol()

void QgsPoint3DSymbol::setBillboardSymbol ( QgsMarkerSymbol * symbol )

inline

Set symbol for billboard and the ownership is transferred.

Definition at line 107 of file qgspoint3dsymbol.h.

◆ setMaterial()

void QgsPoint3DSymbol::setMaterial ( const QgsPhongMaterialSettings & material )

inline

Sets material used for shading of the symbol.

Definition at line 73 of file qgspoint3dsymbol.h.

◆ setShape()

void QgsPoint3DSymbol::setShape ( Shape shape )

inline

Sets 3D shape for points.

Definition at line 97 of file qgspoint3dsymbol.h.

◆ setShapeProperties()

void QgsPoint3DSymbol::setShapeProperties ( const QVariantMap & properties )

inline

Sets a key-value dictionary of point shape properties.

Definition at line 102 of file qgspoint3dsymbol.h.

◆ setTransform()

void QgsPoint3DSymbol::setTransform ( const QMatrix4x4 & transform )

inline

Sets transform for individual objects represented by the symbol.

Definition at line 112 of file qgspoint3dsymbol.h.

◆ shape()

Shape QgsPoint3DSymbol::shape ( ) const

inline

Returns 3D shape for points.

Definition at line 95 of file qgspoint3dsymbol.h.

◆ shapeFromString()

QgsPoint3DSymbol::Shape QgsPoint3DSymbol::shapeFromString ( const QString & shape )

static

Returns shape enum value from a string.

Definition at line 100 of file qgspoint3dsymbol.cpp.

◆ shapeProperties()

QVariantMap QgsPoint3DSymbol::shapeProperties ( ) const

inline

Returns a key-value dictionary of point shape properties.

Definition at line 100 of file qgspoint3dsymbol.h.

◆ shapeToString()

QString QgsPoint3DSymbol::shapeToString ( QgsPoint3DSymbol::Shape shape )

static

Returns string from a shape enum value.

Definition at line 122 of file qgspoint3dsymbol.cpp.

◆ transform()

QMatrix4x4 QgsPoint3DSymbol::transform ( ) const

inline

Returns transform for individual objects represented by the symbol.

Definition at line 110 of file qgspoint3dsymbol.h.

◆ type()

QString QgsPoint3DSymbol::type ( ) const

inlineoverridevirtual

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

Implements QgsAbstract3DSymbol.

Definition at line 59 of file qgspoint3dsymbol.h.

◆ writeXml()

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

overridevirtual

Writes symbol configuration to the given DOM element.

Implements QgsAbstract3DSymbol.

Definition at line 45 of file qgspoint3dsymbol.cpp.

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

/build/qgis-3.14.0+99unstable/src/3d/symbols/qgspoint3dsymbol.h
/build/qgis-3.14.0+99unstable/src/3d/symbols/qgspoint3dsymbol.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Shape

Constructor & Destructor Documentation

◆ QgsPoint3DSymbol() [1/2]

◆ QgsPoint3DSymbol() [2/2]

Member Function Documentation

◆ altitudeClamping()

◆ billboardSymbol()

◆ billboardTransform()

◆ clone()

◆ material()

◆ readXml()

◆ setAltitudeClamping()

◆ setBillboardSymbol()

◆ setMaterial()

◆ setShape()

◆ setShapeProperties()

◆ setTransform()

◆ shape()

◆ shapeFromString()

◆ shapeProperties()

◆ shapeToString()

◆ transform()

◆ type()

◆ writeXml()