QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgspolygon3dsymbol_p.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgspolygon3dsymbol_p.cpp
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
17
18#include "qgspolygon3dsymbol.h"
20#include "qgs3dmapsettings.h"
21#include "qgs3dutils.h"
22#include "qgstessellator.h"
24
25#include <Qt3DCore/QTransform>
26#include <Qt3DRender/QMaterial>
27#include <Qt3DExtras/QPhongMaterial>
28
29#include <Qt3DExtras/QDiffuseMapMaterial>
30#include <Qt3DRender/QAbstractTextureImage>
31#include <Qt3DRender/QTexture>
32
33#include <Qt3DRender/QEffect>
34#include <Qt3DRender/QTechnique>
35#include <Qt3DRender/QCullFace>
36#include <Qt3DRender/QGeometryRenderer>
37
38#include "qgsvectorlayer.h"
39#include "qgslinestring.h"
40#include "qgsmultipolygon.h"
41#include "qgspolygon.h"
42#include "qgsmessagelog.h"
43
44#include "qgslinevertexdata_p.h"
45#include "qgslinematerial_p.h"
46
48
49
50class QgsPolygon3DSymbolHandler : public QgsFeature3DHandler
51{
52 public:
53 QgsPolygon3DSymbolHandler( const QgsPolygon3DSymbol *symbol, const QgsFeatureIds &selectedIds )
54 : mSymbol( static_cast< QgsPolygon3DSymbol *>( symbol->clone() ) )
55 , mSelectedIds( selectedIds ) {}
56
57 bool prepare( const Qgs3DRenderContext &context, QSet<QString> &attributeNames ) override;
58 void processFeature( const QgsFeature &f, const Qgs3DRenderContext &context ) override;
59 void finalize( Qt3DCore::QEntity *parent, const Qgs3DRenderContext &context ) override;
60
61 private:
62
64 struct PolygonData
65 {
66 std::unique_ptr<QgsTessellator> tessellator;
67 QVector<QgsFeatureId> triangleIndexFids;
68 QVector<uint> triangleIndexStartingIndices;
69 QByteArray materialDataDefined;
70 };
71
72 void processPolygon( const QgsPolygon *poly, QgsFeatureId fid, float offset, float extrusionHeight, const Qgs3DRenderContext &context, PolygonData &out );
73 void processMaterialDatadefined( uint verticesCount, const QgsExpressionContext &context, PolygonData &out );
74 void makeEntity( Qt3DCore::QEntity *parent, const Qgs3DRenderContext &context, PolygonData &out, bool selected );
75 Qt3DRender::QMaterial *material( const QgsPolygon3DSymbol *symbol, bool isSelected, const Qgs3DRenderContext &context ) const;
76
77 // input specific for this class
78 std::unique_ptr< QgsPolygon3DSymbol > mSymbol;
79 // inputs - generic
80 QgsFeatureIds mSelectedIds;
81
82 // outputs
83 PolygonData outNormal;
84 PolygonData outSelected;
85
86 QgsLineVertexData outEdges;
87};
88
89
90bool QgsPolygon3DSymbolHandler::prepare( const Qgs3DRenderContext &context, QSet<QString> &attributeNames )
91{
92 outEdges.withAdjacency = true;
93 outEdges.init( mSymbol->altitudeClamping(), mSymbol->altitudeBinding(), 0, &context.map() );
94
95 const QgsPhongTexturedMaterialSettings *texturedMaterialSettings = dynamic_cast< const QgsPhongTexturedMaterialSettings * >( mSymbol->materialSettings() );
96
97 outNormal.tessellator.reset( new QgsTessellator( context.map().origin().x(), context.map().origin().y(), true, mSymbol->invertNormals(), mSymbol->addBackFaces(), false,
98 texturedMaterialSettings && texturedMaterialSettings->requiresTextureCoordinates(),
99 mSymbol->renderedFacade(),
100 texturedMaterialSettings ? texturedMaterialSettings->textureRotation() : 0 ) );
101 outSelected.tessellator.reset( new QgsTessellator( context.map().origin().x(), context.map().origin().y(), true, mSymbol->invertNormals(),
102 mSymbol->addBackFaces(), false,
103 texturedMaterialSettings && texturedMaterialSettings->requiresTextureCoordinates(),
104 mSymbol->renderedFacade(),
105 texturedMaterialSettings ? texturedMaterialSettings->textureRotation() : 0 ) );
106
107 QSet<QString> attrs = mSymbol->dataDefinedProperties().referencedFields( context.expressionContext() );
108 attributeNames.unite( attrs );
109 attrs = mSymbol->materialSettings()->dataDefinedProperties().referencedFields( context.expressionContext() );
110 attributeNames.unite( attrs );
111 return true;
112}
113
114void QgsPolygon3DSymbolHandler::processPolygon( const QgsPolygon *poly, QgsFeatureId fid, float offset, float extrusionHeight, const Qgs3DRenderContext &context, PolygonData &out )
115{
116 std::unique_ptr< QgsPolygon > polyClone( poly->clone() );
117
118 const uint oldVerticesCount = out.tessellator->dataVerticesCount();
119 if ( mSymbol->edgesEnabled() )
120 {
121 // add edges before the polygon gets the Z values modified because addLineString() does its own altitude handling
122 outEdges.addLineString( *static_cast<const QgsLineString *>( polyClone->exteriorRing() ), offset );
123 for ( int i = 0; i < polyClone->numInteriorRings(); ++i )
124 outEdges.addLineString( *static_cast<const QgsLineString *>( polyClone->interiorRing( i ) ), offset );
125
126 if ( extrusionHeight )
127 {
128 // add roof and wall edges
129 const QgsLineString *exterior = static_cast<const QgsLineString *>( polyClone->exteriorRing() );
130 outEdges.addLineString( *exterior, extrusionHeight + offset );
131 outEdges.addVerticalLines( *exterior, extrusionHeight, offset );
132 for ( int i = 0; i < polyClone->numInteriorRings(); ++i )
133 {
134 const QgsLineString *interior = static_cast<const QgsLineString *>( polyClone->interiorRing( i ) );
135 outEdges.addLineString( *interior, extrusionHeight + offset );
136 outEdges.addVerticalLines( *interior, extrusionHeight, offset );
137 }
138 }
139 }
140
141 Qgs3DUtils::clampAltitudes( polyClone.get(), mSymbol->altitudeClamping(), mSymbol->altitudeBinding(), offset, context.map() );
142
143 Q_ASSERT( out.tessellator->dataVerticesCount() % 3 == 0 );
144 const uint startingTriangleIndex = static_cast<uint>( out.tessellator->dataVerticesCount() / 3 );
145 out.triangleIndexStartingIndices.append( startingTriangleIndex );
146 out.triangleIndexFids.append( fid );
147 out.tessellator->addPolygon( *polyClone, extrusionHeight );
148 if ( !out.tessellator->error().isEmpty() )
149 {
150 QgsMessageLog::logMessage( out.tessellator->error(), QObject::tr( "3D" ) );
151 }
152
153 if ( mSymbol->materialSettings()->dataDefinedProperties().hasActiveProperties() )
154 processMaterialDatadefined( out.tessellator->dataVerticesCount() - oldVerticesCount, context.expressionContext(), out );
155}
156
157void QgsPolygon3DSymbolHandler::processMaterialDatadefined( uint verticesCount, const QgsExpressionContext &context, QgsPolygon3DSymbolHandler::PolygonData &out )
158{
159 const QByteArray bytes = mSymbol->materialSettings()->dataDefinedVertexColorsAsByte( context );
160 out.materialDataDefined.append( bytes.repeated( verticesCount ) );
161}
162
163void QgsPolygon3DSymbolHandler::processFeature( const QgsFeature &f, const Qgs3DRenderContext &context )
164{
165 if ( f.geometry().isNull() )
166 return;
167
168 PolygonData &out = mSelectedIds.contains( f.id() ) ? outSelected : outNormal;
169
170 QgsGeometry geom = f.geometry();
172
173 // segmentize curved geometries if necessary
175 {
176 geom = QgsGeometry( g->segmentize() );
177 g = geom.constGet()->simplifiedTypeRef();
178 }
179
180 const QgsPropertyCollection &ddp = mSymbol->dataDefinedProperties();
181 const bool hasDDHeight = ddp.isActive( QgsAbstract3DSymbol::Property::Height );
182 const bool hasDDExtrusion = ddp.isActive( QgsAbstract3DSymbol::Property::ExtrusionHeight );
183
184 float offset = mSymbol->offset();
185 float extrusionHeight = mSymbol->extrusionHeight();
186 if ( hasDDHeight )
187 offset = static_cast<float>( ddp.valueAsDouble( QgsAbstract3DSymbol::Property::Height, context.expressionContext(), offset ) );
188 if ( hasDDExtrusion )
189 extrusionHeight = ddp.valueAsDouble( QgsAbstract3DSymbol::Property::ExtrusionHeight, context.expressionContext(), extrusionHeight );
190
191 if ( const QgsPolygon *poly = qgsgeometry_cast< const QgsPolygon *>( g ) )
192 {
193 processPolygon( poly, f.id(), offset, extrusionHeight, context, out );
194 }
195 else if ( const QgsMultiPolygon *mpoly = qgsgeometry_cast< const QgsMultiPolygon *>( g ) )
196 {
197 for ( int i = 0; i < mpoly->numGeometries(); ++i )
198 {
199 const QgsPolygon *poly = mpoly->polygonN( i );
200 processPolygon( poly, f.id(), offset, extrusionHeight, context, out );
201 }
202 }
203 else if ( const QgsGeometryCollection *gc = qgsgeometry_cast< const QgsGeometryCollection *>( g ) )
204 {
205 for ( int i = 0; i < gc->numGeometries(); ++i )
206 {
207 const QgsAbstractGeometry *g2 = gc->geometryN( i );
209 {
210 const QgsPolygon *poly = static_cast< const QgsPolygon *>( g2 );
211 processPolygon( poly, f.id(), offset, extrusionHeight, context, out );
212 }
213 }
214 }
215 else
216 qWarning() << "not a polygon";
217
218 mFeatureCount++;
219}
220
221void QgsPolygon3DSymbolHandler::finalize( Qt3DCore::QEntity *parent, const Qgs3DRenderContext &context )
222{
223 // create entity for selected and not selected
224 makeEntity( parent, context, outNormal, false );
225 makeEntity( parent, context, outSelected, true );
226
227 mZMin = std::min( outNormal.tessellator->zMinimum(), outSelected.tessellator->zMinimum() );
228 mZMax = std::max( outNormal.tessellator->zMaximum(), outSelected.tessellator->zMaximum() );
229
230 // add entity for edges
231 if ( mSymbol->edgesEnabled() && !outEdges.indexes.isEmpty() )
232 {
233 QgsLineMaterial *mat = new QgsLineMaterial;
234 mat->setLineColor( mSymbol->edgeColor() );
235 mat->setLineWidth( mSymbol->edgeWidth() );
236
237 Qt3DCore::QEntity *entity = new Qt3DCore::QEntity;
238 entity->setObjectName( parent->objectName() + "_EDGES" );
239
240 // geometry renderer
241 Qt3DRender::QGeometryRenderer *renderer = new Qt3DRender::QGeometryRenderer;
242 renderer->setPrimitiveType( Qt3DRender::QGeometryRenderer::LineStripAdjacency );
243 renderer->setGeometry( outEdges.createGeometry( entity ) );
244 renderer->setVertexCount( outEdges.indexes.count() );
245 renderer->setPrimitiveRestartEnabled( true );
246 renderer->setRestartIndexValue( 0 );
247
248 // make entity
249 entity->addComponent( renderer );
250 entity->addComponent( mat );
251 entity->setParent( parent );
252 }
253}
254
255
256void QgsPolygon3DSymbolHandler::makeEntity( Qt3DCore::QEntity *parent, const Qgs3DRenderContext &context, PolygonData &polyData, bool selected )
257{
258 if ( polyData.tessellator->dataVerticesCount() == 0 )
259 return; // nothing to show - no need to create the entity
260
261 Qt3DRender::QMaterial *mat = material( mSymbol.get(), selected, context );
262
263 // extract vertex buffer data from tessellator
264 const QByteArray data( reinterpret_cast<const char *>( polyData.tessellator->data().constData() ), static_cast<int>( polyData.tessellator->data().count() * sizeof( float ) ) );
265 const int nVerts = data.count() / polyData.tessellator->stride();
266
267 const QgsPhongTexturedMaterialSettings *texturedMaterialSettings = dynamic_cast< const QgsPhongTexturedMaterialSettings * >( mSymbol->materialSettings() );
268
269 QgsTessellatedPolygonGeometry *geometry = new QgsTessellatedPolygonGeometry( true, mSymbol->invertNormals(), mSymbol->addBackFaces(),
270 texturedMaterialSettings && texturedMaterialSettings->requiresTextureCoordinates() );
271
272 geometry->setData( data, nVerts, polyData.triangleIndexFids, polyData.triangleIndexStartingIndices );
273
274 if ( mSymbol->materialSettings()->dataDefinedProperties().hasActiveProperties() )
275 mSymbol->materialSettings()->applyDataDefinedToGeometry( geometry, nVerts, polyData.materialDataDefined );
276
277 Qt3DRender::QGeometryRenderer *renderer = new Qt3DRender::QGeometryRenderer;
278 renderer->setGeometry( geometry );
279
280 // make entity
281 Qt3DCore::QEntity *entity = new Qt3DCore::QEntity;
282 entity->setObjectName( parent->objectName() + "_CHUNK_MESH" );
283 entity->addComponent( renderer );
284 entity->addComponent( mat );
285 entity->setParent( parent );
286
287 if ( !selected )
288 renderer->setProperty( Qgs3DTypes::PROP_NAME_3D_RENDERER_FLAG, Qgs3DTypes::Main3DRenderer ); // temporary measure to distinguish between "selected" and "main"
289
290// cppcheck wrongly believes entity will leak
291// cppcheck-suppress memleak
292}
293
294// front/back side culling
295static void applyCullingMode( Qgs3DTypes::CullingMode cullingMode, Qt3DRender::QMaterial *material )
296{
297 const auto techniques = material->effect()->techniques();
298 for ( auto tit = techniques.constBegin(); tit != techniques.constEnd(); ++tit )
299 {
300 auto renderPasses = ( *tit )->renderPasses();
301 for ( auto rpit = renderPasses.begin(); rpit != renderPasses.end(); ++rpit )
302 {
303 Qt3DRender::QCullFace *cullFace = new Qt3DRender::QCullFace;
304 cullFace->setMode( Qgs3DUtils::qt3DcullingMode( cullingMode ) );
305 ( *rpit )->addRenderState( cullFace );
306 }
307 }
308}
309
310Qt3DRender::QMaterial *QgsPolygon3DSymbolHandler::material( const QgsPolygon3DSymbol *symbol, bool isSelected, const Qgs3DRenderContext &context ) const
311{
312 QgsMaterialContext materialContext;
313 materialContext.setIsSelected( isSelected );
314 materialContext.setSelectionColor( context.map().selectionColor() );
315
316 const bool dataDefined = mSymbol->materialSettings()->dataDefinedProperties().hasActiveProperties();
317 Qt3DRender::QMaterial *material = symbol->materialSettings()->toMaterial( dataDefined ?
319 materialContext );
320 applyCullingMode( symbol->cullingMode(), material );
321 return material;
322}
323
324
325// --------------
326
327
328namespace Qgs3DSymbolImpl
329{
330
331
332 QgsFeature3DHandler *handlerForPolygon3DSymbol( QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol )
333 {
334 const QgsPolygon3DSymbol *polygonSymbol = dynamic_cast< const QgsPolygon3DSymbol * >( symbol );
335 if ( !polygonSymbol )
336 return nullptr;
337
338 return new QgsPolygon3DSymbolHandler( polygonSymbol, layer->selectedFeatureIds() );
339 }
340
341 Qt3DCore::QEntity *entityForPolygon3DSymbol( const Qgs3DMapSettings &map, QgsVectorLayer *layer, const QgsPolygon3DSymbol &symbol )
342 {
343 QgsFeature3DHandler *handler = handlerForPolygon3DSymbol( layer, &symbol );
344 Qt3DCore::QEntity *e = entityFromHandler( handler, map, layer );
345 delete handler;
346 return e;
347 }
348
349}
350
@ Polygon
Polygon.
@ Main3DRenderer
Renderer for normal entities.
Definition: qgs3dtypes.h:49
static const char * PROP_NAME_3D_RENDERER_FLAG
Qt property name to hold the 3D geometry renderer flag.
Definition: qgs3dtypes.h:44
CullingMode
Triangle culling mode.
Definition: qgs3dtypes.h:36
static Qt3DRender::QCullFace::CullingMode qt3DcullingMode(Qgs3DTypes::CullingMode mode)
Converts Qgs3DTypes::CullingMode mode into its Qt3D equivalent.
Definition: qgs3dutils.cpp:894
static void clampAltitudes(QgsLineString *lineString, Qgis::AltitudeClamping altClamp, Qgis::AltitudeBinding altBind, const QgsPoint &centroid, float offset, const Qgs3DMapSettings &map)
Clamps altitude of vertices of a linestring according to the settings.
Definition: qgs3dutils.cpp:390
@ ExtrusionHeight
Extrusion height (zero means no extrusion)
@ Height
Height (altitude)
Abstract base class for all geometries.
virtual const QgsAbstractGeometry * simplifiedTypeRef() const
Returns a reference to the simplest lossless representation of this geometry, e.g.
virtual QgsAbstractGeometry * segmentize(double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const
Returns a version of the geometry without curves.
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
virtual Qt3DRender::QMaterial * toMaterial(QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const =0
Creates a new QMaterial object representing the material settings.
QgsPropertyCollection dataDefinedProperties() const
Returns the symbol material property collection, used for data defined overrides.
double valueAsDouble(int key, const QgsExpressionContext &context, double defaultValue=0.0, bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as a double.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
QgsGeometry geometry
Definition: qgsfeature.h:67
Q_GADGET QgsFeatureId id
Definition: qgsfeature.h:64
Geometry collection.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:162
Q_GADGET bool isNull
Definition: qgsgeometry.h:164
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:45
void setIsSelected(bool isSelected)
Sets whether the material should represent a selected state.
void setSelectionColor(const QColor &color)
Sets the color for representing materials in a selected state.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Multi polygon geometry collection.
bool requiresTextureCoordinates() const
Returns true if the material requires texture coordinates to be generated during triangulation....
float textureRotation() const
Returns the texture rotation, in degrees.
QgsAbstractMaterialSettings * materialSettings() const
Returns material settings used for shading of the symbol.
Qgs3DTypes::CullingMode cullingMode() const
Returns front/back culling mode.
Polygon geometry type.
Definition: qgspolygon.h:33
QgsPolygon * clone() const override
Clones the geometry by performing a deep copy.
Definition: qgspolygon.cpp:54
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
bool isActive(int key) const final
Returns true if the collection contains an active property with the specified key.
QSet< QString > referencedFields(const QgsExpressionContext &context=QgsExpressionContext(), bool ignoreContext=false) const final
Returns the set of any fields referenced by the active properties from the collection.
void setData(const QByteArray &vertexBufferData, int vertexCount, const QVector< QgsFeatureId > &triangleIndexFids, const QVector< uint > &triangleIndexStartingIndices)
Initializes vertex buffer (and other members) from data that were already tessellated.
Class that takes care of tessellation of polygons into triangles.
Represents a vector layer which manages a vector based data sets.
Q_INVOKABLE const QgsFeatureIds & selectedFeatureIds() const
Returns a list of the selected features IDs in this layer.
static bool isCurvedType(Qgis::WkbType type)
Returns true if the WKB type is a curved type or can contain curved geometries.
Definition: qgswkbtypes.h:806
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:628
@ Triangles
Triangle based rendering (default)
@ TrianglesDataDefined
Triangle based rendering with possibility of datadefined color.
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28