QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgssimplelinematerialsettings.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssimplelinematerialsettings.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
17#ifndef QGSSIMPLELINEMATERIALSETTINGS_H
18#define QGSSIMPLELINEMATERIALSETTINGS_H
19
20#include "qgis_3d.h"
22
23#include <QColor>
24
25class QDomElement;
26
37{
38 public:
39
44
45 QString type() const override;
46
50 static bool supportsTechnique( QgsMaterialSettingsRenderingTechnique technique );
51
56
57 QgsSimpleLineMaterialSettings *clone() const override SIP_FACTORY;
58
64 QColor ambient() const { return mAmbient; }
65
71 void setAmbient( const QColor &ambient ) { mAmbient = ambient; }
72
73 QMap<QString, QString> toExportParameters() const override;
74 void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
75 void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
76#ifndef SIP_RUN
77 Qt3DRender::QMaterial *toMaterial( QgsMaterialSettingsRenderingTechnique technique, const QgsMaterialContext &context ) const override SIP_FACTORY;
78 void addParametersToEffect( Qt3DRender::QEffect *effect ) const override;
79 QByteArray dataDefinedVertexColorsAsByte( const QgsExpressionContext &expressionContext ) const override;
80#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
81 void applyDataDefinedToGeometry( Qt3DRender::QGeometry *geometry, int vertexCount, const QByteArray &data ) const override;
82#else
83 void applyDataDefinedToGeometry( Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &data ) const override;
84#endif
85#endif
86
87 // TODO c++20 - replace with = default
88 bool operator==( const QgsSimpleLineMaterialSettings &other ) const
89 {
90 return mAmbient == other.mAmbient;
91 }
92
93 private:
94 QColor mAmbient{ QColor::fromRgbF( 0.1f, 0.1f, 0.1f, 1.0f ) };
95
96};
97
98
99#endif // QGSSIMPLELINEMATERIALSETTINGS_H
virtual void writeXml(QDomElement &element, const QgsReadWriteContext &) const
Writes settings to a DOM element.
virtual QByteArray dataDefinedVertexColorsAsByte(const QgsExpressionContext &expressionContext) const
Returns byte array corresponding to the data defined colors depending of the expressionContext,...
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.
virtual void applyDataDefinedToGeometry(Qt3DCore::QGeometry *geometry, int vertexCount, const QByteArray &dataDefinedBytes) const
Applies the data defined bytes, dataDefinedBytes, on the geometry by filling a specific vertex buffer...
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The class is used as a container of context for various read/write operations on other objects.
bool operator==(const QgsSimpleLineMaterialSettings &other) const
void setAmbient(const QColor &ambient)
Sets the ambient color component.
QgsSimpleLineMaterialSettings()=default
Constructor for QgsSimpleLineMaterialSettings.
QgsMaterialSettingsRenderingTechnique
Material rendering techniques 3.
#define SIP_FACTORY
Definition: qgis_sip.h:76