Class: QgsTransformEffect

class qgis.core.QgsTransformEffect

Bases: qgis._core.QgsPaintEffect

Constructor for QgsTransformEffect.

QgsTransformEffect(QgsTransformEffect)

A paint effect which applies transformations (such as move, scale and rotate) to a picture.

New in version 2.9: Enums

Methods

boundingRect
clone
create Creates a new QgsTransformEffect effect from a properties string map.
draw
drawSource
fixQPictureDpi
imageOffset
properties
readProperties
reflectX Returns whether transform will be reflected along the x-axis
reflectY Returns whether transform will be reflected along the y-axis
rotation Returns the transform rotation, in degrees clockwise.
scaleX Returns the x axis scaling factor.
scaleY Returns the y axis scaling factor.
setReflectX Sets whether to reflect along the x-axis
setReflectY Sets whether to reflect along the y-axis
setRotation Sets the transform rotation, in degrees clockwise.
setScaleX Sets the x axis scaling factor.
setScaleY Sets the y axis scaling factor.
setShearX Sets the x axis shearing factor.
setShearY Sets the y axis shearing factor.
setTranslateMapUnitScale Sets the map unit scale used for the transform translation.
setTranslateUnit Sets the units used for the transform translation.
setTranslateX Sets the transform x translation.
setTranslateY Sets the transform y translation.
shearX Returns the x axis shearing factor.
shearY Returns the y axis shearing factor.
source
sourceAsImage
translateMapUnitScale Returns the map unit scale used for the transform translation.
translateUnit Returns the units used for the transform translation.
translateX Returns the transform x translation.
translateY Returns the transform y translation.
type

Signals

Attributes

boundingRect(self, rect: QRectF, context: QgsRenderContext) → QRectF
clone(self) → QgsTransformEffect
create(map: Dict[str, str]) → QgsPaintEffect

Creates a new QgsTransformEffect effect from a properties string map.

Parameters:map – encoded properties string map
Returns:new QgsTransformEffect
draw(self, context: QgsRenderContext)
drawSource()
fixQPictureDpi()
imageOffset()
properties(self) → Dict[str, str]
readProperties(self, props: Dict[str, str])
reflectX(self) → bool

Returns whether transform will be reflected along the x-axis

Returns:True if transform will reflect horizontally

See also

setReflectX()

See also

reflectY()

reflectY(self) → bool

Returns whether transform will be reflected along the y-axis

Returns:True if transform will reflect horizontally

See also

setReflectY()

See also

reflectX()

rotation(self) → float

Returns the transform rotation, in degrees clockwise.

See also

setRotation()

scaleX(self) → float

Returns the x axis scaling factor.

Returns:x axis scaling factor, where 1.0 = no scaling

See also

setScaleX()

See also

scaleY()

scaleY(self) → float

Returns the y axis scaling factor.

Returns:y axis scaling factor, where 1.0 = no scaling

See also

setScaleY()

See also

scaleX()

setReflectX(self, reflectX: bool)

Sets whether to reflect along the x-axis

Parameters:reflectXTrue to reflect horizontally

See also

reflectX()

See also

setReflectY()

setReflectY(self, reflectY: bool)

Sets whether to reflect along the y-axis

Parameters:reflectYTrue to reflect horizontally

See also

reflectY()

See also

setReflectX()

setRotation(self, rotation: float)

Sets the transform rotation, in degrees clockwise.

See also

rotation()

setScaleX(self, scaleX: float)

Sets the x axis scaling factor.

Parameters:scaleX – factor to scale x axis by, where 1.0 = no scaling

See also

scaleX()

See also

setScaleY()

setScaleY(self, scaleY: float)

Sets the y axis scaling factor.

Parameters:scaleY – factor to scale y axis by, where 1.0 = no scaling

See also

scaleX()

setShearX(self, shearX: float)

Sets the x axis shearing factor.

Parameters:shearX – x axis shearing

See also

shearX()

See also

setShearY()

setShearY(self, shearY: float)

Sets the y axis shearing factor.

Parameters:shearY – y axis shearing

See also

shearY()

See also

setShearX()

setTranslateMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale used for the transform translation.

Parameters:scale – map unit scale for translation

See also

setTranslateX()

See also

setTranslateY()

setTranslateUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units used for the transform translation.

Parameters:unit – units for translation

See also

translateUnit()

See also

setTranslateX()

See also

setTranslateY()

setTranslateX(self, translateX: float)

Sets the transform x translation.

Parameters:translateX – distance to translate along the x axis

See also

translateX()

See also

setTranslateY()

setTranslateY(self, translateY: float)

Sets the transform y translation.

Parameters:translateY – distance to translate along the y axis

See also

translateY()

See also

setTranslateX()

shearX(self) → float

Returns the x axis shearing factor.

Returns:x axis shearing

See also

setShearX()

See also

shearY()

shearY(self) → float

Returns the y axis shearing factor.

Returns:y axis shearing

See also

setShearY()

See also

shearX()

source()
sourceAsImage()
translateMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale used for the transform translation.

Returns:map unit scale for translation

See also

translateX()

See also

translateY()

See also

translateUnit()

translateUnit(self) → QgsUnitTypes.RenderUnit

Returns the units used for the transform translation.

Returns:units for translation

See also

translateX()

See also

translateY()

translateX(self) → float

Returns the transform x translation.

Returns:X distance translated along the x axis

See also

setTranslateX()

See also

translateY()

See also

translateUnit()

translateY(self) → float

Returns the transform y translation.

Returns:Y distance translated along the y axis

See also

setTranslateY()

See also

translateX()

See also

translateUnit()

type(self) → str