QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsGlowEffect Class Referenceabstract

Base class for paint effect which draw a glow inside or outside a picture. More...

#include <qgsgloweffect.h>

Inheritance diagram for QgsGlowEffect:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 QgsGlowEffect ()
 
 QgsGlowEffect (const QgsGlowEffect &other)
 
virtual ~QgsGlowEffect ()
 
QPainter::CompositionMode blendMode () const
 Returns the blend mode for the effect. More...
 
int blurLevel () const
 Returns the blur level (strength) for the glow. More...
 
QColor color () const
 Returns the color for the glow. More...
 
GlowColorType colorType () const
 Returns the color mode used for the glow. More...
 
QgsGlowEffectoperator= (const QgsGlowEffect &rhs)
 
virtual QgsStringMap properties () const override
 Returns the properties describing the paint effect encoded in a string format. More...
 
QgsVectorColorRampV2ramp () const
 Returns the color ramp used for the glow. More...
 
virtual 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 glow. More...
 
void setColor (const QColor &color)
 Sets the color for the glow. More...
 
void setColorType (GlowColorType colorType)
 Sets the color mode to use for the glow. More...
 
void setRamp (QgsVectorColorRampV2 *ramp)
 Sets the color ramp for the glow. More...
 
void setSpread (const double spread)
 Sets the spread distance for drawing the glow effect. More...
 
void setSpreadMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale used for the spread distance. More...
 
void setSpreadUnit (const QgsSymbolV2::OutputUnit unit)
 Sets the units used for the glow spread distance. More...
 
void setTransparency (const double transparency)
 Sets the transparency for the effect. More...
 
double spread () const
 Returns the spread distance used for drawing the glow effect. More...
 
const QgsMapUnitScalespreadMapUnitScale () const
 Returns the map unit scale used for the spread distance. More...
 
QgsSymbolV2::OutputUnit spreadUnit () const
 Returns the units used for the glow spread distance. More...
 
double transparency () const
 Returns the transparency for the effect. More...
 
- Public Member Functions inherited from QgsPaintEffect
 QgsPaintEffect ()
 
 QgsPaintEffect (const QgsPaintEffect &other)
 
virtual ~QgsPaintEffect ()
 
virtual void begin (QgsRenderContext &context)
 Begins intercepting paint operations to a render context. More...
 
virtual QgsPaintEffectclone () 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 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...
 
virtual QString type () const =0
 Returns the effect type. More...
 

Protected Member Functions

virtual QRectF boundingRect (const QRectF &rect, const QgsRenderContext &context) const override
 Returns the bounding rect required for drawing the effect. More...
 
virtual void draw (QgsRenderContext &context) override
 Handles drawing of the effect's result on to the specified render context. More...
 
virtual bool shadeExterior () const =0
 Specifies whether the glow is drawn outside the picture or within the picture. 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 QPicturesource () const
 Returns the source QPicture. More...
 
QImagesourceAsImage (QgsRenderContext &context)
 Returns the source QPicture rendered to a new QImage. More...
 

Protected Attributes

QPainter::CompositionMode mBlendMode
 
int mBlurLevel
 
QColor mColor
 
GlowColorType mColorType
 
QgsVectorColorRampV2mRamp
 
double mSpread
 
QgsMapUnitScale mSpreadMapUnitScale
 
QgsSymbolV2::OutputUnit mSpreadUnit
 
double mTransparency
 
- Protected Attributes inherited from QgsPaintEffect
DrawMode mDrawMode
 
bool mEnabled
 
bool requiresQPainterDpiFix
 

Detailed Description

Base class for paint effect which draw a glow inside or outside a picture.

Note
Added in version 2.9

Definition at line 34 of file qgsgloweffect.h.

Member Enumeration Documentation

Color sources for the glow.

Enumerator
SingleColor 

use a single color and fade the color to totally transparent

ColorRamp 

use colors from a color ramp

Definition at line 40 of file qgsgloweffect.h.

Constructor & Destructor Documentation

QgsGlowEffect::QgsGlowEffect ( )

Definition at line 24 of file qgsgloweffect.cpp.

QgsGlowEffect::QgsGlowEffect ( const QgsGlowEffect other)

Definition at line 38 of file qgsgloweffect.cpp.

QgsGlowEffect::~QgsGlowEffect ( )
virtual

Definition at line 56 of file qgsgloweffect.cpp.

Member Function Documentation

QPainter::CompositionMode QgsGlowEffect::blendMode ( ) const
inline

Returns the blend mode for the effect.

Returns
blend mode used for drawing the effect on to a destination paint device
See also
setBlendMode

Definition at line 176 of file qgsgloweffect.h.

int QgsGlowEffect::blurLevel ( ) const
inline

Returns the blur level (strength) for the glow.

Returns
blur level. Value will be between 0 and 16, with larger values indicating greater blur strength.
See also
setBlurLevel

Definition at line 114 of file qgsgloweffect.h.

QRectF QgsGlowEffect::boundingRect ( const QRectF rect,
const QgsRenderContext context 
) const
overrideprotectedvirtual

Returns the bounding rect required for drawing the effect.

This method can be used to expand the bounding rect of a source picture to account for offset or blurring effects.

Parameters
rectoriginal source bounding rect
contextdestination render context
Returns
modified bounding rect
See also
sourceAsImage

Reimplemented from QgsPaintEffect.

Definition at line 206 of file qgsgloweffect.cpp.

QColor QgsGlowEffect::color ( ) const
inline

Returns the color for the glow.

This only applies if the colorType is set to SingleColor. The glow will fade between the specified color and a totally transparent version of the color.

Returns
glow color
See also
setColor
colorType

Definition at line 146 of file qgsgloweffect.h.

GlowColorType QgsGlowEffect::colorType ( ) const
inline

Returns the color mode used for the glow.

The glow can either be drawn using a QgsVectorColorRampV2 color ramp or by specificing a single color.

Returns
current color mode used for the glow
See also
setColorType
color
ramp

Definition at line 195 of file qgsgloweffect.h.

void QgsGlowEffect::draw ( QgsRenderContext context)
overrideprotectedvirtual

Handles drawing of the effect's result on to the specified render context.

Derived classes must reimplement this method to apply any transformations to the source QPicture and draw the result using the context's painter.

Parameters
contextdestination render context
See also
drawSource

Implements QgsPaintEffect.

Definition at line 61 of file qgsgloweffect.cpp.

QgsGlowEffect & QgsGlowEffect::operator= ( const QgsGlowEffect rhs)

Definition at line 188 of file qgsgloweffect.cpp.

QgsStringMap QgsGlowEffect::properties ( ) const
overridevirtual

Returns the properties describing the paint effect encoded in a string format.

Returns
string map of properties, in the form property key, value
See also
readProperties
saveProperties

Implements QgsPaintEffect.

Definition at line 118 of file qgsgloweffect.cpp.

QgsVectorColorRampV2* QgsGlowEffect::ramp ( ) const
inline

Returns the color ramp used for the glow.

This only applies if the colorType is set to ColorRamp. The glow will utilise colors from the ramp.

Returns
color ramp for glow
See also
setRamp
colorType

Definition at line 162 of file qgsgloweffect.h.

void QgsGlowEffect::readProperties ( const QgsStringMap props)
overridevirtual

Reads a string map of an effect's properties and restores the effect to the state described by the properties map.

Parameters
propseffect properties encoded in a string map
See also
properties

Implements QgsPaintEffect.

Definition at line 140 of file qgsgloweffect.cpp.

void QgsGlowEffect::setBlendMode ( const QPainter::CompositionMode  mode)
inline

Sets the blend mode for the effect.

Parameters
modeblend mode used for drawing the effect on to a destination paint device
See also
blendMode

Definition at line 169 of file qgsgloweffect.h.

void QgsGlowEffect::setBlurLevel ( const int  level)
inline

Sets blur level (strength) for the glow.

This can be used to smooth the output from the glow effect.

Parameters
levelblur level. Values between 0 and 16 are valid, with larger values indicating greater blur strength.
See also
blurLevel

Definition at line 107 of file qgsgloweffect.h.

void QgsGlowEffect::setColor ( const QColor color)
inline

Sets the color for the glow.

This only applies if the colorType is set to SingleColor. The glow will fade between the specified color and a totally transparent version of the color.

Parameters
colorglow color
See also
color
setColorType

Definition at line 137 of file qgsgloweffect.h.

void QgsGlowEffect::setColorType ( GlowColorType  colorType)
inline

Sets the color mode to use for the glow.

The glow can either be drawn using a QgsVectorColorRampV2 color ramp or by simply specificing a single color. setColorType is used to specify which mode to use for the glow.

Parameters
colorTypecolor type to use for glow
See also
colorType
setColor
setRamp

Definition at line 186 of file qgsgloweffect.h.

void QgsGlowEffect::setRamp ( QgsVectorColorRampV2 ramp)

Sets the color ramp for the glow.

This only applies if the colorType is set to ColorRamp. The glow will utilise colors from the ramp.

Parameters
rampcolor ramp for glow. Ownership of the ramp is transferred to the effect.
See also
ramp
setColorType

Definition at line 182 of file qgsgloweffect.cpp.

void QgsGlowEffect::setSpread ( const double  spread)
inline

Sets the spread distance for drawing the glow effect.

Parameters
spreadspread distance. Units are specified via setSpreadUnit
See also
spread
setSpreadUnit
setSpreadMapUnitScale

Definition at line 59 of file qgsgloweffect.h.

void QgsGlowEffect::setSpreadMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale used for the spread distance.

Parameters
scalemap unit scale for spread distance
See also
spreadMapUnitScale
setSpread
setSpreadUnit

Definition at line 91 of file qgsgloweffect.h.

void QgsGlowEffect::setSpreadUnit ( const QgsSymbolV2::OutputUnit  unit)
inline

Sets the units used for the glow spread distance.

Parameters
unitunits for spread distance
See also
spreadUnit
setSpread
setSpreadMapUnitScale

Definition at line 75 of file qgsgloweffect.h.

void QgsGlowEffect::setTransparency ( const double  transparency)
inline

Sets the transparency for the effect.

Parameters
transparencydouble between 0 and 1 inclusive, where 0 is fully opaque and 1 is fully transparent
See also
transparency

Definition at line 121 of file qgsgloweffect.h.

virtual bool QgsGlowEffect::shadeExterior ( ) const
protectedpure virtual

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

Implemented in QgsInnerGlowEffect, and QgsOuterGlowEffect.

double QgsGlowEffect::spread ( ) const
inline

Returns the spread distance used for drawing the glow effect.

Returns
spread distance. Units are retrieved via spreadUnit
See also
setSpread
spreadUnit
spreadMapUnitScale

Definition at line 67 of file qgsgloweffect.h.

const QgsMapUnitScale& QgsGlowEffect::spreadMapUnitScale ( ) const
inline

Returns the map unit scale used for the spread distance.

Returns
map unit scale for spread distance
See also
setSpreadMapUnitScale
spread
spreadUnit

Definition at line 99 of file qgsgloweffect.h.

QgsSymbolV2::OutputUnit QgsGlowEffect::spreadUnit ( ) const
inline

Returns the units used for the glow spread distance.

Returns
units for spread distance
See also
setSpreadUnit
spread
spreadMapUnitScale

Definition at line 83 of file qgsgloweffect.h.

double QgsGlowEffect::transparency ( ) const
inline

Returns the transparency for the effect.

Returns
transparency value between 0 and 1 inclusive, where 0 is fully opaque and 1 is fully transparent
See also
setTransparency

Definition at line 128 of file qgsgloweffect.h.

Member Data Documentation

QPainter::CompositionMode QgsGlowEffect::mBlendMode
protected

Definition at line 218 of file qgsgloweffect.h.

int QgsGlowEffect::mBlurLevel
protected

Definition at line 215 of file qgsgloweffect.h.

QColor QgsGlowEffect::mColor
protected

Definition at line 217 of file qgsgloweffect.h.

GlowColorType QgsGlowEffect::mColorType
protected

Definition at line 219 of file qgsgloweffect.h.

QgsVectorColorRampV2* QgsGlowEffect::mRamp
protected

Definition at line 214 of file qgsgloweffect.h.

double QgsGlowEffect::mSpread
protected

Definition at line 211 of file qgsgloweffect.h.

QgsMapUnitScale QgsGlowEffect::mSpreadMapUnitScale
protected

Definition at line 213 of file qgsgloweffect.h.

QgsSymbolV2::OutputUnit QgsGlowEffect::mSpreadUnit
protected

Definition at line 212 of file qgsgloweffect.h.

double QgsGlowEffect::mTransparency
protected

Definition at line 216 of file qgsgloweffect.h.


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