QGIS API Documentation  master-6227475
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
QgsVectorFieldSymbolLayer Class Reference

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

#include <qgsvectorfieldsymbollayer.h>

+ Inheritance diagram for QgsVectorFieldSymbolLayer:
+ Collaboration diagram for QgsVectorFieldSymbolLayer:

List of all members.

Public Types

enum  AngleOrientation { ClockwiseFromNorth = 0, CounterclockwiseFromEast }
enum  AngleUnits { Degrees = 0, Radians }
enum  VectorFieldType { Cartesian = 0, Polar, Height }

Public Member Functions

 QgsVectorFieldSymbolLayer ()
 ~QgsVectorFieldSymbolLayer ()
AngleOrientation angleOrientation () const
AngleUnits angleUnits () const
QgsSymbolLayerV2 * clone () const
QgsSymbolV2::OutputUnit distanceUnit () const
void drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size)
QString layerType () 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 setDistanceUnit (QgsSymbolV2::OutputUnit unit)
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)
QgsSymbolV2 * subSymbol ()
void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
QSet< QString > usedAttributes () const
VectorFieldType vectorFieldType () const
QString xAttribute () const
QString yAttribute () const

Static Public Member Functions

static QgsSymbolLayerV2 * create (const QgsStringMap &properties=QgsStringMap())
static QgsSymbolLayerV2 * createFromSld (QDomElement &element)

Private Member Functions

void convertPolarToCartesian (double length, double angle, double &x, double &y) const

Private Attributes

AngleOrientation mAngleOrientation
AngleUnits mAngleUnits
QgsSymbolV2::OutputUnit mDistanceUnit
QgsLineSymbolV2 * mLineSymbol
double mScale
VectorFieldType mVectorFieldType
QString mXAttribute
int mXIndex
QString mYAttribute
int mYIndex

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

enum QgsVectorFieldSymbolLayer::AngleOrientation
Enumerator:
ClockwiseFromNorth 
CounterclockwiseFromEast 

Definition at line 34 of file qgsvectorfieldsymbollayer.h.

enum QgsVectorFieldSymbolLayer::AngleUnits
Enumerator:
Degrees 
Radians 

Definition at line 40 of file qgsvectorfieldsymbollayer.h.

enum QgsVectorFieldSymbolLayer::VectorFieldType
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.

References setSubSymbol().

Referenced by create().

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.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

AngleUnits QgsVectorFieldSymbolLayer::angleUnits ( ) const [inline]

Definition at line 82 of file qgsvectorfieldsymbollayer.h.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::clone ( ) const [virtual]

Implements QgsSymbolLayerV2.

Definition at line 174 of file qgsvectorfieldsymbollayer.cpp.

References QgsLineSymbolV2::clone(), create(), mLineSymbol, properties(), and QgsSymbolLayerV2::setSubSymbol().

void QgsVectorFieldSymbolLayer::convertPolarToCartesian ( double  length,
double  angle,
double &  x,
double &  y 
) const [private]

Definition at line 231 of file qgsvectorfieldsymbollayer.cpp.

References QgsMarkerSymbolLayerV2::angle(), CounterclockwiseFromEast, Degrees, M_PI, mAngleOrientation, and mAngleUnits.

Referenced by renderPoint().

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

Definition at line 41 of file qgsvectorfieldsymbollayer.cpp.

References QgsSymbolLayerV2Utils::decodeOutputUnit(), QgsVectorFieldSymbolLayer(), setAngleOrientation(), setAngleUnits(), setDistanceUnit(), setScale(), setVectorFieldType(), setXAttribute(), and setYAttribute().

Referenced by clone(), and QgsSymbolLayerV2Registry::QgsSymbolLayerV2Registry().

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

Definition at line 203 of file qgsvectorfieldsymbollayer.cpp.

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

Definition at line 88 of file qgsvectorfieldsymbollayer.h.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

void QgsVectorFieldSymbolLayer::drawPreviewIcon ( QgsSymbolV2RenderContext &  context,
QSize  size 
) [virtual]

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 209 of file qgsvectorfieldsymbollayer.cpp.

References QgsSymbolV2::drawPreviewIcon(), mLineSymbol, QgsRenderContext::painter(), QgsSymbolV2RenderContext::renderContext(), and QgsMarkerSymbolLayerV2::size().

QString QgsVectorFieldSymbolLayer::layerType ( ) const [inline, virtual]

Implements QgsSymbolLayerV2.

Definition at line 52 of file qgsvectorfieldsymbollayer.h.

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 36 of file qgsvectorfieldsymbollayer.cpp.

References mDistanceUnit.

QgsStringMap QgsVectorFieldSymbolLayer::properties ( ) const [virtual]

Implements QgsSymbolLayerV2.

Definition at line 184 of file qgsvectorfieldsymbollayer.cpp.

References QgsSymbolLayerV2Utils::encodeOutputUnit(), mAngleOrientation, mAngleUnits, mDistanceUnit, mScale, mVectorFieldType, mXAttribute, and mYAttribute.

Referenced by clone().

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

Implements QgsMarkerSymbolLayerV2.

Definition at line 85 of file qgsvectorfieldsymbollayer.cpp.

References QgsFeature::attribute(), Cartesian, convertPolarToCartesian(), QgsSymbolV2RenderContext::feature(), Height, QgsSymbolLayerV2Utils::lineWidthScaleFactor(), mDistanceUnit, mLineSymbol, mScale, mVectorFieldType, mXIndex, mYIndex, Polar, QgsSymbolV2RenderContext::renderContext(), and QgsLineSymbolV2::renderPolyline().

double QgsVectorFieldSymbolLayer::scale ( ) const [inline]

Definition at line 76 of file qgsvectorfieldsymbollayer.h.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

void QgsVectorFieldSymbolLayer::setAngleOrientation ( AngleOrientation  orientation) [inline]

Definition at line 79 of file qgsvectorfieldsymbollayer.h.

Referenced by create(), QgsVectorFieldSymbolLayerWidget::on_mClockwiseFromNorthRadioButton_toggled(), and QgsVectorFieldSymbolLayerWidget::on_mCounterclockwiseFromEastRadioButton_toggled().

void QgsVectorFieldSymbolLayer::setAngleUnits ( AngleUnits  units) [inline]

Definition at line 81 of file qgsvectorfieldsymbollayer.h.

Referenced by create(), QgsVectorFieldSymbolLayerWidget::on_mDegreesRadioButton_toggled(), and QgsVectorFieldSymbolLayerWidget::on_mRadiansRadioButton_toggled().

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

Definition at line 87 of file qgsvectorfieldsymbollayer.h.

Referenced by create(), and QgsVectorFieldSymbolLayerWidget::on_mDistanceUnitComboBox_currentIndexChanged().

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

Reimplemented from QgsMarkerSymbolLayerV2.

Definition at line 31 of file qgsvectorfieldsymbollayer.cpp.

References mDistanceUnit.

void QgsVectorFieldSymbolLayer::setScale ( double  s) [inline]

Definition at line 75 of file qgsvectorfieldsymbollayer.h.

Referenced by create(), and QgsVectorFieldSymbolLayerWidget::on_mScaleSpinBox_valueChanged().

bool QgsVectorFieldSymbolLayer::setSubSymbol ( QgsSymbolV2 *  symbol) [virtual]

Reimplemented from QgsSymbolLayerV2.

Definition at line 75 of file qgsvectorfieldsymbollayer.cpp.

References QgsSymbolV2::Line, mLineSymbol, and QgsSymbolV2::type().

Referenced by QgsVectorFieldSymbolLayer().

void QgsVectorFieldSymbolLayer::setVectorFieldType ( VectorFieldType  type) [inline]

Definition at line 77 of file qgsvectorfieldsymbollayer.h.

References QgsSymbolLayerV2::type().

Referenced by create(), QgsVectorFieldSymbolLayerWidget::on_mCartesianRadioButton_toggled(), QgsVectorFieldSymbolLayerWidget::on_mHeightRadioButton_toggled(), and QgsVectorFieldSymbolLayerWidget::on_mPolarRadioButton_toggled().

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

Definition at line 71 of file qgsvectorfieldsymbollayer.h.

Referenced by create(), and QgsVectorFieldSymbolLayerWidget::on_mXAttributeComboBox_currentIndexChanged().

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

Definition at line 73 of file qgsvectorfieldsymbollayer.h.

Referenced by create(), and QgsVectorFieldSymbolLayerWidget::on_mYAttributeComboBox_currentIndexChanged().

void QgsVectorFieldSymbolLayer::startRender ( QgsSymbolV2RenderContext &  context) [virtual]

Implements QgsSymbolLayerV2.

Definition at line 146 of file qgsvectorfieldsymbollayer.cpp.

References QgsVectorLayer::fieldNameIndex(), QgsSymbolV2RenderContext::layer(), mLineSymbol, mXAttribute, mXIndex, mYAttribute, mYIndex, QgsSymbolV2RenderContext::renderContext(), and QgsSymbolV2::startRender().

void QgsVectorFieldSymbolLayer::stopRender ( QgsSymbolV2RenderContext &  context) [virtual]

Implements QgsSymbolLayerV2.

Definition at line 166 of file qgsvectorfieldsymbollayer.cpp.

References mLineSymbol, QgsSymbolV2RenderContext::renderContext(), and QgsSymbolV2::stopRender().

QgsSymbolV2* QgsVectorFieldSymbolLayer::subSymbol ( ) [inline, virtual]

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 197 of file qgsvectorfieldsymbollayer.cpp.

References mLineSymbol, and QgsSymbolV2::toSld().

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

Reimplemented from QgsSymbolLayerV2.

Definition at line 217 of file qgsvectorfieldsymbollayer.cpp.

References mXAttribute, and mYAttribute.

VectorFieldType QgsVectorFieldSymbolLayer::vectorFieldType ( ) const [inline]

Definition at line 78 of file qgsvectorfieldsymbollayer.h.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

QString QgsVectorFieldSymbolLayer::xAttribute ( ) const [inline]

Definition at line 72 of file qgsvectorfieldsymbollayer.h.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

QString QgsVectorFieldSymbolLayer::yAttribute ( ) const [inline]

Definition at line 74 of file qgsvectorfieldsymbollayer.h.

Referenced by QgsVectorFieldSymbolLayerWidget::setSymbolLayer().

Member Data Documentation

AngleOrientation QgsVectorFieldSymbolLayer::mAngleOrientation [private]

Definition at line 96 of file qgsvectorfieldsymbollayer.h.

Referenced by convertPolarToCartesian(), and properties().

AngleUnits QgsVectorFieldSymbolLayer::mAngleUnits [private]

Definition at line 97 of file qgsvectorfieldsymbollayer.h.

Referenced by convertPolarToCartesian(), and properties().

QgsSymbolV2::OutputUnit QgsVectorFieldSymbolLayer::mDistanceUnit [private]

Definition at line 93 of file qgsvectorfieldsymbollayer.h.

Referenced by outputUnit(), properties(), renderPoint(), and setOutputUnit().

QgsLineSymbolV2* QgsVectorFieldSymbolLayer::mLineSymbol [private]

Definition at line 99 of file qgsvectorfieldsymbollayer.h.

Referenced by clone(), drawPreviewIcon(), renderPoint(), setSubSymbol(), startRender(), stopRender(), and toSld().

double QgsVectorFieldSymbolLayer::mScale [private]

Definition at line 94 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), and renderPoint().

VectorFieldType QgsVectorFieldSymbolLayer::mVectorFieldType [private]

Definition at line 95 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), and renderPoint().

QString QgsVectorFieldSymbolLayer::mXAttribute [private]

Definition at line 91 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), startRender(), and usedAttributes().

int QgsVectorFieldSymbolLayer::mXIndex [private]

Definition at line 102 of file qgsvectorfieldsymbollayer.h.

Referenced by renderPoint(), and startRender().

QString QgsVectorFieldSymbolLayer::mYAttribute [private]

Definition at line 92 of file qgsvectorfieldsymbollayer.h.

Referenced by properties(), startRender(), and usedAttributes().

int QgsVectorFieldSymbolLayer::mYIndex [private]

Definition at line 103 of file qgsvectorfieldsymbollayer.h.

Referenced by renderPoint(), and startRender().

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines