QGIS API Documentation
3.0.2-Girona (307d082)
|
A paint effect which draws an offset and optionally blurred drop shadow. More...
#include <qgsshadoweffect.h>
Public Member Functions | |
QgsDropShadowEffect () | |
QgsDropShadowEffect * | clone () const override |
Duplicates an effect by creating a deep copy of the effect. More... | |
QString | type () const override |
Returns the effect type. More... | |
Public Member Functions inherited from QgsShadowEffect | |
QgsShadowEffect () | |
QPainter::CompositionMode | blendMode () const |
Returns the blend mode for the effect. More... | |
int | blurLevel () const |
Returns the blur level (strength) for the shadow. More... | |
QColor | color () const |
Returns the color used for the shadow. More... | |
int | offsetAngle () const |
Returns the angle used for offsetting the shadow. More... | |
double | offsetDistance () const |
Returns the distance used for offsetting the shadow. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale used for the shadow offset distance. More... | |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units used for the shadow offset distance. More... | |
double | opacity () const |
Returns the opacity for the effect. More... | |
QgsStringMap | properties () const override |
Returns the properties describing the paint effect encoded in a string format. 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 int level) |
Sets blur level (strength) for the shadow. More... | |
void | setColor (const QColor &color) |
Sets the color for the shadow. More... | |
void | setOffsetAngle (const int angle) |
Sets the angle for offsetting the shadow. More... | |
void | setOffsetDistance (const double distance) |
Sets the distance for offsetting the shadow. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for the shadow offset distance. More... | |
void | setOffsetUnit (const QgsUnitTypes::RenderUnit unit) |
Sets the units used for the shadow offset distance. More... | |
void | setOpacity (const double opacity) |
Sets the opacity for the effect. More... | |
Public Member Functions inherited from QgsPaintEffect | |
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 (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 QgsDropShadowEffect effect from a properties string map. More... | |
Protected Member Functions | |
bool | exteriorShadow () const override |
Specifies whether the shadow is drawn outside the picture or within the picture. More... | |
Protected Member Functions inherited from QgsShadowEffect | |
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... | |
Protected Member Functions inherited from QgsPaintEffect | |
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 | |
Public Types inherited from QgsPaintEffect | |
enum | DrawMode { Modifier, Render, ModifyAndRender } |
Drawing modes for effects. More... | |
Protected Attributes inherited from QgsShadowEffect | |
QPainter::CompositionMode | mBlendMode = QPainter::CompositionMode_Multiply |
int | mBlurLevel = 10 |
QColor | mColor |
int | mOffsetAngle = 135 |
double | mOffsetDist = 2.0 |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
double | mOpacity = 1.0 |
Protected Attributes inherited from QgsPaintEffect | |
DrawMode | mDrawMode = ModifyAndRender |
bool | mEnabled = true |
bool | requiresQPainterDpiFix = true |
A paint effect which draws an offset and optionally blurred drop shadow.
Definition at line 208 of file qgsshadoweffect.h.
QgsDropShadowEffect::QgsDropShadowEffect | ( | ) |
Definition at line 169 of file qgsshadoweffect.cpp.
|
overridevirtual |
Duplicates an effect by creating a deep copy of the effect.
Implements QgsPaintEffect.
Definition at line 180 of file qgsshadoweffect.cpp.
|
static |
Creates a new QgsDropShadowEffect effect from a properties string map.
map | encoded properties string map |
Definition at line 162 of file qgsshadoweffect.cpp.
|
overrideprotectedvirtual |
Specifies whether the shadow is drawn outside the picture or within the picture.
Implements QgsShadowEffect.
Definition at line 185 of file qgsshadoweffect.cpp.
|
overridevirtual |
Returns the effect type.
Implements QgsPaintEffect.
Definition at line 175 of file qgsshadoweffect.cpp.