QGIS API Documentation 3.29.0-Master (8c80f25a4f)
qgsabstractmaterialsettings.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsabstractmaterialsettings.h
3 --------------------------------------
4 Date : July 2020
5 Copyright : (C) 2020 by Nyall Dawson
6 Email : nyall dot dawson 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 QGSABSTRACTMATERIALSETTINGS_H
17#define QGSABSTRACTMATERIALSETTINGS_H
18
19#include "qgis_3d.h"
20#include "qgis_sip.h"
21
22#include <QColor>
23#include <Qt3DRender/qmaterial.h>
25
26class QDomElement;
28class QgsLineMaterial;
30
31#ifndef SIP_RUN
32#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
33namespace Qt3DRender
34{
35 class QGeometry;
36}
37#else
38namespace Qt3DCore
39{
40 class QGeometry;
41}
42#endif
43#endif //SIP_RUN
44
51 {
52 Triangles,
53 Lines,
55 Points,
59};
60
61
71class _3D_EXPORT QgsMaterialContext
72{
73 public:
74
80 bool isSelected() const { return mIsSelected; }
81
87 void setIsSelected( bool isSelected ) { mIsSelected = isSelected; }
88
94 QColor selectionColor() const { return mSelectedColor; }
95
101 void setSelectionColor( const QColor &color ) { mSelectedColor = color; }
102
103 private:
104
105 bool mIsSelected = false;
106
107 QColor mSelectedColor;
108
109};
110
111
122{
123
124#ifdef SIP_RUN
126 if ( sipCpp->type() == QLatin1String( "gooch" ) )
127 {
128 sipType = sipType_QgsGoochMaterialSettings;
129 }
130 else if ( sipCpp->type() == QLatin1String( "phong" ) )
131 {
132 sipType = sipType_QgsPhongMaterialSettings;
133 }
134 else if ( sipCpp->type() == "phongtextured" )
135 {
136 sipType = sipType_QgsPhongTexturedMaterialSettings;
137 }
138 else if ( sipCpp->type() == "simpleline" )
139 {
140 sipType = sipType_QgsSimpleLineMaterialSettings;
141 }
142 else if ( sipCpp->type() == "null" )
143 {
144 sipType = sipType_QgsNullMaterialSettings;
145 }
146 else
147 {
148 sipType = 0;
149 }
150 SIP_END
151#endif
152
153 public:
154
155 virtual ~QgsAbstractMaterialSettings() = default;
156
160 virtual QString type() const = 0;
161
168
170 virtual void readXml( const QDomElement &element, const QgsReadWriteContext & );
171
173 virtual void writeXml( QDomElement &element, const QgsReadWriteContext & ) const;
174
175#ifndef SIP_RUN
176
183 virtual Qt3DRender::QMaterial *toMaterial( QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context ) const = 0 SIP_FACTORY;
184
188 virtual QMap<QString, QString> toExportParameters() const = 0;
189
193 virtual void addParametersToEffect( Qt3DRender::QEffect *effect ) const = 0;
194
197 {
202 Specular
203 };
204
209 void setDataDefinedProperties( const QgsPropertyCollection &collection );
210
215 QgsPropertyCollection dataDefinedProperties() const;
216
221 const QgsPropertiesDefinition &propertyDefinitions() const;
222
227#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
228 virtual void applyDataDefinedToGeometry( Qt3DRender::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes ) const;
229#else
230 virtual void applyDataDefinedToGeometry( Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes ) const;
231#endif
232
239 virtual QByteArray dataDefinedVertexColorsAsByte( const QgsExpressionContext &expressionContext ) const;
240
245 virtual int dataDefinedByteStride() const {return 0;}
246#endif
247
248 private:
249 QgsPropertyCollection mDataDefinedProperties;
250 static QgsPropertiesDefinition sPropertyDefinitions;
251 void initPropertyDefinitions() const;
252};
253
254
255#endif // QGSABSTRACTMATERIALSETTINGS_H
virtual QMap< QString, QString > toExportParameters() const =0
Returns the parameters to be exported to .mtl file.
virtual QgsAbstractMaterialSettings * clone() const =0
Clones the material settings.
virtual int dataDefinedByteStride() const
Returns byte stride of the data defined colors,used to fill the vertex colors data defined buffer for...
virtual Qt3DRender::QMaterial * toMaterial(QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const =0
Creates a new QMaterial object representing the material settings.
virtual ~QgsAbstractMaterialSettings()=default
virtual QString type() const =0
Returns the unique type name for the material.
virtual void addParametersToEffect(Qt3DRender::QEffect *effect) const =0
Adds parameters from the material to a destination effect.
@ Ambient
Ambient color (phong material)
@ Warm
Warm color (gooch material)
@ Cool
Cool color (gooch material)
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QColor selectionColor() const
Returns the color for representing materials in a selected state.
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.
bool isSelected() const
Returns true if the material should represent a selected state.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
The class is used as a container of context for various read/write operations on other objects.
QgsMaterialSettingsRenderingTechnique
Material rendering techniques 3.
@ Points
Point based rendering, requires point data.
@ Triangles
Triangle based rendering (default)
@ TrianglesFromModel
Triangle based rendering, using a model object source.
@ Lines
Line based rendering, requires line data.
@ TrianglesDataDefined
Triangle based rendering with possibility of datadefined color.
@ InstancedPoints
Instanced based rendering, requiring triangles and point data.
@ TrianglesWithFixedTexture
Triangle based rendering, using a fixed, non-user-configurable texture (e.g. for terrain rendering)
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:186
#define SIP_MONKEYPATCH_SCOPEENUM_UNNEST(OUTSIDE_CLASS, FORMERNAME)
Definition: qgis_sip.h:266
#define SIP_ABSTRACT
Definition: qgis_sip.h:208
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_END
Definition: qgis_sip.h:203
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.