QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
A paint effect which alters the colors (e.g., brightness, contrast) in a source picture. More...
#include <qgscoloreffect.h>
Public Member Functions | |
QgsColorEffect () | |
QPainter::CompositionMode | blendMode () const |
Returns the blend mode for the effect. More... | |
int | brightness () const |
Returns the brightness modification for the effect. More... | |
QgsColorEffect * | clone () const override |
Duplicates an effect by creating a deep copy of the effect. More... | |
QColor | colorizeColor () const |
Returns the color used for colorizing a picture. More... | |
bool | colorizeOn () const |
Returns whether the effect will colorize a picture. More... | |
int | colorizeStrength () const |
Returns the strength used for colorizing a picture. More... | |
int | contrast () const |
Returns the contrast modification for the effect. More... | |
QgsImageOperation::GrayscaleMode | grayscaleMode () const |
Returns whether the effect will convert a picture to grayscale. More... | |
double | opacity () const |
Returns the opacity for the effect. More... | |
QgsStringMap | properties () const override |
Returns the properties describing the paint effect encoded in a string format. More... | |
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... | |
double | saturation () const |
Returns the saturation modification for the effect. More... | |
void | setBlendMode (const QPainter::CompositionMode mode) |
Sets the blend mode for the effect. More... | |
void | setBrightness (int brightness) |
Sets the brightness modification for the effect. More... | |
void | setColorizeColor (const QColor &colorizeColor) |
Sets the color used for colorizing a picture. More... | |
void | setColorizeOn (bool colorizeOn) |
Sets whether the effect should colorize a picture. More... | |
void | setColorizeStrength (int colorizeStrength) |
Sets the strength for colorizing a picture. More... | |
void | setContrast (int contrast) |
Sets the contrast modification for the effect. More... | |
void | setGrayscaleMode (QgsImageOperation::GrayscaleMode grayscaleMode) |
Sets whether the effect should convert a picture to grayscale. More... | |
void | setOpacity (const double opacity) |
Sets the opacity for the effect. More... | |
void | setSaturation (double saturation) |
Sets the saturation modification for the effect. More... | |
QString | type () const override |
Returns the effect type. More... | |
![]() | |
QgsPaintEffect ()=default | |
Constructor for QgsPaintEffect. More... | |
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 (DrawMode drawMode) |
Sets the draw mode for the effect. More... | |
void | setEnabled (bool enabled) |
Sets whether the effect is enabled. More... | |
Static Public Member Functions | |
static QgsPaintEffect * | create (const QgsStringMap &map) |
Creates a new QgsColorEffect effect from a properties string map. More... | |
Protected Member Functions | |
void | draw (QgsRenderContext &context) override |
Handles drawing of the effect's result on to the specified render context. More... | |
![]() | |
virtual QRectF | boundingRect (const QRectF &rect, const QgsRenderContext &context) const |
Returns the bounding rect required for drawing the effect. More... | |
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 QPicture * | source () const |
Returns the source QPicture. More... | |
QImage * | sourceAsImage (QgsRenderContext &context) |
Returns the source QPicture rendered to a new QImage. More... | |
Additional Inherited Members | |
![]() | |
enum | DrawMode { Modifier, Render, ModifyAndRender } |
Drawing modes for effects. More... | |
![]() | |
DrawMode | mDrawMode = ModifyAndRender |
bool | mEnabled = true |
bool | requiresQPainterDpiFix = true |
A paint effect which alters the colors (e.g., brightness, contrast) in a source picture.
Definition at line 35 of file qgscoloreffect.h.
QgsColorEffect::QgsColorEffect | ( | ) |
Definition at line 29 of file qgscoloreffect.cpp.
|
inline |
Returns the blend mode for the effect.
Definition at line 210 of file qgscoloreffect.h.
|
inline |
Returns the brightness modification for the effect.
Definition at line 70 of file qgscoloreffect.h.
|
overridevirtual |
Duplicates an effect by creating a deep copy of the effect.
Implements QgsPaintEffect.
Definition at line 117 of file qgscoloreffect.cpp.
|
inline |
Returns the color used for colorizing a picture.
This is only used if colorizeOn() is set to true
.
Definition at line 158 of file qgscoloreffect.h.
|
inline |
Returns whether the effect will colorize a picture.
true
if colorization is enabled Definition at line 138 of file qgscoloreffect.h.
|
inline |
Returns the strength used for colorizing a picture.
This is only used if setColorizeOn() is set to true
.
Definition at line 178 of file qgscoloreffect.h.
|
inline |
Returns the contrast modification for the effect.
Definition at line 88 of file qgscoloreffect.h.
|
static |
Creates a new QgsColorEffect effect from a properties string map.
map | encoded properties string map |
Definition at line 22 of file qgscoloreffect.cpp.
|
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.
context | destination render context |
Implements QgsPaintEffect.
Definition at line 35 of file qgscoloreffect.cpp.
|
inline |
Returns whether the effect will convert a picture to grayscale.
Definition at line 120 of file qgscoloreffect.h.
|
inline |
Returns the opacity for the effect.
Definition at line 194 of file qgscoloreffect.h.
|
overridevirtual |
Returns the properties describing the paint effect encoded in a string format.
Implements QgsPaintEffect.
Definition at line 60 of file qgscoloreffect.cpp.
|
overridevirtual |
Reads a string map of an effect's properties and restores the effect to the state described by the properties map.
props | effect properties encoded in a string map |
Implements QgsPaintEffect.
Definition at line 78 of file qgscoloreffect.cpp.
|
inline |
Returns the saturation modification for the effect.
Definition at line 106 of file qgscoloreffect.h.
|
inline |
Sets the blend mode for the effect.
mode | blend mode used for drawing the effect on to a destination paint device |
Definition at line 202 of file qgscoloreffect.h.
|
inline |
Sets the brightness modification for the effect.
brightness | Valid values are between -255 and 255, where 0 represents no change, negative values indicate darkening and positive values indicate lightening |
Definition at line 61 of file qgscoloreffect.h.
void QgsColorEffect::setColorizeColor | ( | const QColor & | colorizeColor | ) |
Sets the color used for colorizing a picture.
This is only used if setColorizeOn() is set to true
.
colorizeColor | colorization color |
Definition at line 123 of file qgscoloreffect.cpp.
|
inline |
Sets whether the effect should colorize a picture.
colorizeOn | set to true to enable colorization |
Definition at line 129 of file qgscoloreffect.h.
|
inline |
Sets the strength for colorizing a picture.
This is only used if setColorizeOn() is set to true
.
colorizeStrength | colorization strength, between 0 and 100 |
Definition at line 168 of file qgscoloreffect.h.
|
inline |
Sets the contrast modification for the effect.
contrast | Valid values are between -100 and 100, where 0 represents no change, negative values indicate less contrast and positive values indicate greater contrast |
Definition at line 79 of file qgscoloreffect.h.
|
inline |
Sets whether the effect should convert a picture to grayscale.
grayscaleMode | method for grayscale conversion |
Definition at line 113 of file qgscoloreffect.h.
|
inline |
Sets the opacity for the effect.
opacity | double between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque |
Definition at line 186 of file qgscoloreffect.h.
|
inline |
Sets the saturation modification for the effect.
saturation | Valid values are between 0 and 2.0, where 1.0 represents no change, 0.0 represents totally desaturated (grayscale), and positive values indicate greater saturation |
Definition at line 97 of file qgscoloreffect.h.
|
inlineoverridevirtual |
Returns the effect type.
Implements QgsPaintEffect.
Definition at line 49 of file qgscoloreffect.h.