QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
src
core
effects
qgseffectstack.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgseffectstack.h
3
----------------
4
begin : December 2014
5
copyright : (C) 2014 Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************/
8
9
/***************************************************************************
10
* *
11
* This program is free software; you can redistribute it and/or modify *
12
* it under the terms of the GNU General Public License as published by *
13
* the Free Software Foundation; either version 2 of the License, or *
14
* (at your option) any later version. *
15
* *
16
***************************************************************************/
17
#ifndef QGSEFFECTSTACK_H
18
#define QGSEFFECTSTACK_H
19
20
#include "qgis_core.h"
21
#include "
qgis_sip.h
"
22
#include "
qgspainteffect.h
"
23
44
class
CORE_EXPORT
QgsEffectStack
:
public
QgsPaintEffect
SIP_NODEFAULTCTORS
45
{
46
47
public
:
48
55
static
QgsPaintEffect
*create(
const
QVariantMap &map )
SIP_FACTORY
;
56
60
QgsEffectStack
() =
default
;
61
62
QgsEffectStack
(
const
QgsEffectStack
&other );
63
67
QgsEffectStack
(
QgsEffectStack
&&other )
SIP_SKIP
;
68
75
explicit
QgsEffectStack
(
const
QgsPaintEffect
&effect );
76
77
~
QgsEffectStack
()
override
;
78
79
QString
type
()
const override
{
return
QStringLiteral(
"effectStack"
); }
80
QgsEffectStack
*
clone
() const override
SIP_FACTORY
;
81
bool
saveProperties( QDomDocument &doc, QDomElement &element ) const override;
82
bool
readProperties( const QDomElement &element ) override;
83
87
QVariantMap properties() const override;
88
92
void
readProperties( const QVariantMap &props ) override;
93
100
void
appendEffect(
QgsPaintEffect
*effect
SIP_TRANSFER
);
101
109
bool
insertEffect(
int
index,
QgsPaintEffect
*effect
SIP_TRANSFER
);
110
117
bool
changeEffect(
int
index,
QgsPaintEffect
*effect
SIP_TRANSFER
);
118
123
QgsPaintEffect
*takeEffect(
int
index
SIP_TRANSFERBACK
);
124
130
QList<
QgsPaintEffect
* > *effectList();
131
136
int
count()
const
{
return
mEffectList.count(); }
137
143
QgsPaintEffect
*effect(
int
index )
const
;
144
145
QgsEffectStack
&operator=(
const
QgsEffectStack
&rhs );
146
147
QgsEffectStack
&operator=(
QgsEffectStack
&&other )
SIP_SKIP
;
148
149
150
protected
:
151
152
void
draw
(
QgsRenderContext
&context )
override
;
153
154
private
:
155
156
QList< QgsPaintEffect * > mEffectList;
157
158
void
clearStack();
159
};
160
161
#endif
// QGSEFFECTSTACK_H
162
QgsEffectStack
A paint effect which consists of a stack of other chained paint effects.
Definition:
qgseffectstack.h:45
QgsEffectStack::QgsEffectStack
QgsEffectStack()=default
Constructor for empty QgsEffectStack.
QgsEffectStack::type
QString type() const override
Returns the effect type.
Definition:
qgseffectstack.h:79
QgsPaintEffect
Base class for visual effects which can be applied to QPicture drawings.
Definition:
qgspainteffect.h:54
QgsPaintEffect::clone
virtual QgsPaintEffect * clone() const =0
Duplicates an effect by creating a deep copy of the effect.
QgsPaintEffect::QgsEffectStack
friend class QgsEffectStack
Definition:
qgspainteffect.h:309
QgsPaintEffect::draw
virtual void draw(QgsRenderContext &context)=0
Handles drawing of the effect's result on to the specified render context.
QgsRenderContext
Contains information about the context of a rendering operation.
Definition:
qgsrendercontext.h:59
qgis_sip.h
SIP_SKIP
#define SIP_SKIP
Definition:
qgis_sip.h:126
SIP_TRANSFER
#define SIP_TRANSFER
Definition:
qgis_sip.h:36
SIP_TRANSFERBACK
#define SIP_TRANSFERBACK
Definition:
qgis_sip.h:48
SIP_FACTORY
#define SIP_FACTORY
Definition:
qgis_sip.h:76
SIP_NODEFAULTCTORS
#define SIP_NODEFAULTCTORS
Definition:
qgis_sip.h:101
qgspainteffect.h
Generated on Sun Mar 21 2021 09:16:51 for QGIS API Documentation by
1.9.1