Skip to content
Permalink
Browse files
Complete documentation for QgsPointPatternFillSymbolLayer
  • Loading branch information
nyalldawson committed Oct 22, 2021
1 parent e976479 commit 999213f97e2a9140bfeaca8c641680ef90d3a9e5
Showing with 399 additions and 134 deletions.
  1. +215 −69 python/core/auto_generated/symbology/qgsfillsymbollayer.sip.in
  2. +184 −65 src/core/symbology/qgsfillsymbollayer.h
@@ -1760,6 +1760,9 @@ Returns the map unit scale for the pattern's line offset.

class QgsPointPatternFillSymbolLayer: QgsImageFillSymbolLayer
{
%Docstring(signature="appended")
A fill symbol layer which fills polygon shapes with repeating marker symbols.
%End

%TypeHeaderCode
#include "qgsfillsymbollayer.h"
@@ -1778,94 +1781,72 @@ Caller takes ownership of the returned symbol layer.

virtual QString layerType() const;


virtual void startRender( QgsSymbolRenderContext &context );

virtual void stopRender( QgsSymbolRenderContext &context );

virtual void renderPolygon( const QPolygonF &points, const QVector<QPolygonF> *rings, QgsSymbolRenderContext &context );


virtual QVariantMap properties() const;


virtual QgsPointPatternFillSymbolLayer *clone() const /Factory/;


virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props ) const;


virtual double estimateMaxBleed( const QgsRenderContext &context ) const;

virtual bool setSubSymbol( QgsSymbol *symbol /Transfer/ );

double distanceX() const;
void setDistanceX( double d );

double distanceY() const;
void setDistanceY( double d );

double displacementX() const;
void setDisplacementX( double d );
virtual QgsSymbol *subSymbol();

double displacementY() const;
void setDisplacementY( double d );
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );

void setOffsetX( double offset );
%Docstring
Sets the horizontal offset values for points in the pattern.
virtual QgsUnitTypes::RenderUnit outputUnit() const;

:param offset: offset value
virtual bool usesMapUnits() const;

.. seealso:: :py:func:`offsetX`
virtual void setMapUnitScale( const QgsMapUnitScale &scale );

.. seealso:: :py:func:`setOffsetY`
virtual QgsMapUnitScale mapUnitScale() const;

.. versionadded:: 3.8
%End
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;

double offsetX() const;
%Docstring
Returns the horizontal offset values for points in the pattern.
virtual bool hasDataDefinedProperties() const;

.. seealso:: :py:func:`setOffsetX`
virtual void setColor( const QColor &c );

.. seealso:: :py:func:`offsetY`
virtual QColor color() const;

.. versionadded:: 3.8
%End

void setOffsetY( double offset );
double distanceX() const;
%Docstring
Sets the vertical offset values for points in the pattern.
Returns the horizontal distance between rendered markers in the fill.

:param offset: offset value
Units are retrieved via :py:func:`~QgsPointPatternFillSymbolLayer.distanceXUnit`.

.. seealso:: :py:func:`offsetY`
.. seealso:: :py:func:`setDistanceX`

.. seealso:: :py:func:`setOffsetX`
.. seealso:: :py:func:`distanceXUnit`

.. versionadded:: 3.8
.. seealso:: :py:func:`distanceXMapUnitScale`
%End

double offsetY() const;
void setDistanceX( double d );
%Docstring
Returns the vertical offset values for points in the pattern.

.. seealso:: :py:func:`setOffsetY`
Sets the horizontal distance between rendered markers in the fill.

.. seealso:: :py:func:`offsetX`
Units are set via :py:func:`~QgsPointPatternFillSymbolLayer.setDistanceXUnit`.

.. versionadded:: 3.8
%End
.. seealso:: :py:func:`distanceX`

virtual bool setSubSymbol( QgsSymbol *symbol /Transfer/ );

virtual QgsSymbol *subSymbol();
.. seealso:: :py:func:`setDistanceXUnit`

.. seealso:: :py:func:`setDistanceXMapUnitScale`
%End

void setDistanceXUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for the horizontal distance between points in the pattern.
Sets the ``unit`` for the horizontal distance between points in the pattern.

:param unit: distance units

@@ -1884,11 +1865,52 @@ Returns the units for the horizontal distance between points in the pattern.
%End

void setDistanceXMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the horizontal distance between points in the pattern.

.. seealso:: :py:func:`distanceXMapUnitScale`

.. seealso:: :py:func:`setDistanceX`
%End

const QgsMapUnitScale &distanceXMapUnitScale() const;
%Docstring
Returns the map unit scale for the horizontal distance between points in the pattern.

.. seealso:: :py:func:`setDistanceXMapUnitScale`

.. seealso:: :py:func:`distanceX`
%End

double distanceY() const;
%Docstring
Returns the vertical distance between rendered markers in the fill.

Units are retrieved via :py:func:`~QgsPointPatternFillSymbolLayer.distanceYUnit`.

.. seealso:: :py:func:`setDistanceY`

.. seealso:: :py:func:`distanceYUnit`

.. seealso:: :py:func:`distanceYMapUnitScale`
%End

void setDistanceY( double d );
%Docstring
Sets the vertical distance between rendered markers in the fill.

Units are set via :py:func:`~QgsPointPatternFillSymbolLayer.setDistanceYUnit`.

.. seealso:: :py:func:`distanceY`

.. seealso:: :py:func:`setDistanceYUnit`

.. seealso:: :py:func:`setDistanceYMapUnitScale`
%End

void setDistanceYUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for the vertical distance between points in the pattern.
Sets the ``unit`` for the vertical distance between points in the pattern.

:param unit: distance units

@@ -1907,7 +1929,48 @@ Returns the units for the vertical distance between points in the pattern.
%End

void setDistanceYMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the vertical distance between points in the pattern.

.. seealso:: :py:func:`distanceYMapUnitScale`

.. seealso:: :py:func:`setDistanceY`
%End

const QgsMapUnitScale &distanceYMapUnitScale() const;
%Docstring
Returns the map unit scale for the vertical distance between points in the pattern.

.. seealso:: :py:func:`setDistanceYMapUnitScale`

.. seealso:: :py:func:`distanceY`
%End

double displacementX() const;
%Docstring
Returns the horizontal displacement for odd numbered rows in the pattern.

Units are retrieved via :py:func:`~QgsPointPatternFillSymbolLayer.displacementXUnit`.

.. seealso:: :py:func:`setDisplacementX`

.. seealso:: :py:func:`displacementXUnit`

.. seealso:: :py:func:`displacementXMapUnitScale`
%End

void setDisplacementX( double d );
%Docstring
Sets the horizontal displacement for odd numbered rows in the pattern.

Units are set via :py:func:`~QgsPointPatternFillSymbolLayer.setDisplacementXUnit`.

.. seealso:: :py:func:`displacementX`

.. seealso:: :py:func:`setDisplacementXUnit`

.. seealso:: :py:func:`setDisplacementXMapUnitScale`
%End

void setDisplacementXUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
@@ -1930,7 +1993,48 @@ Returns the units for the horizontal displacement between rows in the pattern.
%End

void setDisplacementXMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the horizontal displacement between odd numbered rows in the pattern.

.. seealso:: :py:func:`displacementXMapUnitScale`

.. seealso:: :py:func:`setDisplacementX`
%End

const QgsMapUnitScale &displacementXMapUnitScale() const;
%Docstring
Returns the map unit scale for the horizontal displacement between odd numbered rows in the pattern.

.. seealso:: :py:func:`setDisplacementXMapUnitScale`

.. seealso:: :py:func:`displacementX`
%End

double displacementY() const;
%Docstring
Returns the vertical displacement for odd numbered columns in the pattern.

Units are retrieved via :py:func:`~QgsPointPatternFillSymbolLayer.displacementYUnit`.

.. seealso:: :py:func:`setDisplacementY`

.. seealso:: :py:func:`displacementYUnit`

.. seealso:: :py:func:`displacementYMapUnitScale`
%End

void setDisplacementY( double d );
%Docstring
Sets the vertical displacement for odd numbered columns in the pattern.

Units are set via :py:func:`~QgsPointPatternFillSymbolLayer.setDisplacementYUnit`.

.. seealso:: :py:func:`displacementY`

.. seealso:: :py:func:`setDisplacementYUnit`

.. seealso:: :py:func:`setDisplacementYMapUnitScale`
%End

void setDisplacementYUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
@@ -1953,7 +2057,70 @@ Returns the units for the vertical displacement between rows in the pattern.
%End

void setDisplacementYMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the vertical displacement between odd numbered columns in the pattern.

.. seealso:: :py:func:`displacementYMapUnitScale`

.. seealso:: :py:func:`setDisplacementY`
%End

const QgsMapUnitScale &displacementYMapUnitScale() const;
%Docstring
Returns the map unit scale for the vertical displacement between odd numbered columns in the pattern.

.. seealso:: :py:func:`setDisplacementYMapUnitScale`

.. seealso:: :py:func:`displacementY`
%End

void setOffsetX( double offset );
%Docstring
Sets the horizontal offset values for points in the pattern.

:param offset: offset value

.. seealso:: :py:func:`offsetX`

.. seealso:: :py:func:`setOffsetY`

.. versionadded:: 3.8
%End

double offsetX() const;
%Docstring
Returns the horizontal offset values for points in the pattern.

.. seealso:: :py:func:`setOffsetX`

.. seealso:: :py:func:`offsetY`

.. versionadded:: 3.8
%End

void setOffsetY( double offset );
%Docstring
Sets the vertical offset values for points in the pattern.

:param offset: offset value

.. seealso:: :py:func:`offsetY`

.. seealso:: :py:func:`setOffsetX`

.. versionadded:: 3.8
%End

double offsetY() const;
%Docstring
Returns the vertical offset values for points in the pattern.

.. seealso:: :py:func:`setOffsetY`

.. seealso:: :py:func:`offsetX`

.. versionadded:: 3.8
%End

void setOffsetXUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
@@ -2051,27 +2218,6 @@ Returns the unit scale for the vertical offset between rows in the pattern.
.. versionadded:: 3.8
%End

virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );

virtual QgsUnitTypes::RenderUnit outputUnit() const;

virtual bool usesMapUnits() const;


virtual void setMapUnitScale( const QgsMapUnitScale &scale );

virtual QgsMapUnitScale mapUnitScale() const;


virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;

virtual bool hasDataDefinedProperties() const;

virtual void setColor( const QColor &c );

virtual QColor color() const;


protected:

virtual void applyDataDefinedSettings( QgsSymbolRenderContext &context );

0 comments on commit 999213f

Please sign in to comment.