QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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
 
const QgsMapUnitScaledistanceMapUnitScale () const
 
QgsSymbolV2::OutputUnit distanceUnit () const
 
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size)
 
QString layerType () const
 
QgsMapUnitScale mapUnitScale () const
 
QgsSymbolV2::OutputUnit outputUnit () const
 
QgsStringMap properties () const
 
void renderPoint (const QPointF &point, QgsSymbolV2RenderContext &context)
 
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)
 
void setOutputUnit (QgsSymbolV2::OutputUnit unit)
 
void setScale (double s)
 
bool setSubSymbol (QgsSymbolV2 *symbol)
 
void setVectorFieldType (VectorFieldType type)
 
void setXAttribute (const QString &attribute)
 
void setYAttribute (const QString &attribute)
 
void startRender (QgsSymbolV2RenderContext &context)
 
void stopRender (QgsSymbolV2RenderContext &context)
 
QgsSymbolV2subSymbol ()
 
void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
 
QSet< QString > usedAttributes () const
 
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 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 QColor fillColor () const
 Get fill color. More...
 
bool hasDataDefinedProperties () const
 
bool isLocked () const
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
virtual QColor outlineColor () const
 Get outline color. More...
 
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. More...
 
void setLocked (bool locked)
 
virtual void setOutlineColor (const QColor &color)
 Set outline color. More...
 
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
 
- Protected Member Functions inherited from QgsSymbolLayerV2
 QgsSymbolLayerV2 (QgsSymbolV2::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayerV2 *destLayer) const
 Copies data defined properties of this layer to another symbol layer. More...
 
virtual QgsExpressionexpression (const QString &property) const
 
virtual void prepareExpressions (const QgsFields *fields, double scale=-1.0)
 
void saveDataDefinedProperties (QgsStringMap &stringMap) const
 Saves data defined properties to string map. More...
 
- 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
 
- Protected Attributes inherited from QgsSymbolLayerV2
QColor mColor
 
QMap< QString, QgsExpression * > mDataDefinedProperties
 
bool mLocked
 
int mRenderingPass
 
QgsSymbolV2::SymbolType mType
 
- 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 27 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
virtual

Implements QgsSymbolLayerV2.

Definition at line 222 of file qgsvectorfieldsymbollayer.cpp.

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

Definition at line 61 of file qgsvectorfieldsymbollayer.cpp.

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

Definition at line 258 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 
)
virtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 264 of file qgsvectorfieldsymbollayer.cpp.

QString QgsVectorFieldSymbolLayer::layerType ( ) const
inlinevirtual

Implements QgsSymbolLayerV2.

Definition at line 52 of file qgsvectorfieldsymbollayer.h.

QgsMapUnitScale QgsVectorFieldSymbolLayer::mapUnitScale ( ) const
virtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 52 of file qgsvectorfieldsymbollayer.cpp.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 37 of file qgsvectorfieldsymbollayer.cpp.

QgsStringMap QgsVectorFieldSymbolLayer::properties ( ) const
virtual

Implements QgsSymbolLayerV2.

Definition at line 232 of file qgsvectorfieldsymbollayer.cpp.

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

Implements QgsMarkerSymbolLayerV2.

Definition at line 133 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)
virtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 46 of file qgsvectorfieldsymbollayer.cpp.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 31 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::setScale ( double  s)
inline

Definition at line 75 of file qgsvectorfieldsymbollayer.h.

bool QgsVectorFieldSymbolLayer::setSubSymbol ( QgsSymbolV2 symbol)
virtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 123 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)
virtual

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 194 of file qgsvectorfieldsymbollayer.cpp.

void QgsVectorFieldSymbolLayer::stopRender ( QgsSymbolV2RenderContext context)
virtual

Implements QgsSymbolLayerV2.

Definition at line 214 of file qgsvectorfieldsymbollayer.cpp.

QgsSymbolV2* QgsVectorFieldSymbolLayer::subSymbol ( )
inlinevirtual

Reimplemented from QgsSymbolLayerV2.

Definition at line 55 of file qgsvectorfieldsymbollayer.h.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 252 of file qgsvectorfieldsymbollayer.cpp.

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 272 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: