A paint effect which draws a glow outside of a picture. More...

#include <qgsgloweffect.h>

Inheritance diagram for QgsOuterGlowEffect:

[legend]

Public Member Functions
	QgsOuterGlowEffect ()

QgsOuterGlowEffect *	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 QgsGlowEffect
	QgsGlowEffect ()

	QgsGlowEffect (const QgsGlowEffect &other)

	~QgsGlowEffect () override

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

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

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

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

QColor	color () const
	Returns the color for the glow.

GlowColorType	colorType () const
	Returns the color mode used for the glow.

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

QgsGlowEffect &	operator= (const QgsGlowEffect &rhs)

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

QgsColorRamp *	ramp () const
	Returns the color ramp used for the glow.

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 glow.

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

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

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

void	setColorType (GlowColorType colorType)
	Sets the color mode to use for the glow.

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

void	setRamp (QgsColorRamp *ramp)
	Sets the color ramp for the glow.

void	setSpread (const double spread)
	Sets the spread distance for drawing the glow effect.

void	setSpreadMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale used for the spread distance.

void	setSpreadUnit (const Qgis::RenderUnit unit)
	Sets the units used for the glow spread distance.

double	spread () const
	Returns the spread distance used for drawing the glow effect.

const QgsMapUnitScale &	spreadMapUnitScale () const
	Returns the map unit scale used for the spread distance.

Qgis::RenderUnit	spreadUnit () const
	Returns the units used for the glow spread distance.

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 QgsOuterGlowEffect effect from a properties string map.

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

Protected Member Functions inherited from QgsGlowEffect
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 QgsGlowEffect
enum	GlowColorType { SingleColor , ColorRamp }
	Color sources for the glow. More...

Public Types inherited from QgsPaintEffect
enum	DrawMode { Modifier , Render , ModifyAndRender }
	Drawing modes for effects. More...

Protected Attributes inherited from QgsGlowEffect
QPainter::CompositionMode	mBlendMode = QPainter::CompositionMode_SourceOver

double	mBlurLevel = 2.645

QgsMapUnitScale	mBlurMapUnitScale

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

QColor	mColor

GlowColorType	mColorType = SingleColor

double	mOpacity = 0.5

QgsColorRamp *	mRamp = nullptr

double	mSpread = 2.0

QgsMapUnitScale	mSpreadMapUnitScale

Qgis::RenderUnit	mSpreadUnit = Qgis::RenderUnit::Millimeters

Protected Attributes inherited from QgsPaintEffect
DrawMode	mDrawMode = ModifyAndRender

bool	mEnabled = true

bool	requiresQPainterDpiFix = true

Detailed Description

A paint effect which draws a glow outside of a picture.

Definition at line 297 of file qgsgloweffect.h.

Constructor & Destructor Documentation

◆ QgsOuterGlowEffect()

QgsOuterGlowEffect::QgsOuterGlowEffect ( )

Definition at line 246 of file qgsgloweffect.cpp.

Member Function Documentation

◆ clone()

QgsOuterGlowEffect * QgsOuterGlowEffect::clone ( ) const

overridevirtual

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

Returns: clone of paint effect

Implements QgsPaintEffect.

Definition at line 259 of file qgsgloweffect.cpp.

◆ create()

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

static

Creates a new QgsOuterGlowEffect effect from a properties string map.

Parameters

map	encoded properties string map

Returns: new QgsOuterGlowEffect

Definition at line 252 of file qgsgloweffect.cpp.

◆ shadeExterior()

bool QgsOuterGlowEffect::shadeExterior ( ) const

inlineoverrideprotectedvirtual

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

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

Implements QgsGlowEffect.

Definition at line 316 of file qgsgloweffect.h.

◆ type()

QString QgsOuterGlowEffect::type ( ) const

inlineoverridevirtual

Returns the effect type.

Returns: unique string representation of the effect type

Implements QgsPaintEffect.

Definition at line 311 of file qgsgloweffect.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members