QgsVectorFieldSymbolLayer Class Reference

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

#include <qgsvectorfieldsymbollayer.h>

Inheritance diagram for QgsVectorFieldSymbolLayer:

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

Public Member Functions
	QgsVectorFieldSymbolLayer ()
	~QgsVectorFieldSymbolLayer ()
QString	layerType () const
bool	setSubSymbol (QgsSymbolV2 *symbol)
QgsSymbolV2 *	subSymbol ()
void	renderPoint (const QPointF &point, QgsSymbolV2RenderContext &context)
void	startRender (QgsSymbolV2RenderContext &context)
void	stopRender (QgsSymbolV2RenderContext &context)
QgsSymbolLayerV2 *	clone () const
QgsStringMap	properties () const
void	toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
void	drawPreviewIcon (QgsSymbolV2RenderContext &context, QSize size)
QSet< QString >	usedAttributes () const
void	setXAttribute (const QString &attribute)
QString	xAttribute () const
void	setYAttribute (const QString &attribute)
QString	yAttribute () const
void	setScale (double s)
double	scale () const
void	setVectorFieldType (VectorFieldType type)
VectorFieldType	vectorFieldType () const
void	setAngleOrientation (AngleOrientation orientation)
AngleOrientation	angleOrientation () const
void	setAngleUnits (AngleUnits units)
AngleUnits	angleUnits () const
void	setOutputUnit (QgsSymbolV2::OutputUnit unit)
QgsSymbolV2::OutputUnit	outputUnit () const
void	setMapUnitScale (const QgsMapUnitScale &scale)
QgsMapUnitScale	mapUnitScale () const
void	setDistanceUnit (QgsSymbolV2::OutputUnit unit)
QgsSymbolV2::OutputUnit	distanceUnit () const
void	setDistanceMapUnitScale (const QgsMapUnitScale &scale)
const QgsMapUnitScale &	distanceMapUnitScale () const
Public Member Functions inherited from QgsMarkerSymbolLayerV2
void	setAngle (double angle)
double	angle () const
void	setSize (double size)
double	size () const
void	setScaleMethod (QgsSymbolV2::ScaleMethod scaleMethod)
QgsSymbolV2::ScaleMethod	scaleMethod () const
void	setOffset (QPointF offset)
QPointF	offset ()
virtual void	writeSldMarker (QDomDocument &doc, QDomElement &element, QgsStringMap props) const
void	setOffsetUnit (QgsSymbolV2::OutputUnit unit)
QgsSymbolV2::OutputUnit	offsetUnit () const
void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
const QgsMapUnitScale &	offsetMapUnitScale () const
void	setSizeUnit (QgsSymbolV2::OutputUnit unit)
QgsSymbolV2::OutputUnit	sizeUnit () const
void	setSizeMapUnitScale (const QgsMapUnitScale &scale)
const QgsMapUnitScale &	sizeMapUnitScale () const
void	setHorizontalAnchorPoint (HorizontalAnchorPoint h)
HorizontalAnchorPoint	horizontalAnchorPoint () const
void	setVerticalAnchorPoint (VerticalAnchorPoint v)
VerticalAnchorPoint	verticalAnchorPoint () const
Public Member Functions inherited from QgsSymbolLayerV2
virtual QColor	color () const
virtual void	setColor (const QColor &color)
virtual void	setOutlineColor (const QColor &color)
	Set outline color.
virtual QColor	outlineColor () const
	Get outline color.
virtual void	setFillColor (const QColor &color)
	Set fill color.
virtual QColor	fillColor () const
	Get fill color.
virtual	~QgsSymbolLayerV2 ()
virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
QgsSymbolV2::SymbolType	type () const
void	setLocked (bool locked)
bool	isLocked () const
virtual double	estimateMaxBleed () const
	Returns the estimated maximum distance which the layer style will bleed outside the drawn shape.
void	setRenderingPass (int renderingPass)
int	renderingPass () const
virtual const QgsExpression *	dataDefinedProperty (const QString &property) const
virtual QString	dataDefinedPropertyString (const QString &property) const
virtual void	setDataDefinedProperty (const QString &property, const QString &expressionString)
virtual void	removeDataDefinedProperty (const QString &property)
virtual void	removeDataDefinedProperties ()
bool	hasDataDefinedProperties () 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
virtual double	dxfWidth (const QgsDxfExport &e, const QgsSymbolV2RenderContext &context) const
virtual QColor	dxfColor (const QgsSymbolV2RenderContext &context) const
virtual QVector< qreal >	dxfCustomDashPattern (QgsSymbolV2::OutputUnit &unit) const
virtual Qt::PenStyle	dxfPenStyle () const
virtual QColor	dxfBrushColor (const QgsSymbolV2RenderContext &context) const
virtual Qt::BrushStyle	dxfBrushStyle () const

Static Public Member Functions
static QgsSymbolLayerV2 *	create (const QgsStringMap &properties=QgsStringMap())
static QgsSymbolLayerV2 *	createFromSld (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
double	mSize
QgsSymbolV2::OutputUnit	mSizeUnit
QgsMapUnitScale	mSizeMapUnitScale
QPointF	mOffset
QgsSymbolV2::OutputUnit	mOffsetUnit
QgsMapUnitScale	mOffsetMapUnitScale
QgsSymbolV2::ScaleMethod	mScaleMethod
HorizontalAnchorPoint	mHorizontalAnchorPoint
VerticalAnchorPoint	mVerticalAnchorPoint
Static Protected Attributes inherited from QgsSymbolLayerV2
static const bool	selectionIsOpaque = true
static const bool	selectFillBorder = false
static const bool	selectFillStyle = false

Detailed Description

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

Member Enumeration Documentation

enum QgsVectorFieldSymbolLayer::AngleOrientation

Enumerator:

ClockwiseFromNorth
CounterclockwiseFromEast

enum QgsVectorFieldSymbolLayer::AngleUnits

Enumerator:

Degrees
Radians

enum QgsVectorFieldSymbolLayer::VectorFieldType

Enumerator:

Cartesian
Polar
Height

Constructor & Destructor Documentation

QgsVectorFieldSymbolLayer::QgsVectorFieldSymbolLayer

(

)

QgsVectorFieldSymbolLayer::~QgsVectorFieldSymbolLayer

(

)

Member Function Documentation

AngleOrientation QgsVectorFieldSymbolLayer::angleOrientation ( ) const

inline

AngleUnits QgsVectorFieldSymbolLayer::angleUnits ( ) const

inline

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::clone ( ) const

virtual

Implements QgsSymbolLayerV2.

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

static

QgsSymbolLayerV2 * QgsVectorFieldSymbolLayer::createFromSld ( QDomElement &  element )

static

const QgsMapUnitScale& QgsVectorFieldSymbolLayer::distanceMapUnitScale ( ) const

inline

QgsSymbolV2::OutputUnit QgsVectorFieldSymbolLayer::distanceUnit ( ) const

inline

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

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

QString QgsVectorFieldSymbolLayer::layerType ( ) const

inlinevirtual

Implements QgsSymbolLayerV2.

QgsMapUnitScale QgsVectorFieldSymbolLayer::mapUnitScale ( ) const

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

QgsSymbolV2::OutputUnit QgsVectorFieldSymbolLayer::outputUnit ( ) const

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

QgsStringMap QgsVectorFieldSymbolLayer::properties ( ) const

virtual

Implements QgsSymbolLayerV2.

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

virtual

Implements QgsMarkerSymbolLayerV2.

double QgsVectorFieldSymbolLayer::scale ( ) const

inline

void QgsVectorFieldSymbolLayer::setAngleOrientation ( AngleOrientation  orientation )

inline

void QgsVectorFieldSymbolLayer::setAngleUnits ( AngleUnits  units )

inline

void QgsVectorFieldSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale &  scale )

inline

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

inline

void QgsVectorFieldSymbolLayer::setMapUnitScale ( const QgsMapUnitScale &  scale )

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

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

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

void QgsVectorFieldSymbolLayer::setScale ( double  s )

inline

bool QgsVectorFieldSymbolLayer::setSubSymbol ( QgsSymbolV2 *  symbol )

virtual

Reimplemented from QgsSymbolLayerV2.

void QgsVectorFieldSymbolLayer::setVectorFieldType ( VectorFieldType  type )

inline

void QgsVectorFieldSymbolLayer::setXAttribute ( const QString &  attribute )

inline

void QgsVectorFieldSymbolLayer::setYAttribute ( const QString &  attribute )

inline

void QgsVectorFieldSymbolLayer::startRender ( QgsSymbolV2RenderContext &  context )

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

void QgsVectorFieldSymbolLayer::stopRender ( QgsSymbolV2RenderContext &  context )

virtual

Implements QgsSymbolLayerV2.

QgsSymbolV2* QgsVectorFieldSymbolLayer::subSymbol ( )

inlinevirtual

Reimplemented from QgsSymbolLayerV2.

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

virtual

Reimplemented from QgsMarkerSymbolLayerV2.

QSet< QString > QgsVectorFieldSymbolLayer::usedAttributes ( ) const

virtual

Reimplemented from QgsSymbolLayerV2.

VectorFieldType QgsVectorFieldSymbolLayer::vectorFieldType ( ) const

inline

QString QgsVectorFieldSymbolLayer::xAttribute ( ) const

inline

QString QgsVectorFieldSymbolLayer::yAttribute ( ) const

inline

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgsvectorfieldsymbollayer.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgsvectorfieldsymbollayer.cpp