QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
A paint effect which draws a glow outside of a picture. More...
#include <qgsgloweffect.h>
Public Member Functions | |
QgsOuterGlowEffect () | |
QgsOuterGlowEffect * | clone () const override |
Duplicates an effect by creating a deep copy of the effect. More... | |
QString | type () const override |
Returns the effect type. More... | |
![]() | |
QgsGlowEffect () | |
QgsGlowEffect (const QgsGlowEffect &other) | |
~QgsGlowEffect () override | |
QPainter::CompositionMode | blendMode () const |
Returns the blend mode for the effect. More... | |
double | blurLevel () const |
Returns the blur level (radius) for the glow. More... | |
const QgsMapUnitScale & | blurMapUnitScale () const |
Returns the map unit scale used for the glow blur strength (radius). More... | |
QgsUnitTypes::RenderUnit | blurUnit () const |
Returns the units used for the glow blur level (radius). More... | |
QColor | color () const |
Returns the color for the glow. More... | |
GlowColorType | colorType () const |
Returns the color mode used for the glow. More... | |
double | opacity () const |
Returns the opacity for the effect. More... | |
QgsGlowEffect & | operator= (const QgsGlowEffect &rhs) |
QgsStringMap | properties () const override |
Returns the properties describing the paint effect encoded in a string format. More... | |
QgsColorRamp * | ramp () const |
Returns the color ramp used for the glow. More... | |
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 double level) |
Sets blur level (radius) for the glow. More... | |
void | setBlurMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for the glow blur strength (radius). More... | |
void | setBlurUnit (const QgsUnitTypes::RenderUnit unit) |
Sets the units used for the glow blur level (radius). 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 | setOpacity (const double opacity) |
Sets the opacity for the effect. More... | |
void | setRamp (QgsColorRamp *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 QgsUnitTypes::RenderUnit unit) |
Sets the units used for the glow spread distance. 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... | |
QgsUnitTypes::RenderUnit | spreadUnit () const |
Returns the units used for the glow spread distance. More... | |
![]() | |
QgsPaintEffect ()=default | |
Constructor for QgsPaintEffect. More... | |
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 (DrawMode drawMode) |
Sets the draw mode for the effect. More... | |
void | setEnabled (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 | |
bool | shadeExterior () const override |
Specifies whether the glow is drawn outside the picture or within the picture. More... | |
![]() | |
QRectF | boundingRect (const QRectF &rect, const QgsRenderContext &context) const override |
Returns the bounding rect required for drawing the effect. More... | |
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 = QPainter::CompositionMode_SourceOver |
double | mBlurLevel = 2.645 |
QgsMapUnitScale | mBlurMapUnitScale |
QgsUnitTypes::RenderUnit | mBlurUnit = QgsUnitTypes::RenderMillimeters |
QColor | mColor |
GlowColorType | mColorType = SingleColor |
double | mOpacity = 0.5 |
QgsColorRamp * | mRamp = nullptr |
double | mSpread = 2.0 |
QgsMapUnitScale | mSpreadMapUnitScale |
QgsUnitTypes::RenderUnit | mSpreadUnit = QgsUnitTypes::RenderMillimeters |
![]() | |
DrawMode | mDrawMode = ModifyAndRender |
bool | mEnabled = true |
bool | requiresQPainterDpiFix = true |
A paint effect which draws a glow outside of a picture.
Definition at line 299 of file qgsgloweffect.h.
QgsOuterGlowEffect::QgsOuterGlowEffect | ( | ) |
Definition at line 235 of file qgsgloweffect.cpp.
|
overridevirtual |
Duplicates an effect by creating a deep copy of the effect.
Implements QgsPaintEffect.
Definition at line 248 of file qgsgloweffect.cpp.
|
static |
Creates a new QgsOuterGlowEffect effect from a properties string map.
map | encoded properties string map |
Definition at line 241 of file qgsgloweffect.cpp.
|
inlineoverrideprotectedvirtual |
Specifies whether the glow is drawn outside the picture or within the picture.
true
if glow is to be drawn outside the picture, or false
to draw glow within the picture Implements QgsGlowEffect.
Definition at line 318 of file qgsgloweffect.h.
|
inlineoverridevirtual |
Returns the effect type.
Implements QgsPaintEffect.
Definition at line 313 of file qgsgloweffect.h.