QGIS API Documentation 3.27.0-Master (75dc696944)
qgsphongtexturedmaterialsettings.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsphongtexturedmaterialsettings.h
3 --------------------------------------
4 Date : August 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 QGSPHONGTEXTUREDMATERIALSETTINGS_H
17#define QGSPHONGTEXTUREDMATERIALSETTINGS_H
18
19#include "qgis_3d.h"
21
22#include <QColor>
23
24class QDomElement;
25
36{
37 public:
38
43
44 QString type() const override;
45
49 static bool supportsTechnique( QgsMaterialSettingsRenderingTechnique technique );
50
55
56 QgsPhongTexturedMaterialSettings *clone() const override SIP_FACTORY;
57
59 QColor ambient() const { return mAmbient; }
61 QColor specular() const { return mSpecular; }
63 float shininess() const { return mShininess; }
64
65 QMap<QString, QString> toExportParameters() const override;
66
72 QString diffuseTexturePath() const { return mDiffuseTexturePath; }
73
79 float textureScale() const { return mTextureScale; }
80
85 bool requiresTextureCoordinates() const { return !mDiffuseTexturePath.isEmpty(); }
86
90 float textureRotation() const;
91
96 float opacity() const { return mOpacity; }
97
99 void setAmbient( const QColor &ambient ) { mAmbient = ambient; }
100
102 void setSpecular( const QColor &specular ) { mSpecular = specular; }
104 void setShininess( float shininess ) { mShininess = shininess; }
105
110 void setDiffuseTexturePath( const QString &path ) { mDiffuseTexturePath = path; }
111
117 void setTextureScale( float scale ) { mTextureScale = scale; }
118
120 void setTextureRotation( float rotation ) { mTextureRotation = rotation; }
121
126 void setOpacity( float opacity ) { mOpacity = opacity; }
127
128 void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
129 void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
130#ifndef SIP_RUN
131 Qt3DRender::QMaterial *toMaterial( QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context ) const override SIP_FACTORY;
132 void addParametersToEffect( Qt3DRender::QEffect *effect ) const override;
133#endif
134
135 // TODO c++20 - replace with = default
137 {
138 return mAmbient == other.mAmbient &&
139 mSpecular == other.mSpecular &&
140 mShininess == other.mShininess &&
141 mOpacity == other.mOpacity &&
142 mDiffuseTexturePath == other.mDiffuseTexturePath &&
143 mTextureScale == other.mTextureScale &&
144 mTextureRotation == other.mTextureRotation;
145 }
146
147 private:
148 QColor mAmbient{ QColor::fromRgbF( 0.1f, 0.1f, 0.1f, 1.0f ) };
149 QColor mSpecular{ QColor::fromRgbF( 1.0f, 1.0f, 1.0f, 1.0f ) };
150 float mShininess = 0.0f;
151 float mOpacity = 1.0f;
152 QString mDiffuseTexturePath;
153 float mTextureScale{ 1.0f };
154 float mTextureRotation{ 0.0f };
155};
156
157
158#endif // QGSPHONGTEXTUREDMATERIALSETTINGS_H
virtual void writeXml(QDomElement &element, const QgsReadWriteContext &) const
Writes settings to a DOM element.
virtual QMap< QString, QString > toExportParameters() const =0
Returns the parameters to be exported to .mtl file.
virtual void readXml(const QDomElement &element, const QgsReadWriteContext &)
Reads settings from a DOM element.
virtual Qt3DRender::QMaterial * toMaterial(QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context) const =0
Creates a new QMaterial object representing the material settings.
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.
QgsPhongTexturedMaterialSettings()=default
Constructor for QgsPhongTexturedMaterialSettings.
bool requiresTextureCoordinates() const
Returns true if the material requires texture coordinates to be generated during triangulation....
void setTextureScale(float scale)
Sets the texture scale The texture scale changes the size of the displayed texture in the 3D scene If...
void setSpecular(const QColor &specular)
Sets specular color component.
float textureScale() const
Returns the texture scale The texture scale changes the size of the displayed texture in the 3D scene...
float shininess() const
Returns shininess of the surface.
void setDiffuseTexturePath(const QString &path)
Sets the path of the diffuse texture.
QString diffuseTexturePath() const
Returns the diffuse texture path.
QColor specular() const
Returns specular color component.
void setShininess(float shininess)
Sets shininess of the surface.
void setAmbient(const QColor &ambient)
Sets ambient color component.
void setOpacity(float opacity)
Sets opacity of the surface.
void setTextureRotation(float rotation)
Sets the texture rotation in degrees.
bool operator==(const QgsPhongTexturedMaterialSettings &other) const
float opacity() const
Returns the opacity of the surface.
The class is used as a container of context for various read/write operations on other objects.
QgsMaterialSettingsRenderingTechnique
Material rendering techniques 3.
#define SIP_FACTORY
Definition: qgis_sip.h:76