QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsInnerGlowEffect Class Reference

A paint effect which draws a glow within a picture. More...

#include <qgsgloweffect.h>

Inheritance diagram for QgsInnerGlowEffect:
Inheritance graph
[legend]

Public Member Functions

 QgsInnerGlowEffect ()
 
virtual ~QgsInnerGlowEffect ()
 
virtual QgsInnerGlowEffectclone () const override
 Duplicates an effect by creating a deep copy of the effect. More...
 
virtual QString type () const override
 Returns the effect type. More...
 
- Public Member Functions inherited from QgsGlowEffect
 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...
 
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...
 

Static Public Member Functions

static QgsPaintEffectcreate (const QgsStringMap &map)
 Creates a new QgsInnerGlowEffect effect from a properties string map. More...
 

Protected Member Functions

virtual bool shadeExterior () const override
 Specifies whether the glow is drawn outside the picture or within the picture. More...
 
- Protected Member Functions inherited from QgsGlowEffect
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...
 
- 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...
 

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

A paint effect which draws a glow within a picture.

Note
Added in version 2.9

Definition at line 262 of file qgsgloweffect.h.

Constructor & Destructor Documentation

QgsInnerGlowEffect::QgsInnerGlowEffect ( )

Definition at line 249 of file qgsgloweffect.cpp.

QgsInnerGlowEffect::~QgsInnerGlowEffect ( )
virtual

Definition at line 255 of file qgsgloweffect.cpp.

Member Function Documentation

QgsInnerGlowEffect * QgsInnerGlowEffect::clone ( ) const
overridevirtual

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

Returns
clone of paint effect

Implements QgsPaintEffect.

Definition at line 267 of file qgsgloweffect.cpp.

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

Creates a new QgsInnerGlowEffect effect from a properties string map.

Parameters
mapencoded properties string map
Returns
new QgsInnerGlowEffect

Definition at line 260 of file qgsgloweffect.cpp.

virtual bool QgsInnerGlowEffect::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 281 of file qgsgloweffect.h.

virtual QString QgsInnerGlowEffect::type ( ) const
inlineoverridevirtual

Returns the effect type.

Returns
unique string representation of the effect type

Implements QgsPaintEffect.

Definition at line 276 of file qgsgloweffect.h.


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