QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
A paint effect which draws an offset and optionally blurred drop shadow within a picture. More...
#include <qgsshadoweffect.h>
Public Member Functions | |
QgsInnerShadowEffect () | |
QgsInnerShadowEffect * | clone () const override |
Duplicates an effect by creating a deep copy of the effect. More... | |
QString | type () const override |
Returns the effect type. More... | |
![]() | |
QgsShadowEffect () | |
QPainter::CompositionMode | blendMode () const |
Returns the blend mode for the effect. More... | |
double | blurLevel () const |
Returns the blur level (radius) for the shadow. More... | |
const QgsMapUnitScale & | blurMapUnitScale () const |
Returns the map unit scale used for the shadow blur strength (radius). More... | |
QgsUnitTypes::RenderUnit | blurUnit () const |
Returns the units used for the shadow blur level (radius). 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... | |
QVariantMap | properties () const override |
Returns the properties describing the paint effect encoded in a string format. More... | |
void | readProperties (const QVariantMap &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 shadow. More... | |
void | setBlurMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for the shadow blur strength (radius). More... | |
void | setBlurUnit (const QgsUnitTypes::RenderUnit unit) |
Sets the units used for the shadow blur level (radius). 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... | |
![]() | |
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... | |
virtual QgsPaintEffect * | clone () const =0 |
Duplicates an effect by creating a deep copy of the effect. 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 QVariantMap | properties () const =0 |
Returns the properties describing the paint effect encoded in a string format. More... | |
virtual bool | readProperties (const QDomElement &element) |
Restores the effect to the state described by a DOM element. More... | |
virtual void | readProperties (const QVariantMap &props)=0 |
Reads a string map of an effect's properties and restores the effect to the state described by the properties map. 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... | |
virtual QString | type () const =0 |
Returns the effect type. More... | |
Static Public Member Functions | |
static QgsPaintEffect * | create (const QVariantMap &map) |
Creates a new QgsInnerShadowEffect 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... | |
![]() | |
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... | |
virtual bool | exteriorShadow () const =0 |
Specifies whether the shadow is drawn outside the picture or within the picture. More... | |
![]() | |
virtual QRectF | boundingRect (const QRectF &rect, const QgsRenderContext &context) const |
Returns the bounding rect required for drawing the effect. More... | |
virtual void | draw (QgsRenderContext &context)=0 |
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 | DrawMode { Modifier , Render , ModifyAndRender } |
Drawing modes for effects. More... | |
![]() | |
QPainter::CompositionMode | mBlendMode = QPainter::CompositionMode_Multiply |
double | mBlurLevel = 2.645 |
QgsMapUnitScale | mBlurMapUnitScale |
QgsUnitTypes::RenderUnit | mBlurUnit = QgsUnitTypes::RenderMillimeters |
QColor | mColor |
int | mOffsetAngle = 135 |
double | mOffsetDist = 2.0 |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
double | mOpacity = 1.0 |
![]() | |
DrawMode | mDrawMode = ModifyAndRender |
bool | mEnabled = true |
bool | requiresQPainterDpiFix = true |
A paint effect which draws an offset and optionally blurred drop shadow within a picture.
Definition at line 287 of file qgsshadoweffect.h.
QgsInnerShadowEffect::QgsInnerShadowEffect | ( | ) |
Definition at line 232 of file qgsshadoweffect.cpp.
|
overridevirtual |
Duplicates an effect by creating a deep copy of the effect.
Implements QgsPaintEffect.
Definition at line 243 of file qgsshadoweffect.cpp.
|
static |
Creates a new QgsInnerShadowEffect effect from a properties string map.
map | encoded properties string map |
Definition at line 225 of file qgsshadoweffect.cpp.
|
overrideprotectedvirtual |
Specifies whether the shadow is drawn outside the picture or within the picture.
true
if shadow is to be drawn outside the picture, or false
to draw shadow within the picture Implements QgsShadowEffect.
Definition at line 248 of file qgsshadoweffect.cpp.
|
overridevirtual |
Returns the effect type.
Implements QgsPaintEffect.
Definition at line 238 of file qgsshadoweffect.cpp.