QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsline3dsymbol.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsline3dsymbol.h
3 --------------------------------------
4 Date : July 2017
5 Copyright : (C) 2017 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSLINE3DSYMBOL_H
17#define QGSLINE3DSYMBOL_H
18
19#include "qgis_3d.h"
20
21#include "qgsabstract3dsymbol.h"
22#include "qgs3dtypes.h"
23
25
35{
36 public:
39 ~QgsLine3DSymbol() override;
40
46 static QgsAbstract3DSymbol *create() SIP_FACTORY;
47
48 QString type() const override { return "line"; }
49 QgsAbstract3DSymbol *clone() const override SIP_FACTORY;
50
51 void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
52 void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
53 QList< Qgis::GeometryType > compatibleGeometryTypes() const override;
54 void setDefaultPropertiesFromLayer( const QgsVectorLayer *layer ) override;
55
57 Qgis::AltitudeClamping altitudeClamping() const { return mAltClamping; }
59 void setAltitudeClamping( Qgis::AltitudeClamping altClamping ) { mAltClamping = altClamping; }
60
62 Qgis::AltitudeBinding altitudeBinding() const { return mAltBinding; }
64 void setAltitudeBinding( Qgis::AltitudeBinding altBinding ) { mAltBinding = altBinding; }
65
67 float width() const { return mWidth; }
69 void setWidth( float width ) { mWidth = width; }
70
76 Q_DECL_DEPRECATED float height() const SIP_DEPRECATED { return mOffset; }
77
83 Q_DECL_DEPRECATED void setHeight( float height ) SIP_DEPRECATED { mOffset = height; }
84
90 float offset() const { return mOffset; }
91
97 void setOffset( float offset ) { mOffset = offset; }
98
100 float extrusionHeight() const { return mExtrusionHeight; }
102 void setExtrusionHeight( float extrusionHeight ) { mExtrusionHeight = extrusionHeight; }
103
105 bool renderAsSimpleLines() const { return mRenderAsSimpleLines; }
107 void setRenderAsSimpleLines( bool enabled ) { mRenderAsSimpleLines = enabled; }
108
110 QgsAbstractMaterialSettings *materialSettings() const;
111
117 void setMaterialSettings( QgsAbstractMaterialSettings *materialSettings SIP_TRANSFER );
118
123 bool exportGeometries( Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix ) const override SIP_SKIP;
124
125 private:
130
131 float mWidth = 2.0f;
132 float mOffset = 0.0f;
133 float mExtrusionHeight = 0.0f;
134 bool mRenderAsSimpleLines = false;
135 std::unique_ptr< QgsAbstractMaterialSettings > mMaterialSettings;
136};
137
138
139#endif // QGSLINE3DSYMBOL_H
The Qgis class provides global constants for use throughout the application.
Definition: qgis.h:54
AltitudeClamping
Altitude clamping.
Definition: qgis.h:3238
@ Relative
Elevation is relative to terrain height (final elevation = terrain elevation + feature elevation)
AltitudeBinding
Altitude binding.
Definition: qgis.h:3251
@ Centroid
Clamp just centroid of feature.
Entity that handles the exporting of 3D scene.
virtual bool exportGeometries(Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix) const
Exports the geometries contained within the hierarchy of entity.
virtual QgsAbstract3DSymbol * clone() const =0
Returns a new instance of the symbol with the same settings.
bool renderAsSimpleLines() const
Returns whether the renderer will render data with simple lines (otherwise it uses buffer)
void setAltitudeBinding(Qgis::AltitudeBinding altBinding)
Sets method that determines how altitude is bound to individual vertices.
void setOffset(float offset)
Sets vertical offset of the symbol (in map units)
Q_DECL_DEPRECATED float height() const SIP_DEPRECATED
Returns height (altitude) of the symbol (in map units)
float width() const
Returns width of the line symbol (in map units)
void setWidth(float width)
Sets width of the line symbol (in map units)
Qgis::AltitudeBinding altitudeBinding() const
Returns method that determines how altitude is bound to individual vertices.
void setExtrusionHeight(float extrusionHeight)
Sets extrusion height (in map units)
Q_DECL_DEPRECATED void setHeight(float height) SIP_DEPRECATED
Sets height (altitude) of the symbol (in map units)
~QgsLine3DSymbol() override
void setRenderAsSimpleLines(bool enabled)
Sets whether the renderer will render data with simple lines (otherwise it uses buffer)
float extrusionHeight() const
Returns extrusion height (in map units)
float offset() const
Returns vertical offset of the symbol (in map units)
void setAltitudeClamping(Qgis::AltitudeClamping altClamping)
Sets method that determines altitude (whether to clamp to feature to terrain)
The class is used as a container of context for various read/write operations on other objects.
Represents a vector layer which manages a vector based data sets.
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_NODEFAULTCTORS
Definition: qgis_sip.h:101