QGIS API Documentation 3.41.0-Master (45a0abf3bec)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsDrawSourceEffect Class Reference

A paint effect which draws the source picture with minor or no alterations. More...

#include <qgspainteffect.h>

Inheritance diagram for QgsDrawSourceEffect:
Inheritance graph
[legend]

Public Member Functions

 QgsDrawSourceEffect ()=default
 
QPainter::CompositionMode blendMode () const
 Returns the blend mode for the effect.
 
QgsDrawSourceEffectclone () const override
 Duplicates an effect by creating a deep copy of the effect.
 
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 setOpacity (const double opacity)
 Sets the opacity for the effect.
 
QString type () const override
 Returns the effect type.
 
- 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 QgsPaintEffectcreate (const QVariantMap &map)
 Creates a new QgsDrawSource effect from a properties string map.
 

Protected Member Functions

void draw (QgsRenderContext &context) override
 Handles drawing of the effect's result on to the specified render context.
 
- Protected Member Functions inherited from QgsPaintEffect
virtual QRectF boundingRect (const QRectF &rect, const QgsRenderContext &context) const
 Returns the bounding rect required for drawing the effect.
 
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 QgsPaintEffect
DrawMode mDrawMode = ModifyAndRender
 
bool mEnabled = true
 
bool requiresQPainterDpiFix = true
 

Detailed Description

A paint effect which draws the source picture with minor or no alterations.

The draw source effect can be used to draw an unaltered copy of the original source picture. Minor changes like lowering the opacity and applying a blend mode are supported, however these changes will force the resultant output to be rasterized. If no alterations are performed then the original picture will be rendered as a vector.

Definition at line 324 of file qgspainteffect.h.

Constructor & Destructor Documentation

◆ QgsDrawSourceEffect()

QgsDrawSourceEffect::QgsDrawSourceEffect ( )
default

Member Function Documentation

◆ blendMode()

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

Returns the blend mode for the effect.

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

Definition at line 372 of file qgspainteffect.h.

◆ clone()

QgsDrawSourceEffect * QgsDrawSourceEffect::clone ( ) const
overridevirtual

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

Returns
clone of paint effect

Implements QgsPaintEffect.

Definition at line 223 of file qgspainteffect.cpp.

◆ create()

QgsPaintEffect * QgsDrawSourceEffect::create ( const QVariantMap &  map)
static

Creates a new QgsDrawSource effect from a properties string map.

Parameters
mapencoded properties string map
Returns
new QgsDrawSourceEffect

Definition at line 193 of file qgspainteffect.cpp.

◆ draw()

void QgsDrawSourceEffect::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 200 of file qgspainteffect.cpp.

◆ opacity()

double QgsDrawSourceEffect::opacity ( ) const
inline

Returns the opacity for the effect.

Returns
opacity value between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque
See also
setOpacity()

Definition at line 356 of file qgspainteffect.h.

◆ properties()

QVariantMap QgsDrawSourceEffect::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 228 of file qgspainteffect.cpp.

◆ readProperties()

void QgsDrawSourceEffect::readProperties ( const QVariantMap &  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 238 of file qgspainteffect.cpp.

◆ setBlendMode()

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

Sets the blend mode for the effect.

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

Definition at line 364 of file qgspainteffect.h.

◆ setOpacity()

void QgsDrawSourceEffect::setOpacity ( const double  opacity)
inline

Sets the opacity for the effect.

Parameters
opacitydouble between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque
See also
opacity()

Definition at line 348 of file qgspainteffect.h.

◆ type()

QString QgsDrawSourceEffect::type ( ) const
inlineoverridevirtual

Returns the effect type.

Returns
unique string representation of the effect type

Implements QgsPaintEffect.

Definition at line 337 of file qgspainteffect.h.


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