QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
QgsMarkerSymbolLayerV2 Class Referenceabstract

#include <qgssymbollayerv2.h>

Inheritance diagram for QgsMarkerSymbolLayerV2:
Inheritance graph
[legend]

Public Types

enum  HorizontalAnchorPoint { Left, HCenter, Right }
 
enum  VerticalAnchorPoint { Top, VCenter, Bottom }
 

Public Member Functions

double angle () const
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
 
HorizontalAnchorPoint horizontalAnchorPoint () const
 
QgsMapUnitScale mapUnitScale () const override
 
QPointF offset () const
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 
QgsSymbolV2::OutputUnit offsetUnit () const
 
QgsSymbolV2::OutputUnit outputUnit () const override
 
virtual void renderPoint (const QPointF &point, QgsSymbolV2RenderContext &context)=0
 
QgsSymbolV2::ScaleMethod scaleMethod () const
 
void setAngle (double angle)
 
void setHorizontalAnchorPoint (HorizontalAnchorPoint h)
 
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)
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 
void setOffsetUnit (QgsSymbolV2::OutputUnit unit)
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
 
void setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
 
void setSize (double size)
 
void setSizeMapUnitScale (const QgsMapUnitScale &scale)
 
void setSizeUnit (QgsSymbolV2::OutputUnit unit)
 
void setVerticalAnchorPoint (VerticalAnchorPoint v)
 
double size () const
 
const QgsMapUnitScalesizeMapUnitScale () const
 
QgsSymbolV2::OutputUnit sizeUnit () const
 
void startRender (QgsSymbolV2RenderContext &context) override
 
virtual void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const override
 
VerticalAnchorPoint verticalAnchorPoint () const
 
virtual void writeSldMarker (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
 
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
 
virtual QgsSymbolLayerV2clone () const =0
 
virtual QColor color () const
 
virtual Q_DECL_DEPRECATED
const QgsExpression
dataDefinedProperty (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 QColor dxfBrushColor (const QgsSymbolV2RenderContext &context) const
 
virtual Qt::BrushStyle dxfBrushStyle () const
 
virtual QColor dxfColor (const QgsSymbolV2RenderContext &context) const
 
virtual QVector< qreal > dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const
 
virtual double dxfOffset (const QgsDxfExport &e, const QgsSymbolV2RenderContext &context) const
 
virtual Qt::PenStyle dxfPenStyle () const
 
virtual double dxfWidth (const QgsDxfExport &e, const QgsSymbolV2RenderContext &context) const
 
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=0) 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=0) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QColor fillColor () const
 Get fill color. 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...
 
bool isLocked () const
 
virtual QString layerType () const =0
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
virtual QColor outlineColor () const
 Get outline color. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual QgsStringMap properties () const =0
 
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 void setColor (const QColor &color)
 
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...
 
virtual void setFillColor (const QColor &color)
 Set fill color. More...
 
void setLocked (bool locked)
 
virtual void setOutlineColor (const QColor &color)
 Set outline color. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
virtual bool setSubSymbol (QgsSymbolV2 *symbol)
 
virtual void stopRender (QgsSymbolV2RenderContext &context)=0
 
virtual QgsSymbolV2subSymbol ()
 
QgsSymbolV2::SymbolType type () const
 
virtual QSet< QStringusedAttributes () const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, const QgsSymbolV2RenderContext *context, const QgsFeature *f, const QPointF &shift=QPointF(0.0, 0.0)) const
 

Protected Member Functions

 QgsMarkerSymbolLayerV2 (bool locked=false)
 
void markerOffset (const QgsSymbolV2RenderContext &context, double &offsetX, double &offsetY) const
 
void markerOffset (const QgsSymbolV2RenderContext &context, double width, double height, double &offsetX, double &offsetY) const
 
void markerOffset (const 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
QgsExpression
expression (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...
 

Static Protected Member Functions

static QPointF _rotatedOffset (const QPointF &offset, double angle)
 

Protected Attributes

double mAngle
 
HorizontalAnchorPoint mHorizontalAnchorPoint
 
double mLineAngle
 
QPointF mOffset
 
QgsMapUnitScale mOffsetMapUnitScale
 
QgsSymbolV2::OutputUnit mOffsetUnit
 
QgsSymbolV2::ScaleMethod mScaleMethod
 
double mSize
 
QgsMapUnitScale mSizeMapUnitScale
 
QgsSymbolV2::OutputUnit mSizeUnit
 
VerticalAnchorPoint mVerticalAnchorPoint
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 372 of file qgssymbollayerv2.h.

Member Enumeration Documentation

Enumerator
Left 
HCenter 
Right 

Definition at line 376 of file qgssymbollayerv2.h.

Enumerator
Top 
VCenter 
Bottom 

Definition at line 383 of file qgssymbollayerv2.h.

Constructor & Destructor Documentation

QgsMarkerSymbolLayerV2::QgsMarkerSymbolLayerV2 ( bool  locked = false)
protected

Definition at line 485 of file qgssymbollayerv2.cpp.

Member Function Documentation

QPointF QgsMarkerSymbolLayerV2::_rotatedOffset ( const QPointF offset,
double  angle 
)
staticprotected

Definition at line 592 of file qgssymbollayerv2.cpp.

double QgsMarkerSymbolLayerV2::angle ( void  ) const
inline

Definition at line 397 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::drawPreviewIcon ( QgsSymbolV2RenderContext context,
QSize  size 
)
overridevirtual

Implements QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer.

Definition at line 519 of file qgssymbollayerv2.cpp.

HorizontalAnchorPoint QgsMarkerSymbolLayerV2::horizontalAnchorPoint ( ) const
inline

Definition at line 440 of file qgssymbollayerv2.h.

QgsMapUnitScale QgsMarkerSymbolLayerV2::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer.

Definition at line 652 of file qgssymbollayerv2.cpp.

void QgsMarkerSymbolLayerV2::markerOffset ( const QgsSymbolV2RenderContext context,
double &  offsetX,
double &  offsetY 
) const
protected

Definition at line 526 of file qgssymbollayerv2.cpp.

void QgsMarkerSymbolLayerV2::markerOffset ( const QgsSymbolV2RenderContext context,
double  width,
double  height,
double &  offsetX,
double &  offsetY 
) const
protected

Definition at line 531 of file qgssymbollayerv2.cpp.

void QgsMarkerSymbolLayerV2::markerOffset ( const QgsSymbolV2RenderContext context,
double  width,
double  height,
QgsSymbolV2::OutputUnit  widthUnit,
QgsSymbolV2::OutputUnit  heightUnit,
double &  offsetX,
double &  offsetY,
const QgsMapUnitScale widthMapUnitScale,
const QgsMapUnitScale heightMapUnitScale 
) const
protected
Note
available in python bindings as markerOffset2

Definition at line 536 of file qgssymbollayerv2.cpp.

QPointF QgsMarkerSymbolLayerV2::offset ( ) const
inline

Definition at line 414 of file qgssymbollayerv2.h.

const QgsMapUnitScale& QgsMarkerSymbolLayerV2::offsetMapUnitScale ( ) const
inline

Definition at line 425 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsMarkerSymbolLayerV2::offsetUnit ( ) const
inline

Definition at line 422 of file qgssymbollayerv2.h.

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

Reimplemented from QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer.

Definition at line 637 of file qgssymbollayerv2.cpp.

virtual void QgsMarkerSymbolLayerV2::renderPoint ( const QPointF point,
QgsSymbolV2RenderContext context 
)
pure virtual
QgsSymbolV2::ScaleMethod QgsMarkerSymbolLayerV2::scaleMethod ( ) const
inline

Definition at line 411 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setAngle ( double  angle)
inline

Definition at line 396 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setHorizontalAnchorPoint ( HorizontalAnchorPoint  h)
inline

Definition at line 439 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setLineAngle ( double  lineAngle)
inline

Sets the line angle modification for the symbol's angle.

This angle is added to the marker's rotation and data defined rotation before rendering the symbol, and is usually used for orienting symbols to match a line's angle.

Parameters
lineAngleAngle in degrees, valid values are between 0 and 360
Note
added in QGIS 2.9

Definition at line 405 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer.

Definition at line 646 of file qgssymbollayerv2.cpp.

void QgsMarkerSymbolLayerV2::setOffset ( QPointF  offset)
inline

Definition at line 413 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 424 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setOffsetUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 421 of file qgssymbollayerv2.h.

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

Reimplemented from QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer.

Definition at line 631 of file qgssymbollayerv2.cpp.

void QgsMarkerSymbolLayerV2::setScaleMethod ( QgsSymbolV2::ScaleMethod  scaleMethod)
inline

Definition at line 410 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setSize ( double  size)
inline

Definition at line 407 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setSizeMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 430 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setSizeUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 427 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::setVerticalAnchorPoint ( VerticalAnchorPoint  v)
inline

Definition at line 442 of file qgssymbollayerv2.h.

double QgsMarkerSymbolLayerV2::size ( void  ) const
inline

Definition at line 408 of file qgssymbollayerv2.h.

const QgsMapUnitScale& QgsMarkerSymbolLayerV2::sizeMapUnitScale ( ) const
inline

Definition at line 431 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsMarkerSymbolLayerV2::sizeUnit ( ) const
inline

Definition at line 428 of file qgssymbollayerv2.h.

void QgsMarkerSymbolLayerV2::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer.

Definition at line 514 of file qgssymbollayerv2.cpp.

void QgsMarkerSymbolLayerV2::toSld ( QDomDocument doc,
QDomElement element,
QgsStringMap  props 
) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Reimplemented in QgsVectorFieldSymbolLayer, and QgsEllipseSymbolLayerV2.

Definition at line 761 of file qgssymbollayerv2.cpp.

VerticalAnchorPoint QgsMarkerSymbolLayerV2::verticalAnchorPoint ( ) const
inline

Definition at line 443 of file qgssymbollayerv2.h.

virtual void QgsMarkerSymbolLayerV2::writeSldMarker ( QDomDocument doc,
QDomElement element,
QgsStringMap  props 
) const
inlinevirtual

Member Data Documentation

double QgsMarkerSymbolLayerV2::mAngle
protected

Definition at line 461 of file qgssymbollayerv2.h.

HorizontalAnchorPoint QgsMarkerSymbolLayerV2::mHorizontalAnchorPoint
protected

Definition at line 470 of file qgssymbollayerv2.h.

double QgsMarkerSymbolLayerV2::mLineAngle
protected

Definition at line 462 of file qgssymbollayerv2.h.

QPointF QgsMarkerSymbolLayerV2::mOffset
protected

Definition at line 466 of file qgssymbollayerv2.h.

QgsMapUnitScale QgsMarkerSymbolLayerV2::mOffsetMapUnitScale
protected

Definition at line 468 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsMarkerSymbolLayerV2::mOffsetUnit
protected

Definition at line 467 of file qgssymbollayerv2.h.

QgsSymbolV2::ScaleMethod QgsMarkerSymbolLayerV2::mScaleMethod
protected

Definition at line 469 of file qgssymbollayerv2.h.

double QgsMarkerSymbolLayerV2::mSize
protected

Definition at line 463 of file qgssymbollayerv2.h.

QgsMapUnitScale QgsMarkerSymbolLayerV2::mSizeMapUnitScale
protected

Definition at line 465 of file qgssymbollayerv2.h.

QgsSymbolV2::OutputUnit QgsMarkerSymbolLayerV2::mSizeUnit
protected

Definition at line 464 of file qgssymbollayerv2.h.

VerticalAnchorPoint QgsMarkerSymbolLayerV2::mVerticalAnchorPoint
protected

Definition at line 471 of file qgssymbollayerv2.h.


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