mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
217 lines
5.1 KiB
Plaintext
217 lines
5.1 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/effects/qgsblureffect.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsBlurEffect : QgsPaintEffect /NoDefaultCtors/
|
|
{
|
|
%Docstring(signature="appended")
|
|
A paint effect which blurs a source picture, using a number of different blur
|
|
methods.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsblureffect.h"
|
|
%End
|
|
public:
|
|
|
|
enum BlurMethod
|
|
{
|
|
StackBlur,
|
|
GaussianBlur
|
|
};
|
|
|
|
static QgsPaintEffect *create( const QVariantMap &map ) /Factory/;
|
|
%Docstring
|
|
Creates a new QgsBlurEffect effect from a properties string map.
|
|
|
|
:param map: encoded properties string map
|
|
|
|
:return: new QgsBlurEffect
|
|
%End
|
|
|
|
QgsBlurEffect();
|
|
|
|
virtual QString type() const;
|
|
virtual QVariantMap properties() const;
|
|
|
|
virtual void readProperties( const QVariantMap &props );
|
|
|
|
virtual QgsBlurEffect *clone() const /Factory/;
|
|
|
|
|
|
void setBlurLevel( const double level );
|
|
%Docstring
|
|
Sets blur level (radius)
|
|
|
|
:param level: blur level. Depending on the current :py:func:`~QgsBlurEffect.blurMethod`, this parameter
|
|
has different effects
|
|
|
|
.. seealso:: :py:func:`blurLevel`
|
|
|
|
.. seealso:: :py:func:`setBlurUnit`
|
|
|
|
.. seealso:: :py:func:`setBlurMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`setBlurMethod`
|
|
%End
|
|
|
|
double blurLevel() const;
|
|
%Docstring
|
|
Returns the blur level (radius)
|
|
|
|
:return: blur level. Depending on the current :py:func:`~QgsBlurEffect.blurMethod`, this parameter
|
|
has different effects
|
|
|
|
.. seealso:: :py:func:`setBlurLevel`
|
|
|
|
.. seealso:: :py:func:`blurUnit`
|
|
|
|
.. seealso:: :py:func:`blurMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`blurMethod`
|
|
%End
|
|
|
|
void setBlurUnit( const Qgis::RenderUnit unit );
|
|
%Docstring
|
|
Sets the units used for the blur level (radius).
|
|
|
|
:param unit: units for blur level
|
|
|
|
.. seealso:: :py:func:`blurUnit`
|
|
|
|
.. seealso:: :py:func:`setBlurLevel`
|
|
|
|
.. seealso:: :py:func:`setBlurMapUnitScale`
|
|
|
|
.. versionadded:: 3.4.9
|
|
%End
|
|
|
|
Qgis::RenderUnit blurUnit() const;
|
|
%Docstring
|
|
Returns the units used for the blur level (radius).
|
|
|
|
:return: units for blur level
|
|
|
|
.. seealso:: :py:func:`setBlurUnit`
|
|
|
|
.. seealso:: :py:func:`blurLevel`
|
|
|
|
.. seealso:: :py:func:`blurMapUnitScale`
|
|
|
|
.. versionadded:: 3.4.9
|
|
%End
|
|
|
|
void setBlurMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Sets the map unit scale used for the blur strength (radius).
|
|
|
|
:param scale: map unit scale for blur strength
|
|
|
|
.. seealso:: :py:func:`blurMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`setBlurLevel`
|
|
|
|
.. seealso:: :py:func:`setBlurUnit`
|
|
|
|
.. versionadded:: 3.4.9
|
|
%End
|
|
|
|
const QgsMapUnitScale &blurMapUnitScale() const;
|
|
%Docstring
|
|
Returns the map unit scale used for the blur strength (radius).
|
|
|
|
:return: map unit scale for blur strength
|
|
|
|
.. seealso:: :py:func:`setBlurMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`blurLevel`
|
|
|
|
.. seealso:: :py:func:`blurUnit`
|
|
|
|
.. versionadded:: 3.4.9
|
|
%End
|
|
|
|
void setBlurMethod( const BlurMethod method );
|
|
%Docstring
|
|
Sets the blur method (algorithm) to use for performing the blur.
|
|
|
|
:param method: blur method
|
|
|
|
.. seealso:: :py:func:`blurMethod`
|
|
%End
|
|
|
|
BlurMethod blurMethod() const;
|
|
%Docstring
|
|
Returns the blur method (algorithm) used for performing the blur.
|
|
|
|
:return: blur method
|
|
|
|
.. seealso:: :py:func:`setBlurMethod`
|
|
%End
|
|
|
|
void setOpacity( const double opacity );
|
|
%Docstring
|
|
Sets the ``opacity`` for the effect.
|
|
|
|
:param opacity: double between 0 and 1 inclusive, where 0 is fully transparent
|
|
and 1 is fully opaque
|
|
|
|
.. seealso:: :py:func:`opacity`
|
|
%End
|
|
|
|
double opacity() const;
|
|
%Docstring
|
|
Returns the opacity for the effect.
|
|
|
|
:return: opacity value between 0 and 1 inclusive, where 0 is fully transparent
|
|
and 1 is fully opaque
|
|
|
|
.. seealso:: :py:func:`setOpacity`
|
|
%End
|
|
|
|
void setBlendMode( const QPainter::CompositionMode mode );
|
|
%Docstring
|
|
Sets the blend mode for the effect
|
|
|
|
:param mode: blend mode used for drawing the effect on to a destination
|
|
paint device
|
|
|
|
.. seealso:: :py:func:`blendMode`
|
|
%End
|
|
|
|
QPainter::CompositionMode blendMode() const;
|
|
%Docstring
|
|
Returns the blend mode for the effect
|
|
|
|
:return: blend mode used for drawing the effect on to a destination
|
|
paint device
|
|
|
|
.. seealso:: :py:func:`setBlendMode`
|
|
%End
|
|
|
|
protected:
|
|
|
|
virtual void draw( QgsRenderContext &context );
|
|
|
|
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
|
|
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/effects/qgsblureffect.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|