QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
A paint effect which draws a glow outside of a picture. More...
#include <qgsgloweffect.h>
Public Member Functions | |
QgsOuterGlowEffect () | |
virtual | ~QgsOuterGlowEffect () |
virtual QgsOuterGlowEffect * | clone () const override |
Duplicates an effect by creating a deep copy of the effect. More... | |
virtual QString | type () const override |
Returns the effect type. More... | |
![]() | |
QgsGlowEffect () | |
QgsGlowEffect (const QgsGlowEffect &other) | |
virtual | ~QgsGlowEffect () |
QPainter::CompositionMode | blendMode () const |
Returns the blend mode for the effect. More... | |
int | blurLevel () const |
Returns the blur level (strength) for the glow. More... | |
QColor | color () const |
Returns the color for the glow. More... | |
GlowColorType | colorType () const |
Returns the color mode used for the glow. More... | |
QgsGlowEffect & | operator= (const QgsGlowEffect &rhs) |
virtual QgsStringMap | properties () const override |
Returns the properties describing the paint effect encoded in a string format. More... | |
QgsVectorColorRampV2 * | ramp () const |
Returns the color ramp used for the glow. More... | |
virtual void | readProperties (const QgsStringMap &props) override |
Reads a string map of an effect's properties and restores the effect to the state described by the properties map. More... | |
void | setBlendMode (const QPainter::CompositionMode mode) |
Sets the blend mode for the effect. More... | |
void | setBlurLevel (const int level) |
Sets blur level (strength) for the glow. More... | |
void | setColor (const QColor &color) |
Sets the color for the glow. More... | |
void | setColorType (GlowColorType colorType) |
Sets the color mode to use for the glow. More... | |
void | setRamp (QgsVectorColorRampV2 *ramp) |
Sets the color ramp for the glow. More... | |
void | setSpread (const double spread) |
Sets the spread distance for drawing the glow effect. More... | |
void | setSpreadMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for the spread distance. More... | |
void | setSpreadUnit (const QgsSymbolV2::OutputUnit unit) |
Sets the units used for the glow spread distance. More... | |
void | setTransparency (const double transparency) |
Sets the transparency for the effect. More... | |
double | spread () const |
Returns the spread distance used for drawing the glow effect. More... | |
const QgsMapUnitScale & | spreadMapUnitScale () const |
Returns the map unit scale used for the spread distance. More... | |
QgsSymbolV2::OutputUnit | spreadUnit () const |
Returns the units used for the glow spread distance. More... | |
double | transparency () const |
Returns the transparency for the effect. More... | |
![]() | |
QgsPaintEffect () | |
QgsPaintEffect (const QgsPaintEffect &other) | |
virtual | ~QgsPaintEffect () |
virtual void | begin (QgsRenderContext &context) |
Begins intercepting paint operations to a render context. More... | |
DrawMode | drawMode () const |
Returns the draw mode for the effect. More... | |
bool | enabled () const |
Returns whether the effect is enabled. More... | |
virtual void | end (QgsRenderContext &context) |
Ends interception of paint operations to a render context, and draws the result to the render context after being modified by the effect. More... | |
virtual bool | readProperties (const QDomElement &element) |
Restores the effect to the state described by a DOM element. More... | |
virtual void | render (QPicture &picture, QgsRenderContext &context) |
Renders a picture using the effect. More... | |
virtual bool | saveProperties (QDomDocument &doc, QDomElement &element) const |
Saves the current state of the effect to a DOM element. More... | |
void | setDrawMode (const DrawMode drawMode) |
Sets the draw mode for the effect. More... | |
void | setEnabled (const bool enabled) |
Sets whether the effect is enabled. More... | |
Static Public Member Functions | |
static QgsPaintEffect * | create (const QgsStringMap &map) |
Creates a new QgsOuterGlowEffect effect from a properties string map. More... | |
Protected Member Functions | |
virtual bool | shadeExterior () const override |
Specifies whether the glow is drawn outside the picture or within the picture. More... | |
![]() | |
virtual QRectF | boundingRect (const QRectF &rect, const QgsRenderContext &context) const override |
Returns the bounding rect required for drawing the effect. More... | |
virtual void | draw (QgsRenderContext &context) override |
Handles drawing of the effect's result on to the specified render context. More... | |
![]() | |
void | drawSource (QPainter &painter) |
Draws the source QPicture onto the specified painter. More... | |
void | fixQPictureDpi (QPainter *painter) const |
Applies a workaround to a QPainter to avoid an issue with incorrect scaling when drawing QPictures. More... | |
QPointF | imageOffset (const QgsRenderContext &context) const |
Returns the offset which should be used when drawing the source image on to a destination render context. More... | |
const QPicture * | source () const |
Returns the source QPicture. More... | |
QImage * | sourceAsImage (QgsRenderContext &context) |
Returns the source QPicture rendered to a new QImage. More... | |
Additional Inherited Members | |
![]() | |
enum | GlowColorType { SingleColor, ColorRamp } |
Color sources for the glow. More... | |
![]() | |
enum | DrawMode { Modifier, Render, ModifyAndRender } |
Drawing modes for effects. More... | |
![]() | |
QPainter::CompositionMode | mBlendMode |
int | mBlurLevel |
QColor | mColor |
GlowColorType | mColorType |
QgsVectorColorRampV2 * | mRamp |
double | mSpread |
QgsMapUnitScale | mSpreadMapUnitScale |
QgsSymbolV2::OutputUnit | mSpreadUnit |
double | mTransparency |
![]() | |
DrawMode | mDrawMode |
bool | mEnabled |
bool | requiresQPainterDpiFix |
A paint effect which draws a glow outside of a picture.
Definition at line 231 of file qgsgloweffect.h.
QgsOuterGlowEffect::QgsOuterGlowEffect | ( | ) |
Definition at line 220 of file qgsgloweffect.cpp.
|
virtual |
Definition at line 226 of file qgsgloweffect.cpp.
|
overridevirtual |
Duplicates an effect by creating a deep copy of the effect.
Implements QgsPaintEffect.
Definition at line 238 of file qgsgloweffect.cpp.
|
static |
Creates a new QgsOuterGlowEffect effect from a properties string map.
map | encoded properties string map |
Definition at line 231 of file qgsgloweffect.cpp.
|
inlineoverrideprotectedvirtual |
Specifies whether the glow is drawn outside the picture or within the picture.
Implements QgsGlowEffect.
Definition at line 250 of file qgsgloweffect.h.
|
inlineoverridevirtual |
Returns the effect type.
Implements QgsPaintEffect.
Definition at line 245 of file qgsgloweffect.h.