QGIS API Documentation  2.17.0-Master (8784312)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
QgsSimpleMarkerSymbolLayerV2 Class Reference

Simple marker symbol layer, consisting of a rendered shape with solid fill color and an outline. More...

#include <qgsmarkersymbollayerv2.h>

Inheritance diagram for QgsSimpleMarkerSymbolLayerV2:
Inheritance graph
[legend]

Public Member Functions

Q_DECL_DEPRECATED QgsSimpleMarkerSymbolLayerV2 (const QString &name, const QColor &color=DEFAULT_SIMPLEMARKER_COLOR, const QColor &borderColor=DEFAULT_SIMPLEMARKER_BORDERCOLOR, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, QgsSymbolV2::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD, Qt::PenJoinStyle penJoinStyle=DEFAULT_SIMPLEMARKER_JOINSTYLE)
 Constructor for QgsSimpleMarkerSymbolLayerV2. More...
 
 QgsSimpleMarkerSymbolLayerV2 (Shape shape=Circle, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, QgsSymbolV2::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD, const QColor &color=DEFAULT_SIMPLEMARKER_COLOR, const QColor &borderColor=DEFAULT_SIMPLEMARKER_BORDERCOLOR, Qt::PenJoinStyle penJoinStyle=DEFAULT_SIMPLEMARKER_JOINSTYLE)
 Constructor for QgsSimpleMarkerSymbolLayerV2. More...
 
QColor borderColor () const
 Returns the marker's border color. More...
 
QRectF bounds (QPointF point, QgsSymbolV2RenderContext &context) override
 Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. More...
 
QgsSimpleMarkerSymbolLayerV2clone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const override
 The fill color. More...
 
QColor fillColor () const override
 Get fill color. More...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
Q_DECL_DEPRECATED QString name () const
 
QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override
 
QColor outlineColor () const override
 Get outline color. More...
 
Qt::PenStyle outlineStyle () const
 Returns the marker's outline style (eg solid, dashed, etc) More...
 
double outlineWidth () const
 Returns the width of the marker's outline. More...
 
const QgsMapUnitScaleoutlineWidthMapUnitScale () const
 Returns the map scale for the width of the marker's outline. More...
 
QgsSymbolV2::OutputUnit outlineWidthUnit () const
 Returns the unit for the width of the marker's outline. More...
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
Qt::PenJoinStyle penJoinStyle () const
 Returns the marker's outline join style (eg miter, bevel, etc). More...
 
QgsStringMap properties () const override
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
void renderPoint (QPointF point, QgsSymbolV2RenderContext &context) override
 Renders a marker at the specified point. More...
 
void setBorderColor (const QColor &color)
 Sets the marker's border color. More...
 
void setColor (const QColor &color) override
 The fill color. More...
 
void setFillColor (const QColor &color) override
 Set fill color. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
Q_DECL_DEPRECATED void setName (const QString &name)
 
void setOutlineColor (const QColor &color) override
 Set outline color. More...
 
void setOutlineStyle (Qt::PenStyle outlineStyle)
 Sets the marker's outline style (eg solid, dashed, etc) More...
 
void setOutlineWidth (double w)
 Sets the width of the marker's outline. More...
 
void setOutlineWidthMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map scale for the width of the marker's outline. More...
 
void setOutlineWidthUnit (QgsSymbolV2::OutputUnit u)
 Sets the unit for the width of the marker's outline. More...
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
void setPenJoinStyle (Qt::PenJoinStyle style)
 Sets the marker's outline join style (eg miter, bevel, etc). More...
 
void startRender (QgsSymbolV2RenderContext &context) override
 
bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolV2RenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override
 write as DXF More...
 
void writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 Writes the symbol layer definition as a SLD XML element. More...
 
- Public Member Functions inherited from QgsSimpleMarkerSymbolLayerBase
 QgsSimpleMarkerSymbolLayerBase (Shape shape=Circle, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, QgsSymbolV2::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD)
 Constructor for QgsSimpleMarkerSymbolLayerBase. More...
 
void setShape (Shape shape)
 Sets the rendered marker shape. More...
 
Shape shape () const
 Returns the shape for the rendered marker symbol. More...
 
void stopRender (QgsSymbolV2RenderContext &context) override
 
- Public Member Functions inherited from QgsMarkerSymbolLayerV2
double angle () const
 Returns the rotation angle for the marker, in degrees clockwise from north. More...
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
HorizontalAnchorPoint horizontalAnchorPoint () const
 Returns the horizontal anchor point for positioning the symbol. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QPointF offset () const
 Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the symbol's offset. More...
 
QgsSymbolV2::OutputUnit offsetUnit () const
 Returns the units for the symbol's offset. More...
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
QgsSymbolV2::ScaleMethod scaleMethod () const
 Returns the method to use for scaling the marker's size. More...
 
void setAngle (double angle)
 Sets the rotation angle for the marker. More...
 
void setHorizontalAnchorPoint (HorizontalAnchorPoint h)
 Sets the horizontal anchor point for positioning the symbol. More...
 
void setLineAngle (double lineAngle)
 Sets the line angle modification for the symbol's angle. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOffset (QPointF offset)
 Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the symbol's offset. More...
 
void setOffsetUnit (QgsSymbolV2::OutputUnit unit)
 Sets the units for the symbol's offset. More...
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
void setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
 Sets the method to use for scaling the marker's size. More...
 
void setSize (double size)
 Sets the symbol size. More...
 
void setSizeMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the symbol's size. More...
 
void setSizeUnit (QgsSymbolV2::OutputUnit unit)
 Sets the units for the symbol's size. More...
 
void setVerticalAnchorPoint (VerticalAnchorPoint v)
 Sets the vertical anchor point for positioning the symbol. More...
 
double size () const
 Returns the symbol size. More...
 
const QgsMapUnitScalesizeMapUnitScale () const
 Returns the map unit scale for the symbol's size. More...
 
QgsSymbolV2::OutputUnit sizeUnit () const
 Returns the units for the symbol's size. More...
 
void startRender (QgsSymbolV2RenderContext &context) override
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
VerticalAnchorPoint verticalAnchorPoint () const
 Returns the vertical anchor point for positioning the symbol. More...
 
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
 
virtual Q_DECL_DEPRECATED const QgsExpressiondataDefinedProperty (const QString &property) const
 Returns a data defined expression for a property, if set. More...
 
virtual Q_DECL_DEPRECATED QString dataDefinedPropertyString (const QString &property) const
 Returns a data defined expression for a property, if set. More...
 
virtual double dxfAngle (QgsSymbolV2RenderContext &context) const
 get angle More...
 
virtual QColor dxfBrushColor (QgsSymbolV2RenderContext &context) const
 get brush/fill color More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 get brush/fill style More...
 
virtual QColor dxfColor (QgsSymbolV2RenderContext &context) const
 get color More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const
 get dash pattern More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
 get offset More...
 
virtual Qt::PenStyle dxfPenStyle () const
 get pen style More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolV2RenderContext &context) const
 get line width More...
 
virtual double estimateMaxBleed () const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
virtual Q_DECL_DEPRECATED QVariant evaluateDataDefinedProperty (const QString &property, const QgsFeature *feature, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QVariant evaluateDataDefinedProperty (const QString &property, const QgsSymbolV2RenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QgsDataDefinedgetDataDefinedProperty (const QString &property) const
 Returns the data defined property corresponding to the specified property key. More...
 
virtual bool hasDataDefinedProperties () const
 Checks whether the layer has any associated data defined properties. More...
 
virtual bool hasDataDefinedProperty (const QString &property) const
 Checks whether the layer has a matching data defined property and if that property is currently actived. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbolV2 *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual void removeDataDefinedProperties ()
 Removes all data defined properties from the layer and deletes associated objects. More...
 
virtual void removeDataDefinedProperty (const QString &property)
 Removes a data defined property from the layer. More...
 
int renderingPass () const
 
virtual Q_DECL_DEPRECATED void setDataDefinedProperty (const QString &property, const QString &expressionString)
 Sets a data defined expression for a property. More...
 
virtual void setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
 Sets a data defined property for the layer. More...
 
void setLocked (bool locked)
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
virtual bool setSubSymbol (QgsSymbolV2 *symbol)
 set layer's subsymbol. takes ownership of the passed symbol More...
 
virtual QgsSymbolV2subSymbol ()
 
QgsSymbolV2::SymbolType type () const
 
virtual QSet< QStringusedAttributes () const
 Returns the set of attributes referenced by the layer. More...
 

Static Public Member Functions

static QgsSymbolLayerV2create (const QgsStringMap &properties=QgsStringMap())
 Creates a new QgsSimpleMarkerSymbolLayerV2. More...
 
static QgsSymbolLayerV2createFromSld (QDomElement &element)
 Creates a new QgsSimpleMarkerSymbolLayerV2 from an SLD XML element. More...
 
- Static Public Member Functions inherited from QgsSimpleMarkerSymbolLayerBase
static QList< ShapeavailableShapes ()
 Returns a list of all available shape types. More...
 
static Shape decodeShape (const QString &name, bool *ok=nullptr)
 Attempts to decode a string representation of a shape name to the corresponding shape. More...
 
static QString encodeShape (Shape shape)
 Encodes a shape to its string representation. More...
 
static bool shapeIsFilled (Shape shape)
 Returns true if a symbol shape has a fill. More...
 

Protected Member Functions

void drawMarker (QPainter *p, QgsSymbolV2RenderContext &context)
 Draws the marker shape in the specified painter. More...
 
bool prepareCache (QgsSymbolV2RenderContext &context)
 Prepares cache image. More...
 
Q_DECL_DEPRECATED bool preparePath (QString name=QString())
 
Q_DECL_DEPRECATED bool prepareShape (const QString &name=QString())
 
Q_DECL_DEPRECATED bool prepareShape (const QString &name, QPolygonF &polygon) const
 
- Protected Member Functions inherited from QgsSimpleMarkerSymbolLayerBase
void calculateOffsetAndRotation (QgsSymbolV2RenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle) const
 Calculates the marker offset and rotation. More...
 
double calculateSize (QgsSymbolV2RenderContext &context, bool &hasDataDefinedSize) const
 Calculates the desired size of the marker, considering data defined size overrides. More...
 
bool prepareMarkerPath (Shape symbol)
 Prepares the layer for drawing the specified shape (QPainterPath version) More...
 
bool prepareMarkerShape (Shape shape)
 Prepares the layer for drawing the specified shape (QPolygonF version) More...
 
bool shapeToPolygon (Shape shape, QPolygonF &polygon) const
 Creates a polygon representing the specified shape. More...
 
- Protected Member Functions inherited from QgsMarkerSymbolLayerV2
 QgsMarkerSymbolLayerV2 (bool locked=false)
 Constructor for QgsMarkerSymbolLayerV2. More...
 
void markerOffset (QgsSymbolV2RenderContext &context, double &offsetX, double &offsetY) const
 Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More...
 
void markerOffset (QgsSymbolV2RenderContext &context, double width, double height, double &offsetX, double &offsetY) const
 Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More...
 
void markerOffset (QgsSymbolV2RenderContext &context, double width, double height, QgsSymbolV2::OutputUnit widthUnit, QgsSymbolV2::OutputUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const
 
- Protected Member Functions inherited from QgsSymbolLayerV2
 QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const
 Copies all data defined properties of this layer to another symbol layer. More...
 
void copyPaintEffect (QgsSymbolLayerV2 *destLayer) const
 Copies paint effect of this layer to another symbol layer. More...
 
virtual Q_DECL_DEPRECATED QgsExpressionexpression (const QString &property) const
 Returns the data defined expression associated with a property. More...
 
virtual Q_DECL_DEPRECATED void prepareExpressions (const QgsFields *fields, double scale=-1.0)
 Prepares all data defined property expressions for evaluation. More...
 
virtual void prepareExpressions (const QgsSymbolV2RenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
void restoreDataDefinedProperties (const QgsStringMap &stringMap)
 Restores all data defined properties from string map. More...
 
void saveDataDefinedProperties (QgsStringMap &stringMap) const
 Saves all data defined properties to a string map. More...
 

Protected Attributes

QColor mBorderColor
 Outline color. More...
 
QBrush mBrush
 QBrush corresponding to marker's fill style. More...
 
QImage mCache
 Cached image of marker, if using cached version. More...
 
QString mName
 
Qt::PenStyle mOutlineStyle
 Outline style. More...
 
double mOutlineWidth
 Outline width. More...
 
QgsMapUnitScale mOutlineWidthMapUnitScale
 Outline width map unit scale. More...
 
QgsSymbolV2::OutputUnit mOutlineWidthUnit
 Outline width units. More...
 
QPen mPen
 QPen corresponding to marker's outline style. More...
 
Qt::PenJoinStyle mPenJoinStyle
 Outline pen join style. More...
 
QBrush mSelBrush
 QBrush to use as fill of selected symbols. More...
 
QImage mSelCache
 Cached image of selected marker, if using cached version. More...
 
QPen mSelPen
 QPen to use as outline of selected symbols. More...
 
bool mUsingCache
 True if using cached images of markers for drawing. More...
 
- Protected Attributes inherited from QgsSimpleMarkerSymbolLayerBase
QPainterPath mPath
 Painter path representing shape. If mPolygon is empty then the shape is stored in mPath. More...
 
QPolygonF mPolygon
 Polygon of points in shape. If polygon is empty then shape is using mPath. More...
 
Shape mShape
 Symbol shape. More...
 
- Protected Attributes inherited from QgsMarkerSymbolLayerV2
double mAngle
 Marker rotation angle, in degrees clockwise from north. More...
 
HorizontalAnchorPoint mHorizontalAnchorPoint
 Horizontal anchor point. More...
 
double mLineAngle
 Line rotation angle (see setLineAngle() for details) More...
 
QPointF mOffset
 Marker offset. More...
 
QgsMapUnitScale mOffsetMapUnitScale
 Offset map unit scale. More...
 
QgsSymbolV2::OutputUnit mOffsetUnit
 Offset units. More...
 
QgsSymbolV2::ScaleMethod mScaleMethod
 Marker size scaling method. More...
 
double mSize
 Marker size. More...
 
QgsMapUnitScale mSizeMapUnitScale
 Marker size map unit scale. More...
 
QgsSymbolV2::OutputUnit mSizeUnit
 Marker size unit. More...
 
VerticalAnchorPoint mVerticalAnchorPoint
 Vertical anchor point. More...
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 

Static Protected Attributes

static const int mMaximumCacheWidth = 3000
 Maximum width/height of cache image. More...
 
- Static Protected Attributes inherited from QgsSymbolLayerV2
static const QString EXPR_ALPHA
 
static const QString EXPR_ANGLE
 
static const QString EXPR_BLUR_RADIUS
 
static const QString EXPR_BORDER_COLOR
 
static const QString EXPR_BORDER_STYLE
 
static const QString EXPR_CAPSTYLE
 
static const QString EXPR_CHAR
 
static const QString EXPR_COLOR
 
static const QString EXPR_COLOR2
 
static const QString EXPR_COLOR_BORDER
 
static const QString EXPR_COORDINATE_MODE
 
static const QString EXPR_CUSTOMDASH
 
static const QString EXPR_DISPLACEMENT_X
 
static const QString EXPR_DISPLACEMENT_Y
 
static const QString EXPR_DISTANCE
 
static const QString EXPR_DISTANCE_X
 
static const QString EXPR_DISTANCE_Y
 
static const QString EXPR_FILE
 
static const QString EXPR_FILL
 
static const QString EXPR_FILL_COLOR
 
static const QString EXPR_FILL_STYLE
 
static const QString EXPR_GRADIENT_TYPE
 
static const QString EXPR_HEIGHT
 
static const QString EXPR_HORIZONTAL_ANCHOR_POINT
 
static const QString EXPR_IGNORE_RINGS
 
static const QString EXPR_INTERVAL
 
static const QString EXPR_JOIN_STYLE
 
static const QString EXPR_JOINSTYLE
 
static const QString EXPR_LINE_STYLE
 
static const QString EXPR_LINEANGLE
 
static const QString EXPR_LINEWIDTH
 
static const QString EXPR_MAX_DISTANCE
 
static const QString EXPR_NAME
 
static const QString EXPR_OFFSET
 
static const QString EXPR_OFFSET_ALONG_LINE
 
static const QString EXPR_OUTLINE
 
static const QString EXPR_OUTLINE_COLOR
 
static const QString EXPR_OUTLINE_STYLE
 
static const QString EXPR_OUTLINE_WIDTH
 
static const QString EXPR_PLACEMENT
 
static const QString EXPR_REFERENCE1_ISCENTROID
 
static const QString EXPR_REFERENCE1_X
 
static const QString EXPR_REFERENCE1_Y
 
static const QString EXPR_REFERENCE2_ISCENTROID
 
static const QString EXPR_REFERENCE2_X
 
static const QString EXPR_REFERENCE2_Y
 
static const QString EXPR_ROTATION
 
static const QString EXPR_SIZE
 
static const QString EXPR_SPREAD
 
static const QString EXPR_SVG_FILE
 
static const QString EXPR_SVG_FILL_COLOR
 
static const QString EXPR_SVG_OUTLINE_COLOR
 
static const QString EXPR_SVG_OUTLINE_WIDTH
 
static const QString EXPR_SYMBOL_NAME
 
static const QString EXPR_USE_WHOLE_SHAPE
 
static const QString EXPR_VERTICAL_ANCHOR_POINT
 
static const QString EXPR_WIDTH
 
static const QString EXPR_WIDTH_BORDER
 
static const bool selectFillBorder = false
 
static const bool selectFillStyle = false
 
static const bool selectionIsOpaque = true
 

Additional Inherited Members

- Public Types inherited from QgsSimpleMarkerSymbolLayerBase
enum  Shape {
  Square, Diamond, Pentagon, Hexagon,
  Triangle, EquilateralTriangle, Star, Arrow,
  Circle, Cross, CrossFill, Cross2,
  Line, ArrowHead, ArrowHeadFilled, SemiCircle,
  ThirdCircle, QuarterCircle, QuarterSquare, HalfSquare,
  DiagonalHalfSquare, RightHalfTriangle, LeftHalfTriangle
}
 Marker symbol shapes. More...
 
- Public Types inherited from QgsMarkerSymbolLayerV2
enum  HorizontalAnchorPoint { Left, HCenter, Right }
 Symbol horizontal anchor points. More...
 
enum  VerticalAnchorPoint { Top, VCenter, Bottom }
 Symbol vertical anchor points. More...
 
- Static Protected Member Functions inherited from QgsMarkerSymbolLayerV2
static QPointF _rotatedOffset (QPointF offset, double angle)
 Adjusts a marker offset to account for rotation. More...
 

Detailed Description

Simple marker symbol layer, consisting of a rendered shape with solid fill color and an outline.

Definition at line 186 of file qgsmarkersymbollayerv2.h.

Constructor & Destructor Documentation

QgsSimpleMarkerSymbolLayerV2::QgsSimpleMarkerSymbolLayerV2 ( const QString name,
const QColor color = DEFAULT_SIMPLEMARKER_COLOR,
const QColor borderColor = DEFAULT_SIMPLEMARKER_BORDERCOLOR,
double  size = DEFAULT_SIMPLEMARKER_SIZE,
double  angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbolV2::ScaleMethod  scaleMethod = DEFAULT_SCALE_METHOD,
Qt::PenJoinStyle  penJoinStyle = DEFAULT_SIMPLEMARKER_JOINSTYLE 
)

Constructor for QgsSimpleMarkerSymbolLayerV2.

Parameters
namesymbol name, should be one of "square", "rectangle", "diamond", "pentagon", "hexagon", "triangle", "equilateral_triangle", "star", "arrow", "circle", "cross", "cross_fill", "cross2", "line", "x", "arrowhead", "filled_arrowhead", "semi_circle", "third_circle", "quarter_circle", "quarter_square", "half_square", "diagonal_half_square", "right_half_triangle", "left_half_triangle"
colorfill color for symbol
borderColorborder color for symbol
sizesymbol size (in mm)
anglesymbol rotation angle
scaleMethodscaling method for data defined scaling
penJoinStylejoin style for outline pen
Deprecated:
use variant which accepts QgsSimpleMarkerSymbolLayerBase::Shape instead

Definition at line 686 of file qgsmarkersymbollayerv2.cpp.

QgsSimpleMarkerSymbolLayerV2::QgsSimpleMarkerSymbolLayerV2 ( QgsSimpleMarkerSymbolLayerBase::Shape  shape = Circle,
double  size = DEFAULT_SIMPLEMARKER_SIZE,
double  angle = DEFAULT_SIMPLEMARKER_ANGLE,
QgsSymbolV2::ScaleMethod  scaleMethod = DEFAULT_SCALE_METHOD,
const QColor color = DEFAULT_SIMPLEMARKER_COLOR,
const QColor borderColor = DEFAULT_SIMPLEMARKER_BORDERCOLOR,
Qt::PenJoinStyle  penJoinStyle = DEFAULT_SIMPLEMARKER_JOINSTYLE 
)

Constructor for QgsSimpleMarkerSymbolLayerV2.

Parameters
shapesymbol shape
sizesymbol size (in mm)
anglesymbol rotation angle
scaleMethodscaling method for data defined scaling
colorfill color for symbol
borderColorborder color for symbol
penJoinStylejoin style for outline pen

Definition at line 700 of file qgsmarkersymbollayerv2.cpp.

Member Function Documentation

QColor QgsSimpleMarkerSymbolLayerV2::borderColor ( ) const
inline

Returns the marker's border color.

See also
setBorderColor()
outlineStyle()
penJoinStyle()

Definition at line 278 of file qgsmarkersymbollayerv2.h.

QRectF QgsSimpleMarkerSymbolLayerV2::bounds ( QPointF  point,
QgsSymbolV2RenderContext context 
)
overridevirtual

Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.

Returns
approximate symbol bounds, in painter units
Note
added in QGIS 2.14
this method will become pure virtual in QGIS 3.0

Reimplemented from QgsSimpleMarkerSymbolLayerBase.

Definition at line 1483 of file qgsmarkersymbollayerv2.cpp.

QgsSimpleMarkerSymbolLayerV2 * QgsSimpleMarkerSymbolLayerV2::clone ( ) const
overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayerV2.

Definition at line 1101 of file qgsmarkersymbollayerv2.cpp.

QColor QgsSimpleMarkerSymbolLayerV2::color ( ) const
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayerV2.

Definition at line 1531 of file qgsmarkersymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsSimpleMarkerSymbolLayerV2::create ( const QgsStringMap properties = QgsStringMap())
static

Creates a new QgsSimpleMarkerSymbolLayerV2.

Parameters
propertiesa property map containing symbol properties (see properties())
Returns
new QgsSimpleMarkerSymbolLayerV2

Definition at line 713 of file qgsmarkersymbollayerv2.cpp.

QgsSymbolLayerV2 * QgsSimpleMarkerSymbolLayerV2::createFromSld ( QDomElement element)
static

Creates a new QgsSimpleMarkerSymbolLayerV2 from an SLD XML element.

Parameters
elementXML element containing SLD definition of symbol
Returns
new QgsSimpleMarkerSymbolLayerV2

Definition at line 1208 of file qgsmarkersymbollayerv2.cpp.

void QgsSimpleMarkerSymbolLayerV2::drawMarker ( QPainter p,
QgsSymbolV2RenderContext context 
)
protected

Draws the marker shape in the specified painter.

Parameters
pdestination QPainter
contextsymbol context
Note
this method does not handle setting the painter pen or brush to match the symbol's fill or outline

Definition at line 1248 of file qgsmarkersymbollayerv2.cpp.

QColor QgsSimpleMarkerSymbolLayerV2::fillColor ( ) const
inlineoverridevirtual

Get fill color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 260 of file qgsmarkersymbollayerv2.h.

QString QgsSimpleMarkerSymbolLayerV2::layerType ( ) const
overridevirtual

Returns a string that represents this layer type.

Used for serialization. Should match with the string used to register this symbol layer in the registry.

Implements QgsSymbolLayerV2.

Definition at line 809 of file qgsmarkersymbollayerv2.cpp.

QgsMapUnitScale QgsSimpleMarkerSymbolLayerV2::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1474 of file qgsmarkersymbollayerv2.cpp.

Q_DECL_DEPRECATED QString QgsSimpleMarkerSymbolLayerV2::name ( ) const
inline
Deprecated:
use shape() instead

Definition at line 268 of file qgsmarkersymbollayerv2.h.

QString QgsSimpleMarkerSymbolLayerV2::ogrFeatureStyle ( double  mmScaleFactor,
double  mapUnitScaleFactor 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1146 of file qgsmarkersymbollayerv2.cpp.

QColor QgsSimpleMarkerSymbolLayerV2::outlineColor ( ) const
inlineoverridevirtual

Get outline color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 258 of file qgsmarkersymbollayerv2.h.

Qt::PenStyle QgsSimpleMarkerSymbolLayerV2::outlineStyle ( ) const
inline

Returns the marker's outline style (eg solid, dashed, etc)

Note
added in 2.4
See also
setOutlineStyle()
borderColor()
penJoinStyle()

Definition at line 294 of file qgsmarkersymbollayerv2.h.

double QgsSimpleMarkerSymbolLayerV2::outlineWidth ( ) const
inline

Returns the width of the marker's outline.

See also
setOutlineWidth()
outlineWidthUnit()
outlineWidthMapUnitScale()

Definition at line 327 of file qgsmarkersymbollayerv2.h.

const QgsMapUnitScale& QgsSimpleMarkerSymbolLayerV2::outlineWidthMapUnitScale ( ) const
inline

Returns the map scale for the width of the marker's outline.

See also
setOutlineWidthMapUnitScale()
outlineWidth()
outlineWidthUnit()

Definition at line 365 of file qgsmarkersymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSimpleMarkerSymbolLayerV2::outlineWidthUnit ( ) const
inline

Returns the unit for the width of the marker's outline.

See also
setOutlineWidthUnit()
outlineWidth()
outlineWidthMapUnitScale()

Definition at line 350 of file qgsmarkersymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSimpleMarkerSymbolLayerV2::outputUnit ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1459 of file qgsmarkersymbollayerv2.cpp.

Qt::PenJoinStyle QgsSimpleMarkerSymbolLayerV2::penJoinStyle ( ) const
inline

Returns the marker's outline join style (eg miter, bevel, etc).

Note
added in 2.16
See also
setPenJoinStyle()
borderColor()
outlineStyle()

Definition at line 311 of file qgsmarkersymbollayerv2.h.

bool QgsSimpleMarkerSymbolLayerV2::prepareCache ( QgsSymbolV2RenderContext context)
protected

Prepares cache image.

Returns
true in case of success, false if cache image size too large

Definition at line 886 of file qgsmarkersymbollayerv2.cpp.

bool QgsSimpleMarkerSymbolLayerV2::preparePath ( QString  name = QString())
protected
Deprecated:
will be removed in QGIS 3.0

Definition at line 958 of file qgsmarkersymbollayerv2.cpp.

bool QgsSimpleMarkerSymbolLayerV2::prepareShape ( const QString name = QString())
protected
Deprecated:
will be removed in QGIS 3.0

Definition at line 948 of file qgsmarkersymbollayerv2.cpp.

bool QgsSimpleMarkerSymbolLayerV2::prepareShape ( const QString name,
QPolygonF polygon 
) const
protected
Deprecated:
will be removed in QGIS 3.0

Definition at line 953 of file qgsmarkersymbollayerv2.cpp.

QgsStringMap QgsSimpleMarkerSymbolLayerV2::properties ( ) const
overridevirtual

Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

This is used to serialize a symbol layer perstistently.

Implements QgsSymbolLayerV2.

Definition at line 1073 of file qgsmarkersymbollayerv2.cpp.

void QgsSimpleMarkerSymbolLayerV2::renderPoint ( QPointF  point,
QgsSymbolV2RenderContext context 
)
overridevirtual

Renders a marker at the specified point.

Derived classes must implement this to handle drawing the point.

Parameters
pointposition at which to render point, in painter units
contextsymbol render context

Reimplemented from QgsSimpleMarkerSymbolLayerBase.

Definition at line 1039 of file qgsmarkersymbollayerv2.cpp.

void QgsSimpleMarkerSymbolLayerV2::setBorderColor ( const QColor color)
inline

Sets the marker's border color.

Parameters
colorborder color
See also
borderColor()
setOutlineStyle()
setPenJoinStyle()

Definition at line 286 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setColor ( const QColor color)
overridevirtual

The fill color.

Reimplemented from QgsSymbolLayerV2.

Definition at line 1519 of file qgsmarkersymbollayerv2.cpp.

void QgsSimpleMarkerSymbolLayerV2::setFillColor ( const QColor color)
inlineoverridevirtual

Set fill color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 261 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1468 of file qgsmarkersymbollayerv2.cpp.

Q_DECL_DEPRECATED void QgsSimpleMarkerSymbolLayerV2::setName ( const QString name)
inline
Deprecated:
use setShape() instead

Definition at line 271 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setOutlineColor ( const QColor color)
inlineoverridevirtual

Set outline color.

Supported by marker and fill layers.

Note
added in 2.1

Reimplemented from QgsSymbolLayerV2.

Definition at line 259 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setOutlineStyle ( Qt::PenStyle  outlineStyle)
inline

Sets the marker's outline style (eg solid, dashed, etc)

Parameters
outlineStylestyle
Note
added in 2.4
See also
outlineStyle()
setBorderColor()
setPenJoinStyle()

Definition at line 303 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setOutlineWidth ( double  w)
inline

Sets the width of the marker's outline.

Parameters
woutline width. See outlineWidthUnit() for units.
See also
outlineWidth()
setOutlineWidthUnit()
setOutlineWidthMapUnitScale()

Definition at line 335 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setOutlineWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map scale for the width of the marker's outline.

Parameters
scaleoutline width map unit scale
See also
outlineWidthMapUnitScale()
setOutlineWidth()
setOutlineWidthUnit()

Definition at line 358 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setOutlineWidthUnit ( QgsSymbolV2::OutputUnit  u)
inline

Sets the unit for the width of the marker's outline.

Parameters
uoutline width unit
See also
outlineWidthUnit()
setOutlineWidth()
setOutlineWidthMapUnitScale()

Definition at line 343 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::setOutputUnit ( QgsSymbolV2::OutputUnit  unit)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 1453 of file qgsmarkersymbollayerv2.cpp.

void QgsSimpleMarkerSymbolLayerV2::setPenJoinStyle ( Qt::PenJoinStyle  style)
inline

Sets the marker's outline join style (eg miter, bevel, etc).

Parameters
stylejoin style
Note
added in 2.16
See also
penJoinStyle()
setBorderColor()
setOutlineStyle()

Definition at line 320 of file qgsmarkersymbollayerv2.h.

void QgsSimpleMarkerSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Reimplemented from QgsSimpleMarkerSymbolLayerBase.

Definition at line 814 of file qgsmarkersymbollayerv2.cpp.

bool QgsSimpleMarkerSymbolLayerV2::writeDxf ( QgsDxfExport e,
double  mmMapUnitScaleFactor,
const QString layerName,
QgsSymbolV2RenderContext context,
QPointF  shift = QPointF( 0.0, 0.0 ) 
) const
overridevirtual

write as DXF

Reimplemented from QgsSymbolLayerV2.

Definition at line 1262 of file qgsmarkersymbollayerv2.cpp.

void QgsSimpleMarkerSymbolLayerV2::writeSldMarker ( QDomDocument doc,
QDomElement element,
const QgsStringMap props 
) const
overridevirtual

Writes the symbol layer definition as a SLD XML element.

Parameters
docXML document
elementparent XML element
propssymbol layer definition (see properties())

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 1120 of file qgsmarkersymbollayerv2.cpp.

Member Data Documentation

QColor QgsSimpleMarkerSymbolLayerV2::mBorderColor
protected

Outline color.

Definition at line 389 of file qgsmarkersymbollayerv2.h.

QBrush QgsSimpleMarkerSymbolLayerV2::mBrush
protected

QBrush corresponding to marker's fill style.

Definition at line 403 of file qgsmarkersymbollayerv2.h.

QImage QgsSimpleMarkerSymbolLayerV2::mCache
protected

Cached image of marker, if using cached version.

Definition at line 409 of file qgsmarkersymbollayerv2.h.

const int QgsSimpleMarkerSymbolLayerV2::mMaximumCacheWidth = 3000
staticprotected

Maximum width/height of cache image.

Definition at line 420 of file qgsmarkersymbollayerv2.h.

QString QgsSimpleMarkerSymbolLayerV2::mName
protected

Definition at line 406 of file qgsmarkersymbollayerv2.h.

Qt::PenStyle QgsSimpleMarkerSymbolLayerV2::mOutlineStyle
protected

Outline style.

Definition at line 391 of file qgsmarkersymbollayerv2.h.

double QgsSimpleMarkerSymbolLayerV2::mOutlineWidth
protected

Outline width.

Definition at line 393 of file qgsmarkersymbollayerv2.h.

QgsMapUnitScale QgsSimpleMarkerSymbolLayerV2::mOutlineWidthMapUnitScale
protected

Outline width map unit scale.

Definition at line 397 of file qgsmarkersymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsSimpleMarkerSymbolLayerV2::mOutlineWidthUnit
protected

Outline width units.

Definition at line 395 of file qgsmarkersymbollayerv2.h.

QPen QgsSimpleMarkerSymbolLayerV2::mPen
protected

QPen corresponding to marker's outline style.

Definition at line 401 of file qgsmarkersymbollayerv2.h.

Qt::PenJoinStyle QgsSimpleMarkerSymbolLayerV2::mPenJoinStyle
protected

Outline pen join style.

Definition at line 399 of file qgsmarkersymbollayerv2.h.

QBrush QgsSimpleMarkerSymbolLayerV2::mSelBrush
protected

QBrush to use as fill of selected symbols.

Definition at line 413 of file qgsmarkersymbollayerv2.h.

QImage QgsSimpleMarkerSymbolLayerV2::mSelCache
protected

Cached image of selected marker, if using cached version.

Definition at line 415 of file qgsmarkersymbollayerv2.h.

QPen QgsSimpleMarkerSymbolLayerV2::mSelPen
protected

QPen to use as outline of selected symbols.

Definition at line 411 of file qgsmarkersymbollayerv2.h.

bool QgsSimpleMarkerSymbolLayerV2::mUsingCache
protected

True if using cached images of markers for drawing.

This is faster, but cannot be used when data defined properties are present

Definition at line 418 of file qgsmarkersymbollayerv2.h.


The documentation for this class was generated from the following files: