sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-28 00:17:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Dox++

Browse Source
This commit is contained in:
Nyall Dawson 2019-03-20 07:17:54 +10:00
parent e0a990d997
commit fa202795b0
4 changed files with 402 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

226
python/core/auto_generated/symbology/qgslinesymbollayer.sip.in
View File

@ -13,78 +13,143 @@
class QgsSimpleLineSymbolLayer : QgsLineSymbolLayer
{
%Docstring
A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed).
%End
%TypeHeaderCode
#include "qgslinesymbollayer.h"
%End
public:
QgsSimpleLineSymbolLayer( const QColor &color = DEFAULT_SIMPLELINE_COLOR,
double width = DEFAULT_SIMPLELINE_WIDTH,
Qt::PenStyle penStyle = DEFAULT_SIMPLELINE_PENSTYLE );
%Docstring
Constructor for QgsSimpleLineSymbolLayer. Creates a simple line
symbol in the specified ``color``, ``width`` (in millimeters)
and ``penStyle``.
%End
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
%Docstring
Creates a new QgsSimpleLineSymbolLayer, using the settings
serialized in the ``properties`` map (corresponding to the output from
QgsSimpleLineSymbolLayer.properties() ).
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
%Docstring
Creates a new QgsSimpleLineSymbolLayer from an SLD XML DOM ``element``.
%End
virtual QString layerType() const;
virtual void startRender( QgsSymbolRenderContext &context );
virtual void stopRender( QgsSymbolRenderContext &context );
virtual void renderPolyline( const QPolygonF &points, QgsSymbolRenderContext &context );
virtual void renderPolygonStroke( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context );
virtual QgsStringMap properties() const;
virtual QgsSimpleLineSymbolLayer *clone() const /Factory/;
virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const;
virtual QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const;
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
virtual QgsUnitTypes::RenderUnit outputUnit() const;
virtual void setMapUnitScale( const QgsMapUnitScale &scale );
virtual QgsMapUnitScale mapUnitScale() const;
virtual double estimateMaxBleed( const QgsRenderContext &context ) const;
virtual QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const;
virtual Qt::PenStyle dxfPenStyle() const;
virtual double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
virtual double dxfOffset( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
virtual QColor dxfColor( QgsSymbolRenderContext &context ) const;
Qt::PenStyle penStyle() const;
%Docstring
Returns the pen style used to render the line (e.g. solid, dashed, etc).
.. seealso:: :py:func:`setPenStyle`
%End
void setPenStyle( Qt::PenStyle style );
%Docstring
Sets the pen ``style`` used to render the line (e.g. solid, dashed, etc).
.. seealso:: :py:func:`penStyle`
%End
Qt::PenJoinStyle penJoinStyle() const;
%Docstring
Returns the pen join style used to render the line (e.g. miter, bevel, round, etc).
.. seealso:: :py:func:`setPenJoinStyle`
%End
void setPenJoinStyle( Qt::PenJoinStyle style );
%Docstring
Sets the pen join ``style`` used to render the line (e.g. miter, bevel, round, etc).
.. seealso:: :py:func:`penJoinStyle`
%End
Qt::PenCapStyle penCapStyle() const;
%Docstring
Returns the pen cap style used to render the line (e.g. flat, square, round, etc).
.. seealso:: :py:func:`setPenCapStyle`
%End
void setPenCapStyle( Qt::PenCapStyle style );
%Docstring
Sets the pen cap ``style`` used to render the line (e.g. flat, square, round, etc).
.. seealso:: :py:func:`penCapStyle`
%End
bool useCustomDashPattern() const;
%Docstring
Returns ``True`` if the line uses a custom dash pattern.
.. seealso:: :py:func:`setUseCustomDashPattern`
.. seealso:: :py:func:`customDashPatternUnit`
.. seealso:: :py:func:`customDashVector`
%End
void setUseCustomDashPattern( bool b );
%Docstring
Sets whether the line uses a custom dash pattern.
.. seealso:: :py:func:`useCustomDashPattern`
.. seealso:: :py:func:`setCustomDashPatternUnit`
.. seealso:: :py:func:`setCustomDashVector`
%End
void setCustomDashPatternUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for lengths used in the custom dash pattern.
:param unit: length units
Sets the ``unit`` for lengths used in the custom dash pattern.
.. seealso:: :py:func:`customDashPatternUnit`
%End
@ -97,10 +162,50 @@ Returns the units for lengths used in the custom dash pattern.
%End
const QgsMapUnitScale &customDashPatternMapUnitScale() const;
%Docstring
Returns the map unit scale for lengths used in the custom dash pattern.
.. seealso:: :py:func:`setCustomDashPatternMapUnitScale`
%End
void setCustomDashPatternMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for lengths used in the custom dash pattern.
.. seealso:: :py:func:`customDashPatternMapUnitScale`
%End
QVector<qreal> customDashVector() const;
%Docstring
Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths
used while rendering a custom dash pattern.
Units for the vector are specified by customDashPatternUnit()
This setting is only used when useCustomDashPattern() returns ``True``.
.. seealso:: :py:func:`setCustomDashVector`
.. seealso:: :py:func:`customDashPatternUnit`
.. seealso:: :py:func:`useCustomDashPattern`
%End
void setCustomDashVector( const QVector<qreal> &vector );
%Docstring
Sets the custom dash ``vector``, which is the pattern of alternating drawn/skipped lengths
used while rendering a custom dash pattern.
Units for the vector are specified by customDashPatternUnit()
This setting is only used when useCustomDashPattern() returns ``True``.
.. seealso:: :py:func:`customDashVector`
.. seealso:: :py:func:`setCustomDashPatternUnit`
.. seealso:: :py:func:`setUseCustomDashPattern`
%End
bool drawInsidePolygon() const;
%Docstring
@ -124,36 +229,30 @@ used to render polygon rings.
.. seealso:: :py:func:`drawInsidePolygon`
%End
virtual QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const;
virtual Qt::PenStyle dxfPenStyle() const;
virtual double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
virtual double dxfOffset( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const;
virtual QColor dxfColor( QgsSymbolRenderContext &context ) const;
protected:
};
class QgsMarkerLineSymbolLayer : QgsLineSymbolLayer
{
%Docstring
Line symbol layer type which draws repeating marker symbols along a line feature.
%End
%TypeHeaderCode
#include "qgslinesymbollayer.h"
%End
public:
QgsMarkerLineSymbolLayer( bool rotateMarker = DEFAULT_MARKERLINE_ROTATE,
double interval = DEFAULT_MARKERLINE_INTERVAL );
%Docstring
Constructor for QgsMarkerLineSymbolLayer. Creates a marker line
with a default marker symbol, placed at the specified ``interval`` (in millimeters).
The ``rotateMarker`` argument specifies whether individual marker symbols
should be rotated to match the line segment alignment.
%End
enum Placement
{
@ -162,26 +261,20 @@ class QgsMarkerLineSymbolLayer : QgsLineSymbolLayer
LastVertex,
FirstVertex,
CentralPoint,
CurvePoint
CurvePoint,
};
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
%Docstring
Create a new MarkerLineSymbolLayerV2
:param properties: A property map to deserialize saved information from properties()
:return: A new MarkerLineSymbolLayerV2
Creates a new QgsMarkerLineSymbolLayer, using the settings
serialized in the ``properties`` map (corresponding to the output from
QgsMarkerLineSymbolLayer.properties() ).
%End
static QgsSymbolLayer *createFromSld( QDomElement &element ) /Factory/;
%Docstring
Create a new MarkerLineSymbolLayerV2 from SLD
:param element: An SLD XML DOM element
:return: A new MarkerLineSymbolLayerV2
Creates a new QgsMarkerLineSymbolLayer from an SLD XML DOM ``element``.
%End
@ -232,14 +325,16 @@ Create a new MarkerLineSymbolLayerV2 from SLD
bool rotateMarker() const;
%Docstring
Shall the marker be rotated.
Returns ``True`` if the repeating symbols will be rotated to match their line segment orientation.
:return: ``True`` if the marker should be rotated.
.. seealso:: :py:func:`setRotateMarker`
%End
void setRotateMarker( bool rotate );
%Docstring
Shall the marker be rotated.
Sets whether the repeating symbols should be rotated to match their line segment orientation.
.. seealso:: :py:func:`rotateMarker`
%End
double interval() const;
@ -264,12 +359,16 @@ Sets the interval between individual markers.
Placement placement() const;
%Docstring
The placement of the markers.
Returns the placement of the symbols.
.. seealso:: :py:func:`setPlacement`
%End
void setPlacement( Placement p );
%Docstring
The placement of the markers.
Sets the ``placement`` of the symbols.
.. seealso:: :py:func:`placement`
%End
double offsetAlongLine() const;
@ -333,21 +432,21 @@ Sets the unit used for calculating the offset along line for markers.
const QgsMapUnitScale &offsetAlongLineMapUnitScale() const;
%Docstring
Returns the map unit scale used for calculating the offset in map units along line for markers.
Returns the map unit scale used for calculating the offset in map units along line for symbols.
:return: Offset along line map unit scale.
.. seealso:: :py:func:`setOffsetAlongLineMapUnitScale`
%End
void setOffsetAlongLineMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale used for calculating the offset in map units along line for markers.
Sets the map unit ``scale`` used for calculating the offset in map units along line for symbols.
:param scale: Offset along line map unit scale.
.. seealso:: :py:func:`offsetAlongLineMapUnitScale`
%End
void setIntervalUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for the interval between markers.
Sets the units for the interval between symbols.
:param unit: interval units
@ -358,7 +457,7 @@ Sets the units for the interval between markers.
QgsUnitTypes::RenderUnit intervalUnit() const;
%Docstring
Returns the units for the interval between markers.
Returns the units for the interval between symbols.
.. seealso:: :py:func:`setIntervalUnit`
@ -366,7 +465,26 @@ Returns the units for the interval between markers.
%End
void setIntervalMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for the interval between symbols.
.. seealso:: :py:func:`intervalMapUnitScale`
.. seealso:: :py:func:`setIntervalUnit`
.. seealso:: :py:func:`setInterval`
%End
const QgsMapUnitScale &intervalMapUnitScale() const;
%Docstring
Returns the map unit scale for the interval between symbols.
.. seealso:: :py:func:`setIntervalMapUnitScale`
.. seealso:: :py:func:`intervalUnit`
.. seealso:: :py:func:`interval`
%End
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );

40
python/core/auto_generated/symbology/qgssymbol.sip.in
View File

@ -897,6 +897,18 @@ Returns data defined size for whole symbol (including all symbol layers).
ScaleMethod scaleMethod();
void renderPoint( QPointF point, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false );
%Docstring
Renders the symbol at the specified ``point``, using the given render ``context``.
The ``f`` argument is used to pass the feature currently being rendered (when available).
If only a single symbol layer from the symbol should be rendered, it should be specified
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.
If ``selected`` is true then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End
QRectF bounds( QPointF point, QgsRenderContext &context, const QgsFeature &feature = QgsFeature() ) const;
%Docstring
@ -1002,6 +1014,18 @@ Returns data defined width for whole symbol (including all symbol layers).
%End
void renderPolyline( const QPolygonF &points, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false );
%Docstring
Renders the symbol along the line joining ``points``, using the given render ``context``.
The ``f`` argument is used to pass the feature currently being rendered (when available).
If only a single symbol layer from the symbol should be rendered, it should be specified
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.
If ``selected`` is true then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End
virtual QgsLineSymbol *clone() const /Factory/;
@ -1034,7 +1058,23 @@ Constructor for QgsFillSymbol, with the specified list of initial symbol ``layer
Ownership of the ``layers`` are transferred to the symbol.
%End
void setAngle( double angle );
void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false );
%Docstring
Renders the symbol using the given render ``context``.
The ``points`` list dictates the exterior ring for the polygon to render, and
interior rings are optionally specified via the ``rings`` argument.
The ``f`` argument is used to pass the feature currently being rendered (when available).
If only a single symbol layer from the symbol should be rendered, it should be specified
in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be
rendered.
If ``selected`` is true then the symbol will be drawn using the "selected feature"
style and colors instead of the symbol's normal style.
%End
virtual QgsFillSymbol *clone() const /Factory/;

205
src/core/symbology/qgslinesymbollayer.h
View File

@ -34,65 +34,116 @@ class QgsExpression;
/**
* \ingroup core
* \class QgsSimpleLineSymbolLayer
* A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed).
*/
class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
{
public:
/**
* Constructor for QgsSimpleLineSymbolLayer. Creates a simple line
* symbol in the specified \a color, \a width (in millimeters)
* and \a penStyle.
*/
QgsSimpleLineSymbolLayer( const QColor &color = DEFAULT_SIMPLELINE_COLOR,
double width = DEFAULT_SIMPLELINE_WIDTH,
Qt::PenStyle penStyle = DEFAULT_SIMPLELINE_PENSTYLE );
// static stuff
/**
* Creates a new QgsSimpleLineSymbolLayer, using the settings
* serialized in the \a properties map (corresponding to the output from
* QgsSimpleLineSymbolLayer::properties() ).
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
/**
* Creates a new QgsSimpleLineSymbolLayer from an SLD XML DOM \a element.
*/
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
// implemented from base classes
QString layerType() const override;
void startRender( QgsSymbolRenderContext &context ) override;
void stopRender( QgsSymbolRenderContext &context ) override;
void renderPolyline( const QPolygonF &points, QgsSymbolRenderContext &context ) override;
//overridden so that clip path can be set when using draw inside polygon option
void renderPolygonStroke( const QPolygonF &points, QList<QPolygonF> *rings, QgsSymbolRenderContext &context ) override;
QgsStringMap properties() const override;
QgsSimpleLineSymbolLayer *clone() const override SIP_FACTORY;
void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const override;
QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const override;
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;
QgsUnitTypes::RenderUnit outputUnit() const override;
void setMapUnitScale( const QgsMapUnitScale &scale ) override;
QgsMapUnitScale mapUnitScale() const override;
double estimateMaxBleed( const QgsRenderContext &context ) const override;
QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const override;
Qt::PenStyle dxfPenStyle() const override;
double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
double dxfOffset( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
QColor dxfColor( QgsSymbolRenderContext &context ) const override;
// new stuff
/**
* Returns the pen style used to render the line (e.g. solid, dashed, etc).
*
* \see setPenStyle()
*/
Qt::PenStyle penStyle() const { return mPenStyle; }
/**
* Sets the pen \a style used to render the line (e.g. solid, dashed, etc).
*
* \see penStyle()
*/
void setPenStyle( Qt::PenStyle style ) { mPenStyle = style; }
/**
* Returns the pen join style used to render the line (e.g. miter, bevel, round, etc).
*
* \see setPenJoinStyle()
*/
Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; }
/**
* Sets the pen join \a style used to render the line (e.g. miter, bevel, round, etc).
*
* \see penJoinStyle()
*/
void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; }
/**
* Returns the pen cap style used to render the line (e.g. flat, square, round, etc).
*
* \see setPenCapStyle()
*/
Qt::PenCapStyle penCapStyle() const { return mPenCapStyle; }
/**
* Sets the pen cap \a style used to render the line (e.g. flat, square, round, etc).
*
* \see penCapStyle()
*/
void setPenCapStyle( Qt::PenCapStyle style ) { mPenCapStyle = style; }
/**
* Returns TRUE if the line uses a custom dash pattern.
* \see setUseCustomDashPattern()
* \see customDashPatternUnit()
* \see customDashVector()
*/
bool useCustomDashPattern() const { return mUseCustomDashPattern; }
/**
* Sets whether the line uses a custom dash pattern.
* \see useCustomDashPattern()
* \see setCustomDashPatternUnit()
* \see setCustomDashVector()
*/
void setUseCustomDashPattern( bool b ) { mUseCustomDashPattern = b; }
/**
* Sets the units for lengths used in the custom dash pattern.
* \param unit length units
* Sets the \a unit for lengths used in the custom dash pattern.
* \see customDashPatternUnit()
*/
void setCustomDashPatternUnit( QgsUnitTypes::RenderUnit unit ) { mCustomDashPatternUnit = unit; }
@ -103,10 +154,44 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
*/
QgsUnitTypes::RenderUnit customDashPatternUnit() const { return mCustomDashPatternUnit; }
/**
* Returns the map unit scale for lengths used in the custom dash pattern.
* \see setCustomDashPatternMapUnitScale()
*/
const QgsMapUnitScale &customDashPatternMapUnitScale() const { return mCustomDashPatternMapUnitScale; }
/**
* Sets the map unit \a scale for lengths used in the custom dash pattern.
* \see customDashPatternMapUnitScale()
*/
void setCustomDashPatternMapUnitScale( const QgsMapUnitScale &scale ) { mCustomDashPatternMapUnitScale = scale; }
/**
* Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths
* used while rendering a custom dash pattern.
*
* Units for the vector are specified by customDashPatternUnit()
*
* This setting is only used when useCustomDashPattern() returns TRUE.
*
* \see setCustomDashVector()
* \see customDashPatternUnit()
* \see useCustomDashPattern()
*/
QVector<qreal> customDashVector() const { return mCustomDashVector; }
/**
* Sets the custom dash \a vector, which is the pattern of alternating drawn/skipped lengths
* used while rendering a custom dash pattern.
*
* Units for the vector are specified by customDashPatternUnit()
*
* This setting is only used when useCustomDashPattern() returns TRUE.
*
* \see customDashVector()
* \see setCustomDashPatternUnit()
* \see setUseCustomDashPattern()
*/
void setCustomDashVector( const QVector<qreal> &vector ) { mCustomDashVector = vector; }
/**
@ -131,21 +216,14 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
*/
void setDrawInsidePolygon( bool drawInsidePolygon ) { mDrawInsidePolygon = drawInsidePolygon; }
QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit &unit ) const override;
Qt::PenStyle dxfPenStyle() const override;
private:
double dxfWidth( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
double dxfOffset( const QgsDxfExport &e, QgsSymbolRenderContext &context ) const override;
QColor dxfColor( QgsSymbolRenderContext &context ) const override;
protected:
Qt::PenStyle mPenStyle;
Qt::PenStyle mPenStyle = Qt::SolidLine;
Qt::PenJoinStyle mPenJoinStyle = DEFAULT_SIMPLELINE_JOINSTYLE;
Qt::PenCapStyle mPenCapStyle = DEFAULT_SIMPLELINE_CAPSTYLE;
QPen mPen;
QPen mSelPen;
//use a custom dash dot pattern instead of the predefined ones
bool mUseCustomDashPattern = false;
QgsUnitTypes::RenderUnit mCustomDashPatternUnit = QgsUnitTypes::RenderMillimeters;
QgsMapUnitScale mCustomDashPatternMapUnitScale;
@ -155,7 +233,6 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
bool mDrawInsidePolygon = false;
private:
//helper functions for data defined symbology
void applyDataDefinedSymbology( QgsSymbolRenderContext &context, QPen &pen, QPen &selPen, double &offset );
};
@ -168,10 +245,19 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer
/**
* \ingroup core
* \class QgsMarkerLineSymbolLayer
* Line symbol layer type which draws repeating marker symbols along a line feature.
*/
class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer
{
public:
/**
* Constructor for QgsMarkerLineSymbolLayer. Creates a marker line
* with a default marker symbol, placed at the specified \a interval (in millimeters).
*
* The \a rotateMarker argument specifies whether individual marker symbols
* should be rotated to match the line segment alignment.
*/
QgsMarkerLineSymbolLayer( bool rotateMarker = DEFAULT_MARKERLINE_ROTATE,
double interval = DEFAULT_MARKERLINE_INTERVAL );
@ -180,31 +266,25 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer
*/
enum Placement
{
Interval,
Vertex,
LastVertex,
FirstVertex,
CentralPoint,
CurvePoint
Interval, //!< Place symbols at regular intervals
Vertex, //!< Place symbols on every vertex in the line
LastVertex, //!< Place symbols on the last vertex in the line
FirstVertex, //!< Place symbols on the first vertex in the line
CentralPoint, //!< Place symbols at the mid point of the line
CurvePoint, //!< Place symbols at every virtual curve point in the line (used when rendering curved geometry types only)
};
// static stuff
/**
* Create a new MarkerLineSymbolLayerV2
*
* \param properties A property map to deserialize saved information from properties()
*
* \returns A new MarkerLineSymbolLayerV2
* Creates a new QgsMarkerLineSymbolLayer, using the settings
* serialized in the \a properties map (corresponding to the output from
* QgsMarkerLineSymbolLayer::properties() ).
*/
static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY;
/**
* Create a new MarkerLineSymbolLayerV2 from SLD
*
* \param element An SLD XML DOM element
*
* \returns A new MarkerLineSymbolLayerV2
* Creates a new QgsMarkerLineSymbolLayer from an SLD XML DOM \a element.
*/
static QgsSymbolLayer *createFromSld( QDomElement &element ) SIP_FACTORY;
@ -241,14 +321,14 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer
// new stuff
/**
* Shall the marker be rotated.
*
* \returns TRUE if the marker should be rotated.
* Returns TRUE if the repeating symbols will be rotated to match their line segment orientation.
* \see setRotateMarker()
*/
bool rotateMarker() const { return mRotateMarker; }
/**
* Shall the marker be rotated.
* Sets whether the repeating symbols should be rotated to match their line segment orientation.
* \see rotateMarker()
*/
void setRotateMarker( bool rotate ) { mRotateMarker = rotate; }
@ -268,12 +348,14 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer
void setInterval( double interval ) { mInterval = interval; }
/**
* The placement of the markers.
* Returns the placement of the symbols.
* \see setPlacement()
*/
Placement placement() const { return mPlacement; }
/**
* The placement of the markers.
* Sets the \a placement of the symbols.
* \see placement()
*/
void setPlacement( Placement p ) { mPlacement = p; }
@ -321,19 +403,19 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer
void setOffsetAlongLineUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetAlongLineUnit = unit; }
/**
* Returns the map unit scale used for calculating the offset in map units along line for markers.
* \returns Offset along line map unit scale.
* Returns the map unit scale used for calculating the offset in map units along line for symbols.
* \see setOffsetAlongLineMapUnitScale()
*/
const QgsMapUnitScale &offsetAlongLineMapUnitScale() const { return mOffsetAlongLineMapUnitScale; }
/**
* Sets the map unit scale used for calculating the offset in map units along line for markers.
* \param scale Offset along line map unit scale.
* Sets the map unit \a scale used for calculating the offset in map units along line for symbols.
* \see offsetAlongLineMapUnitScale()
*/
void setOffsetAlongLineMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetAlongLineMapUnitScale = scale; }
/**
* Sets the units for the interval between markers.
* Sets the units for the interval between symbols.
* \param unit interval units
* \see intervalUnit()
* \see setInterval()
@ -341,13 +423,26 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer
void setIntervalUnit( QgsUnitTypes::RenderUnit unit ) { mIntervalUnit = unit; }
/**
* Returns the units for the interval between markers.
* Returns the units for the interval between symbols.
* \see setIntervalUnit()
* \see interval()
*/
QgsUnitTypes::RenderUnit intervalUnit() const { return mIntervalUnit; }
/**
* Sets the map unit \a scale for the interval between symbols.
* \see intervalMapUnitScale()
* \see setIntervalUnit()
* \see setInterval()
*/
void setIntervalMapUnitScale( const QgsMapUnitScale &scale ) { mIntervalMapUnitScale = scale; }
/**
* Returns the map unit scale for the interval between symbols.
* \see setIntervalMapUnitScale()
* \see intervalUnit()
* \see interval()
*/
const QgsMapUnitScale &intervalMapUnitScale() const { return mIntervalMapUnitScale; }
void setOutputUnit( QgsUnitTypes::RenderUnit unit ) override;

40
src/core/symbology/qgssymbol.h
View File

@ -887,6 +887,18 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol
void setScaleMethod( QgsSymbol::ScaleMethod scaleMethod );
ScaleMethod scaleMethod();
/**
* Renders the symbol at the specified \a point, using the given render \a context.
*
* The \a f argument is used to pass the feature currently being rendered (when available).
*
* If only a single symbol layer from the symbol should be rendered, it should be specified
* in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be
* rendered.
*
* If \a selected is true then the symbol will be drawn using the "selected feature"
* style and colors instead of the symbol's normal style.
*/
void renderPoint( QPointF point, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false );
/**
@ -983,6 +995,18 @@ class CORE_EXPORT QgsLineSymbol : public QgsSymbol
*/
QgsProperty dataDefinedWidth() const;
/**
* Renders the symbol along the line joining \a points, using the given render \a context.
*
* The \a f argument is used to pass the feature currently being rendered (when available).
*
* If only a single symbol layer from the symbol should be rendered, it should be specified
* in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be
* rendered.
*
* If \a selected is true then the symbol will be drawn using the "selected feature"
* style and colors instead of the symbol's normal style.
*/
void renderPolyline( const QPolygonF &points, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false );
QgsLineSymbol *clone() const override SIP_FACTORY;
@ -1017,6 +1041,22 @@ class CORE_EXPORT QgsFillSymbol : public QgsSymbol
*/
QgsFillSymbol( const QgsSymbolLayerList &layers SIP_TRANSFER = QgsSymbolLayerList() );
void setAngle( double angle );
/**
* Renders the symbol using the given render \a context.
*
* The \a points list dictates the exterior ring for the polygon to render, and
* interior rings are optionally specified via the \a rings argument.
*
* The \a f argument is used to pass the feature currently being rendered (when available).
*
* If only a single symbol layer from the symbol should be rendered, it should be specified
* in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be
* rendered.
*
* If \a selected is true then the symbol will be drawn using the "selected feature"
* style and colors instead of the symbol's normal style.
*/
void renderPolygon( const QPolygonF &points, QList<QPolygonF> *rings, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false );
QgsFillSymbol *clone() const override SIP_FACTORY;