QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsInnerShadowEffect Class Reference

A paint effect which draws an offset and optionally blurred drop shadow within a picture. More...

#include <qgsshadoweffect.h>

Inheritance diagram for QgsInnerShadowEffect:
Inheritance graph
[legend]

Public Member Functions

 QgsInnerShadowEffect ()
 
QgsInnerShadowEffectclone () 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...
 
double blurLevel () const
 Returns the blur level (radius) for the shadow. More...
 
const QgsMapUnitScaleblurMapUnitScale () 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 QgsMapUnitScaleoffsetMapUnitScale () 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 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...
 
- 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 (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 QgsPaintEffectcreate (const QgsStringMap &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...
 
- 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
 
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
 
- Protected Attributes inherited from QgsPaintEffect
DrawMode mDrawMode = ModifyAndRender
 
bool mEnabled = true
 
bool requiresQPainterDpiFix = true
 

Detailed Description

A paint effect which draws an offset and optionally blurred drop shadow within a picture.

Since
QGIS 2.9

Definition at line 285 of file qgsshadoweffect.h.

Constructor & Destructor Documentation

◆ QgsInnerShadowEffect()

QgsInnerShadowEffect::QgsInnerShadowEffect ( )

Definition at line 223 of file qgsshadoweffect.cpp.

Member Function Documentation

◆ clone()

QgsInnerShadowEffect * QgsInnerShadowEffect::clone ( ) const
overridevirtual

Duplicates an effect by creating a deep copy of the effect.

Returns
clone of paint effect

Implements QgsPaintEffect.

Definition at line 234 of file qgsshadoweffect.cpp.

◆ create()

QgsPaintEffect * QgsInnerShadowEffect::create ( const QgsStringMap map)
static

Creates a new QgsInnerShadowEffect effect from a properties string map.

Parameters
mapencoded properties string map
Returns
new QgsInnerShadowEffect

Definition at line 216 of file qgsshadoweffect.cpp.

◆ exteriorShadow()

bool QgsInnerShadowEffect::exteriorShadow ( ) const
overrideprotectedvirtual

Specifies whether the shadow is drawn outside the picture or within the picture.

Returns
true if shadow is to be drawn outside the picture, or false to draw shadow within the picture

Implements QgsShadowEffect.

Definition at line 239 of file qgsshadoweffect.cpp.

◆ type()

QString QgsInnerShadowEffect::type ( ) const
overridevirtual

Returns the effect type.

Returns
unique string representation of the effect type

Implements QgsPaintEffect.

Definition at line 229 of file qgsshadoweffect.cpp.


The documentation for this class was generated from the following files: