QGIS API Documentation 4.1.0-Master (9af12b5a203)
Loading...
Searching...
No Matches
qgsbloomsettings.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsbloomsettings.h
3 --------------------------------------
4 Date : May 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 QGSBLOOMSETTINGS_H
17#define QGSBLOOMSETTINGS_H
18
19#include "qgis_3d.h"
20
21#include <QMap>
22#include <QString>
23
24#define SIP_NO_FILE
25
27class QDomElement;
28
29
36class _3D_EXPORT QgsBloomSettings
37{
38 public:
39 QgsBloomSettings() = default;
40 QgsBloomSettings( const QgsBloomSettings &other );
42
48 void readXml( const QDomElement &element, const QgsReadWriteContext &context );
49
55 void writeXml( QDomElement &element, const QgsReadWriteContext &context ) const;
56
62 void setEnabled( bool enabled ) { mEnabled = enabled; }
63
69 bool isEnabled() const { return mEnabled; }
70
76 void setIntensity( double factor ) { mIntensity = factor; }
77
83 double intensity() const { return mIntensity; }
84
90 void setRadius( double radius ) { mRadius = radius; }
91
97 double radius() const { return mRadius; }
98
99 private:
100 bool mEnabled = false;
101 double mIntensity = 0.05;
102 double mRadius = 0.005;
103};
104
105#endif // QGSBLOOMSETTINGS_H
void writeXml(QDomElement &element, const QgsReadWriteContext &context) const
Writes settings to a DOM element.
double intensity() const
Returns the intensity of the bloom effect.
double radius() const
Returns the filter radius for the bloom.
QgsBloomSettings()=default
QgsBloomSettings & operator=(QgsBloomSettings const &rhs)
bool isEnabled() const
Returns whether the bloom effect is enabled.
void readXml(const QDomElement &element, const QgsReadWriteContext &context)
Reads settings from a DOM element.
void setRadius(double radius)
Sets the filter radius for the bloom.
void setEnabled(bool enabled)
Sets whether the bloom effect is enabled.
void setIntensity(double factor)
Sets the intensity of the bloom effect.
A container for the context for various read/write operations on objects.