QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsVectorFieldSymbolLayer Class Reference

A symbol layer class for displaying displacement arrows based on point layer attributes. More...

#include <qgsvectorfieldsymbollayer.h>

Inheritance diagram for QgsVectorFieldSymbolLayer:
Inheritance graph
[legend]

Public Types

enum  AngleOrientation { ClockwiseFromNorth = 0, CounterclockwiseFromEast }
enum  AngleUnits { Degrees = 0, Radians }
enum  VectorFieldType { Cartesian = 0, Polar, Height }
- Public Types inherited from QgsMarkerSymbolLayerV2
enum  HorizontalAnchorPoint { Left, HCenter, Right }
enum  VerticalAnchorPoint { Top, VCenter, Bottom }

Public Member Functions

 QgsVectorFieldSymbolLayer ()
 ~QgsVectorFieldSymbolLayer ()
AngleOrientation angleOrientation () const
AngleUnits angleUnits () const
QgsSymbolLayerV2clone () const override
const QgsMapUnitScaledistanceMapUnitScale () const
QgsSymbolV2::OutputUnit distanceUnit () const
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size) override
QString layerType () const override
QgsMapUnitScale mapUnitScale () const override
QgsSymbolV2::OutputUnit outputUnit () const override
QgsStringMap properties () const override
void renderPoint (const QPointF &point, QgsSymbolV2RenderContext &context) override
double scale () const
void setAngleOrientation (AngleOrientation orientation)
void setAngleUnits (AngleUnits units)
void setDistanceMapUnitScale (const QgsMapUnitScale &scale)
void setDistanceUnit (QgsSymbolV2::OutputUnit unit)
void setMapUnitScale (const QgsMapUnitScale &scale) override
void setOutputUnit (QgsSymbolV2::OutputUnit unit) override
void setScale (double s)
bool setSubSymbol (QgsSymbolV2 *symbol) override
void setVectorFieldType (VectorFieldType type)
void setXAttribute (const QString &attribute)
void setYAttribute (const QString &attribute)
void startRender (QgsSymbolV2RenderContext &context) override
void stopRender (QgsSymbolV2RenderContext &context) override
QgsSymbolV2subSymbol () override
void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const override
QSet< QString > usedAttributes () const override
VectorFieldType vectorFieldType () const
QString xAttribute () const
QString yAttribute () const
- Public Member Functions inherited from QgsMarkerSymbolLayerV2
double angle () const
HorizontalAnchorPoint horizontalAnchorPoint () const
QPointF offset ()
const QgsMapUnitScaleoffsetMapUnitScale () const
QgsSymbolV2::OutputUnit offsetUnit () const
QgsSymbolV2::ScaleMethod scaleMethod () const
void setAngle (double angle)
void setHorizontalAnchorPoint (HorizontalAnchorPoint h)
void setOffset (QPointF offset)
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
void setOffsetUnit (QgsSymbolV2::OutputUnit unit)
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
VerticalAnchorPoint verticalAnchorPoint () const
virtual void writeSldMarker (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
- Public Member Functions inherited from QgsSymbolLayerV2
virtual ~QgsSymbolLayerV2 ()
virtual QColor color () const
virtual const QgsExpressiondataDefinedProperty (const QString &property) const
virtual QString dataDefinedPropertyString (const QString &property) const
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.
virtual QColor fillColor () const
 Get fill color.
bool hasDataDefinedProperties () const
bool isLocked () const
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
virtual QColor outlineColor () const
 Get outline color.
virtual void removeDataDefinedProperties ()
virtual void removeDataDefinedProperty (const QString &property)
int renderingPass () const
virtual void setColor (const QColor &color)
virtual void setDataDefinedProperty (const QString &property, const QString &expressionString)
virtual void setFillColor (const QColor &color)
 Set fill color.
void setLocked (bool locked)
virtual void setOutlineColor (const QColor &color)
 Set outline color.
void setRenderingPass (int renderingPass)
QgsSymbolV2::SymbolType type () const
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

Static Public Member Functions

static QgsSymbolLayerV2create (const QgsStringMap &properties=QgsStringMap())
static QgsSymbolLayerV2createFromSld (QDomElement &element)

Additional Inherited Members

- Protected Member Functions inherited from QgsMarkerSymbolLayerV2
 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
- Static Protected Member Functions inherited from QgsMarkerSymbolLayerV2
static QPointF _rotatedOffset (const QPointF &offset, double angle)
- Protected Attributes inherited from QgsMarkerSymbolLayerV2
double mAngle
HorizontalAnchorPoint mHorizontalAnchorPoint
QPointF mOffset
QgsMapUnitScale mOffsetMapUnitScale
QgsSymbolV2::OutputUnit mOffsetUnit
QgsSymbolV2::ScaleMethod mScaleMethod
double mSize
QgsMapUnitScale mSizeMapUnitScale
QgsSymbolV2::OutputUnit mSizeUnit
VerticalAnchorPoint mVerticalAnchorPoint
- Static Protected Attributes inherited from QgsSymbolLayerV2
static const bool selectFillBorder = false
static const bool selectFillStyle = false
static const bool selectionIsOpaque = true

Detailed Description

A symbol layer class for displaying displacement arrows based on point layer attributes.

Definition at line 24 of file qgsvectorfieldsymbollayer.h.

Member Enumeration Documentation

Enumerator:
ClockwiseFromNorth 
CounterclockwiseFromEast 

Definition at line 34 of file qgsvectorfieldsymbollayer.h.

Enumerator:
Degrees 
Radians 

Definition at line 40 of file qgsvectorfieldsymbollayer.h.

Enumerator:
Cartesian 
Polar 
Height 

Definition at line 27 of file qgsvectorfieldsymbollayer.h.

Constructor & Destructor Documentation

QgsVectorFieldSymbolLayer::QgsVectorFieldSymbolLayer ( )

Definition at line 21 of file qgsvectorfieldsymbollayer.cpp.

QgsVectorFieldSymbolLayer::~QgsVectorFieldSymbolLayer ( )

Definition at line 36 of file qgsvectorfieldsymbollayer.cpp.

Member Function Documentation

AngleOrientation QgsVectorFieldSymbolLayer::angleOrientation ( ) const
inline

Definition at line 80 of file qgsvectorfieldsymbollayer.h.

AngleUnits QgsVectorFieldSymbolLayer::angleUnits ( ) const
inline

Definition at line 82 of file qgsvectorfieldsymbollayer.h.

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::clone ( ) const
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 233 of file qgsvectorfieldsymbollayer.cpp.

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

Definition at line 71 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::createFromSld ( QDomElement &  element)
static

Definition at line 269 of file qgsvectorfieldsymbollayer.cpp.

const QgsMapUnitScale& QgsVectorFieldSymbolLayer::distanceMapUnitScale ( ) const
inline

Definition at line 94 of file qgsvectorfieldsymbollayer.h.

QgsSymbolV2::OutputUnit QgsVectorFieldSymbolLayer::distanceUnit ( ) const
inline

Definition at line 91 of file qgsvectorfieldsymbollayer.h.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 275 of file qgsvectorfieldsymbollayer.cpp.

QString QgsVectorFieldSymbolLayer::layerType ( ) const
inlineoverridevirtual

Implements QgsSymbolLayerV2.

Definition at line 52 of file qgsvectorfieldsymbollayer.h.

QgsMapUnitScale QgsVectorFieldSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 62 of file qgsvectorfieldsymbollayer.cpp.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 47 of file qgsvectorfieldsymbollayer.cpp.

QgsStringMap QgsVectorFieldSymbolLayer::properties ( ) const
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 243 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::renderPoint ( const QPointF &  point,
QgsSymbolV2RenderContext context 
)
overridevirtual

Implements QgsMarkerSymbolLayerV2.

Definition at line 144 of file qgsvectorfieldsymbollayer.cpp.

double QgsVectorFieldSymbolLayer::scale ( ) const
inline

Definition at line 76 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setAngleOrientation ( AngleOrientation  orientation)
inline

Definition at line 79 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setAngleUnits ( AngleUnits  units)
inline

Definition at line 81 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 93 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setDistanceUnit ( QgsSymbolV2::OutputUnit  unit)
inline

Definition at line 90 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 56 of file qgsvectorfieldsymbollayer.cpp.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 41 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::setScale ( double  s)
inline

Definition at line 75 of file qgsvectorfieldsymbollayer.h.

bool QgsVectorFieldSymbolLayer::setSubSymbol ( QgsSymbolV2 symbol)
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 133 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::setVectorFieldType ( VectorFieldType  type)
inline

Definition at line 77 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setXAttribute ( const QString &  attribute)
inline

Definition at line 71 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::setYAttribute ( const QString &  attribute)
inline

Definition at line 73 of file qgsvectorfieldsymbollayer.h.

void QgsVectorFieldSymbolLayer::startRender ( QgsSymbolV2RenderContext context)
overridevirtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 205 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::stopRender ( QgsSymbolV2RenderContext context)
overridevirtual

Implements QgsSymbolLayerV2.

Definition at line 225 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolV2* QgsVectorFieldSymbolLayer::subSymbol ( )
inlineoverridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 55 of file qgsvectorfieldsymbollayer.h.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 263 of file qgsvectorfieldsymbollayer.cpp.

QSet< QString > QgsVectorFieldSymbolLayer::usedAttributes ( ) const
overridevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 283 of file qgsvectorfieldsymbollayer.cpp.

VectorFieldType QgsVectorFieldSymbolLayer::vectorFieldType ( ) const
inline

Definition at line 78 of file qgsvectorfieldsymbollayer.h.

QString QgsVectorFieldSymbolLayer::xAttribute ( ) const
inline

Definition at line 72 of file qgsvectorfieldsymbollayer.h.

QString QgsVectorFieldSymbolLayer::yAttribute ( ) const
inline

Definition at line 74 of file qgsvectorfieldsymbollayer.h.


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