QGIS API Documentation 3.29.0-Master (19d7edcfed)
qgsline3dsymbol.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsline3dsymbol.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
16#include "qgsline3dsymbol.h"
17#include "qgs3dutils.h"
18#include "qgs3d.h"
19#include "qgsmaterialregistry.h"
20#include "qgs3dexportobject.h"
21#include "qgs3dsceneexporter.h"
22#include "qgsvectorlayer.h"
24
26 : mMaterialSettings( std::make_unique< QgsPhongMaterialSettings >() )
27{
28
29}
30
32
34{
35 std::unique_ptr< QgsLine3DSymbol > result = std::make_unique< QgsLine3DSymbol >();
36 result->mAltClamping = mAltClamping;
37 result->mAltBinding = mAltBinding;
38 result->mWidth = mWidth;
39 result->mHeight = mHeight;
40 result->mExtrusionHeight = mExtrusionHeight;
41 result->mRenderAsSimpleLines = mRenderAsSimpleLines;
42 result->mMaterialSettings.reset( mMaterialSettings->clone() );
43 copyBaseSettings( result.get() );
44 return result.release();
45}
46
47void QgsLine3DSymbol::writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const
48{
49 Q_UNUSED( context )
50
51 QDomDocument doc = elem.ownerDocument();
52
53 QDomElement elemDataProperties = doc.createElement( QStringLiteral( "data" ) );
54 elemDataProperties.setAttribute( QStringLiteral( "alt-clamping" ), Qgs3DUtils::altClampingToString( mAltClamping ) );
55 elemDataProperties.setAttribute( QStringLiteral( "alt-binding" ), Qgs3DUtils::altBindingToString( mAltBinding ) );
56 elemDataProperties.setAttribute( QStringLiteral( "height" ), mHeight );
57 elemDataProperties.setAttribute( QStringLiteral( "extrusion-height" ), mExtrusionHeight );
58 elemDataProperties.setAttribute( QStringLiteral( "simple-lines" ), mRenderAsSimpleLines ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
59 elemDataProperties.setAttribute( QStringLiteral( "width" ), mWidth );
60 elem.appendChild( elemDataProperties );
61
62 elem.setAttribute( QStringLiteral( "material_type" ), mMaterialSettings->type() );
63 QDomElement elemMaterial = doc.createElement( QStringLiteral( "material" ) );
64 mMaterialSettings->writeXml( elemMaterial, context );
65 elem.appendChild( elemMaterial );
66}
67
68void QgsLine3DSymbol::readXml( const QDomElement &elem, const QgsReadWriteContext &context )
69{
70 Q_UNUSED( context )
71
72 const QDomElement elemDataProperties = elem.firstChildElement( QStringLiteral( "data" ) );
73 mAltClamping = Qgs3DUtils::altClampingFromString( elemDataProperties.attribute( QStringLiteral( "alt-clamping" ) ) );
74 mAltBinding = Qgs3DUtils::altBindingFromString( elemDataProperties.attribute( QStringLiteral( "alt-binding" ) ) );
75 mHeight = elemDataProperties.attribute( QStringLiteral( "height" ) ).toFloat();
76 mExtrusionHeight = elemDataProperties.attribute( QStringLiteral( "extrusion-height" ) ).toFloat();
77 mWidth = elemDataProperties.attribute( QStringLiteral( "width" ) ).toFloat();
78 mRenderAsSimpleLines = elemDataProperties.attribute( QStringLiteral( "simple-lines" ), QStringLiteral( "0" ) ).toInt();
79
80 const QDomElement elemMaterial = elem.firstChildElement( QStringLiteral( "material" ) );
81 const QString materialType = elem.attribute( QStringLiteral( "material_type" ), QStringLiteral( "phong" ) );
82 mMaterialSettings.reset( Qgs3D::materialRegistry()->createMaterialSettings( materialType ) );
83 if ( !mMaterialSettings )
84 mMaterialSettings.reset( Qgs3D::materialRegistry()->createMaterialSettings( QStringLiteral( "phong" ) ) );
85 mMaterialSettings->readXml( elemMaterial, context );
86}
87
89{
90 return mMaterialSettings.get();
91}
92
94{
95 if ( materialSettings == mMaterialSettings.get() )
96 return;
97
98 mMaterialSettings.reset( materialSettings );
99}
100
101QList<QgsWkbTypes::GeometryType> QgsLine3DSymbol::compatibleGeometryTypes() const
102{
103 return QList< QgsWkbTypes::GeometryType >() << QgsWkbTypes::LineGeometry;
104}
105
107{
108 const QgsVectorLayerElevationProperties *props = qgis::down_cast< const QgsVectorLayerElevationProperties * >( const_cast< QgsVectorLayer *>( layer )->elevationProperties() );
109
110 mAltClamping = props->clamping();
111 mAltBinding = props->binding();
112 mExtrusionHeight = props->extrusionEnabled() ? static_cast< float>( props->extrusionHeight() ) : 0.0f;
113 mHeight = static_cast< float >( props->zOffset() );
114}
115
117{
118 return new QgsLine3DSymbol();
119}
120
121bool QgsLine3DSymbol::exportGeometries( Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix ) const
122{
123 if ( renderAsSimpleLines() )
124 {
125 const QVector<Qgs3DExportObject *> objs = exporter->processLines( entity, objectNamePrefix );
126 exporter->mObjects << objs;
127 return objs.size() != 0;
128 }
129 else
130 {
131 const QList<Qt3DRender::QGeometryRenderer *> renderers = entity->findChildren<Qt3DRender::QGeometryRenderer *>();
132 for ( Qt3DRender::QGeometryRenderer *r : renderers )
133 {
134 Qgs3DExportObject *object = exporter->processGeometryRenderer( r, objectNamePrefix );
135 if ( object == nullptr ) continue;
136 object->setupMaterial( materialSettings() );
137 exporter->mObjects.push_back( object );
138 }
139 return renderers.size() != 0;
140 }
141}
Manages the data of each object of the scene (positions, normals, texture coordinates ....
void setupMaterial(QgsAbstractMaterialSettings *material)
Sets the material parameters (diffuse color, shininess...) from phong material.
Entity that handles the exporting of 3D scene.
static Qgis::AltitudeClamping altClampingFromString(const QString &str)
Converts a string to a value from AltitudeClamping enum.
Definition: qgs3dutils.cpp:266
static Qgis::AltitudeBinding altBindingFromString(const QString &str)
Converts a string to a value from AltitudeBinding enum.
Definition: qgs3dutils.cpp:290
static QString altClampingToString(Qgis::AltitudeClamping altClamp)
Converts a value from AltitudeClamping enum to a string.
Definition: qgs3dutils.cpp:251
static QString altBindingToString(Qgis::AltitudeBinding altBind)
Converts a value from AltitudeBinding enum to a string.
Definition: qgs3dutils.cpp:277
static QgsMaterialRegistry * materialRegistry()
Returns the material registry, used for managing 3D materials.
Definition: qgs3d.cpp:90
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
bool renderAsSimpleLines() const
Returns whether the renderer will render data with simple lines (otherwise it uses buffer)
QgsLine3DSymbol()
Constructor for QgsLine3DSymbol.
void setDefaultPropertiesFromLayer(const QgsVectorLayer *layer) override
QgsAbstract3DSymbol * clone() const override SIP_FACTORY
void writeXml(QDomElement &elem, const QgsReadWriteContext &context) const override
void readXml(const QDomElement &elem, const QgsReadWriteContext &context) override
~QgsLine3DSymbol() override
bool exportGeometries(Qgs3DSceneExporter *exporter, Qt3DCore::QEntity *entity, const QString &objectNamePrefix) const override SIP_SKIP
Exports the geometries contained within the hierarchy of entity.
void setMaterialSettings(QgsAbstractMaterialSettings *materialSettings SIP_TRANSFER)
Sets the material settings used for shading of the symbol.
static QgsAbstract3DSymbol * create() SIP_FACTORY
Creates a new QgsLine3DSymbol.
QgsAbstractMaterialSettings * materialSettings() const
Returns material settings used for shading of the symbol.
double zOffset() const
Returns the z offset, which is a fixed offset amount which should be added to z values from the layer...
The class is used as a container of context for various read/write operations on other objects.
Vector layer specific subclass of QgsMapLayerElevationProperties.
double extrusionHeight() const
Returns the feature extrusion height.
Qgis::AltitudeClamping clamping() const
Returns the altitude clamping method, which dictates how feature heights are interpreted with respect...
Qgis::AltitudeBinding binding() const
Returns the altitude binding method, which determines how altitude is bound to individual vertices in...
bool extrusionEnabled() const
Returns true if extrusion is enabled.
Represents a vector layer which manages a vector based data sets.