QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
3d
materials
qgsunlitmaterialsettings.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsunlitmaterialsettings.h
3
--------------------------------------
4
Date : June 2026
5
Copyright : (C) 2026 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 QGSUNLITMATERIALSETTINGS_H
17
#define QGSUNLITMATERIALSETTINGS_H
18
19
#include "qgis_core.h"
20
#include "
qgsabstractmaterialsettings.h
"
21
22
#include <QColor>
23
24
class
QgsMaterial
;
25
class
QDomElement;
26
38
class
CORE_EXPORT
QgsUnlitMaterialSettings
:
public
QgsAbstractMaterialSettings
39
{
40
public
:
41
QgsUnlitMaterialSettings
() =
default
;
42
43
QString
type
()
const override
;
44
48
static
bool
supportsTechnique
(
Qgis::MaterialRenderingTechnique
technique );
49
53
static
std::unique_ptr<QgsAbstractMaterialSettings>
create
();
54
55
QgsUnlitMaterialSettings
*
clone
() const override
SIP_FACTORY
;
56
bool
equals
( const
QgsAbstractMaterialSettings
*other ) const override;
57
QSet<
QgsAbstractMaterialSettings
::
Property
>
supportedProperties
() const override;
58
64
QColor
color
()
const
{
return
mColor; }
65
71
void
setColor
(
const
QColor &
color
) { mColor =
color
; }
72
73
QColor
averageColor
()
const override
;
74
void
setColorsFromBase
(
const
QColor &baseColor )
override
;
75
76
void
readXml
(
const
QDomElement &elem,
const
QgsReadWriteContext
&context )
override
;
77
void
writeXml
( QDomElement &elem,
const
QgsReadWriteContext
&context )
const override
;
78
79
// TODO c++20 - replace with = default
80
bool
operator==
(
const
QgsUnlitMaterialSettings
&other )
const
{
return
mColor == other.mColor &&
dataDefinedProperties
() == other.
dataDefinedProperties
(); }
81
82
private
:
83
QColor mColor { QColor::fromRgbF( 0.8f, 0.4f, 0.4f, 1.0f ) };
84
};
85
86
87
#endif
// QGSUNLITMATERIALSETTINGS_H
Qgis::MaterialRenderingTechnique
MaterialRenderingTechnique
Material rendering techniques.
Definition
qgis.h:4453
QgsAbstractMaterialSettings
Abstract base class for material settings.
Definition
qgsabstractmaterialsettings.h:42
QgsAbstractMaterialSettings::writeXml
virtual void writeXml(QDomElement &element, const QgsReadWriteContext &) const
Writes settings to a DOM element.
Definition
qgsabstractmaterialsettings.cpp:31
QgsAbstractMaterialSettings::readXml
virtual void readXml(const QDomElement &element, const QgsReadWriteContext &)
Reads settings from a DOM element.
Definition
qgsabstractmaterialsettings.cpp:24
QgsAbstractMaterialSettings::clone
virtual QgsAbstractMaterialSettings * clone() const =0
Clones the material settings.
QgsAbstractMaterialSettings::Property
Property
Data definable properties.
Definition
qgsabstractmaterialsettings.h:131
QgsAbstractMaterialSettings::averageColor
virtual QColor averageColor() const =0
Returns an approximate color representing the blended material color.
QgsAbstractMaterialSettings::type
virtual QString type() const =0
Returns the unique type name for the material.
QgsAbstractMaterialSettings::setColorsFromBase
virtual void setColorsFromBase(const QColor &baseColor)=0
Decomposes a base color into the material's color components, and sets the material's colors accordin...
QgsAbstractMaterialSettings::dataDefinedProperties
QgsPropertyCollection dataDefinedProperties() const
Returns the symbol material property collection, used for data defined overrides.
Definition
qgsabstractmaterialsettings.cpp:59
QgsMaterial
Base class for all materials used within QGIS 3D views.
Definition
qgsmaterial.h:40
QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition
qgsreadwritecontext.h:38
QgsUnlitMaterialSettings::operator==
bool operator==(const QgsUnlitMaterialSettings &other) const
Definition
qgsunlitmaterialsettings.h:80
QgsUnlitMaterialSettings::QgsUnlitMaterialSettings
QgsUnlitMaterialSettings()=default
QgsUnlitMaterialSettings::color
QColor color() const
Returns the material color.
Definition
qgsunlitmaterialsettings.h:64
QgsUnlitMaterialSettings::equals
bool equals(const QgsAbstractMaterialSettings *other) const override
Returns true if this settings exactly matches an other settings.
Definition
qgsunlitmaterialsettings.cpp:59
QgsUnlitMaterialSettings::setColor
void setColor(const QColor &color)
Sets the material's color.
Definition
qgsunlitmaterialsettings.h:71
QgsUnlitMaterialSettings::supportedProperties
QSet< QgsAbstractMaterialSettings::Property > supportedProperties() const override
Returns the set of data-defined properties supported by this material.
Definition
qgsunlitmaterialsettings.cpp:68
QgsUnlitMaterialSettings::create
static std::unique_ptr< QgsAbstractMaterialSettings > create()
Returns a new instance of QgsUnlitMaterialSettings.
Definition
qgsunlitmaterialsettings.cpp:49
QgsUnlitMaterialSettings::supportsTechnique
static bool supportsTechnique(Qgis::MaterialRenderingTechnique technique)
Returns true if the specified technique is supported by the material.
Definition
qgsunlitmaterialsettings.cpp:30
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
qgsabstractmaterialsettings.h
Generated on
for QGIS API Documentation by
1.17.0