Class: QgsShadowEffect¶
Base class for paint effects which render offset, blurred shadows.
Note
This is an abstract class, with methods which must be implemented by a subclass.
The following methods must be implemented: QgsPaintEffect.clone(), exteriorShadow(), QgsPaintEffect.type()
Class Hierarchy¶
Base classes¶
Base class for visual effects which can be applied to QPicture drawings. |
Subclasses¶
A paint effect which draws an offset and optionally blurred drop shadow. |
|
A paint effect which draws an offset and optionally blurred drop shadow within a picture. |
Abstract Methods
Specifies whether the shadow is drawn outside the picture or within the picture. |
Methods
Returns the blend mode for the effect |
|
Returns the blur level (radius) for the shadow. |
|
Returns the map unit scale used for the shadow blur strength (radius). |
|
Returns the units used for the shadow blur level (radius). |
|
Returns the color used for the shadow. |
|
Returns the angle used for offsetting the shadow. |
|
Returns the distance used for offsetting the shadow. |
|
Returns the map unit scale used for the shadow offset distance. |
|
Returns the units used for the shadow offset distance. |
|
Returns the opacity for the effect. |
|
Sets the blend mode for the effect |
|
Sets blur level (radius) for the shadow. |
|
Sets the map unit scale used for the shadow blur strength (radius). |
|
Sets the units used for the shadow blur level (radius). |
|
Sets the color for the shadow. |
|
Sets the angle for offsetting the shadow. |
|
Sets the distance for offsetting the shadow. |
|
Sets the map unit scale used for the shadow offset distance. |
|
Sets the units used for the shadow offset distance. |
|
Sets the opacity for the effect. |
- class qgis.core.QgsShadowEffect[source]¶
Bases:
QgsPaintEffect- blendMode(self) QPainter.CompositionMode[source]¶
Returns the blend mode for the effect
- Return type:
QPainter.CompositionMode
- Returns:
blend mode used for drawing the effect on to a destination paint device
See also
- blurLevel(self) float[source]¶
Returns the blur level (radius) for the shadow.
- Return type:
float
- Returns:
blur level. values indicating greater blur strength.
See also
See also
See also
- blurMapUnitScale(self) QgsMapUnitScale¶
Returns the map unit scale used for the shadow blur strength (radius).
- Return type:
- Returns:
map unit scale for blur strength
See also
See also
See also
Added in version 3.4.9.
- blurUnit(self) Qgis.RenderUnit[source]¶
Returns the units used for the shadow blur level (radius).
- Return type:
- Returns:
units for blur level
See also
See also
See also
Added in version 3.4.9.
- color(self) QColor[source]¶
Returns the color used for the shadow.
- Return type:
QColor
- Returns:
shadow color
See also
- abstract exteriorShadow(self) bool[source]¶
Specifies whether the shadow is drawn outside the picture or within the picture.
- Return type:
bool
- Returns:
Trueif shadow is to be drawn outside the picture, orFalseto draw shadow within the picture
- offsetAngle(self) int[source]¶
Returns the angle used for offsetting the shadow.
- Return type:
int
- Returns:
offset angle in degrees clockwise from North
See also
See also
- offsetDistance(self) float[source]¶
Returns the distance used for offsetting the shadow.
- Return type:
float
- Returns:
offset distance. Distance units are retrieved via
offsetUnit()
See also
See also
See also
- offsetMapUnitScale(self) QgsMapUnitScale¶
Returns the map unit scale used for the shadow offset distance.
- Return type:
- Returns:
map unit scale for offset distance
See also
See also
See also
- offsetUnit(self) Qgis.RenderUnit[source]¶
Returns the units used for the shadow offset distance.
- Return type:
- Returns:
units for offset distance
See also
See also
See also
- opacity(self) float[source]¶
Returns the opacity for the effect.
- Return type:
float
- Returns:
opacity value between 0 and 1 inclusive, where 0 is fully transparent and 1 is fully opaque
See also
- setBlendMode(self, mode: QPainter.CompositionMode)[source]¶
Sets the blend mode for the effect
- Parameters:
mode (QPainter.CompositionMode) – blend mode used for drawing the effect on to a destination paint device
See also
- setBlurLevel(self, level: float)[source]¶
Sets blur level (radius) for the shadow.
- Parameters:
level (float) – blur level. values indicating greater blur strength.
See also
See also
See also
- setBlurMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
Sets the map unit scale used for the shadow blur strength (radius).
- Parameters:
scale (QgsMapUnitScale) – map unit scale for blur strength
See also
See also
See also
Added in version 3.4.9.
- setBlurUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the units used for the shadow blur level (radius).
- Parameters:
unit (Qgis.RenderUnit) – units for blur level
See also
See also
See also
Added in version 3.4.9.
- setColor(self, color: QColor | Qt.GlobalColor)[source]¶
Sets the color for the shadow.
- Parameters:
color (Union[QColor, Qt.GlobalColor]) – shadow color
See also
- setOffsetAngle(self, angle: int)[source]¶
Sets the angle for offsetting the shadow.
- Parameters:
angle (int) – offset angle in degrees clockwise from North
See also
See also
- setOffsetDistance(self, distance: float)[source]¶
Sets the distance for offsetting the shadow.
- Parameters:
distance (float) – offset distance. Units are specified via
setOffsetUnit()
See also
See also
See also
- setOffsetMapUnitScale(self, scale: QgsMapUnitScale)[source]¶
Sets the map unit scale used for the shadow offset distance.
- Parameters:
scale (QgsMapUnitScale) – map unit scale for offset distance
See also
See also
See also
- setOffsetUnit(self, unit: Qgis.RenderUnit)[source]¶
Sets the units used for the shadow offset distance.
- Parameters:
unit (Qgis.RenderUnit) – units for offset distance
See also
See also
See also