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

#include <qgsshadoweffect.h>

Inheritance diagram for QgsInnerShadowEffect:

[legend]

Public Member Functions
	QgsInnerShadowEffect ()

QgsInnerShadowEffect *	clone () const override
	Duplicates an effect by creating a deep copy of the effect.

QString	type () const override
	Returns the effect type.

Public Member Functions inherited from QgsShadowEffect
	QgsShadowEffect ()

QPainter::CompositionMode	blendMode () const
	Returns the blend mode for the effect.

double	blurLevel () const
	Returns the blur level (radius) for the shadow.

const QgsMapUnitScale &	blurMapUnitScale () const
	Returns the map unit scale used for the shadow blur strength (radius).

Qgis::RenderUnit	blurUnit () const
	Returns the units used for the shadow blur level (radius).

QColor	color () const
	Returns the color used for the shadow.

int	offsetAngle () const
	Returns the angle used for offsetting the shadow.

double	offsetDistance () const
	Returns the distance used for offsetting the shadow.

const QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale used for the shadow offset distance.

Qgis::RenderUnit	offsetUnit () const
	Returns the units used for the shadow offset distance.

double	opacity () const
	Returns the opacity for the effect.

QVariantMap	properties () const override
	Returns the properties describing the paint effect encoded in a string format.

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.

void	setBlendMode (const QPainter::CompositionMode mode)
	Sets the blend mode for the effect.

void	setBlurLevel (const double level)
	Sets blur level (radius) for the shadow.

void	setBlurMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale used for the shadow blur strength (radius).

void	setBlurUnit (const Qgis::RenderUnit unit)
	Sets the units used for the shadow blur level (radius).

void	setColor (const QColor &color)
	Sets the color for the shadow.

void	setOffsetAngle (const int angle)
	Sets the angle for offsetting the shadow.

void	setOffsetDistance (const double distance)
	Sets the distance for offsetting the shadow.

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale used for the shadow offset distance.

void	setOffsetUnit (const Qgis::RenderUnit unit)
	Sets the units used for the shadow offset distance.

void	setOpacity (const double opacity)
	Sets the opacity for the effect.

Public Member Functions inherited from QgsPaintEffect
	QgsPaintEffect ()=default

	QgsPaintEffect (const QgsPaintEffect &other)

virtual	~QgsPaintEffect ()

virtual void	begin (QgsRenderContext &context)
	Begins intercepting paint operations to a render context.

DrawMode	drawMode () const
	Returns the draw mode for the effect.

bool	enabled () const
	Returns whether the effect is enabled.

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.

virtual bool	readProperties (const QDomElement &element)
	Restores the effect to the state described by a DOM element.

virtual void	render (QPicture &picture, QgsRenderContext &context)
	Renders a picture using the effect.

virtual bool	saveProperties (QDomDocument &doc, QDomElement &element) const
	Saves the current state of the effect to a DOM element.

void	setDrawMode (DrawMode drawMode)
	Sets the draw mode for the effect.

void	setEnabled (bool enabled)
	Sets whether the effect is enabled.

Static Public Member Functions
static QgsPaintEffect *	create (const QVariantMap &map)
	Creates a new QgsInnerShadowEffect effect from a properties string map.

Protected Member Functions
bool	exteriorShadow () const override
	Specifies whether the shadow is drawn outside the picture or within the picture.

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.

void	draw (QgsRenderContext &context) override
	Handles drawing of the effect's result on to the specified render context.

Protected Member Functions inherited from QgsPaintEffect
void	drawSource (QPainter &painter)
	Draws the source QPicture onto the specified painter.

Q_DECL_DEPRECATED void	fixQPictureDpi (QPainter *painter) const
	Applies a workaround to a QPainter to avoid an issue with incorrect scaling when drawing QPictures.

QPointF	imageOffset (const QgsRenderContext &context) const
	Returns the offset which should be used when drawing the source image on to a destination render context.

const QPicture *	source () const
	Returns the source QPicture.

QImage *	sourceAsImage (QgsRenderContext &context)
	Returns the source QPicture rendered to a new QImage.

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

Qgis::RenderUnit	mBlurUnit = Qgis::RenderUnit::Millimeters

QColor	mColor

int	mOffsetAngle = 135

double	mOffsetDist = 2.0

QgsMapUnitScale	mOffsetMapUnitScale

Qgis::RenderUnit	mOffsetUnit = Qgis::RenderUnit::Millimeters

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.

Definition at line 284 of file qgsshadoweffect.h.

Constructor & Destructor Documentation

◆ QgsInnerShadowEffect()

QgsInnerShadowEffect::QgsInnerShadowEffect ( )

Definition at line 233 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 244 of file qgsshadoweffect.cpp.

◆ create()

QgsPaintEffect * QgsInnerShadowEffect::create ( const QVariantMap & map )

static

Creates a new QgsInnerShadowEffect effect from a properties string map.

Parameters

map	encoded properties string map

Returns: new QgsInnerShadowEffect

Definition at line 226 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 249 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 239 of file qgsshadoweffect.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/effects/qgsshadoweffect.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/effects/qgsshadoweffect.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members