QgsContinuousColorRenderer Class Reference

Renderer class which interpolates rgb values linear between the minimum and maximum value of the classification field. More...

#include <qgscontinuouscolorrenderer.h>

Inheritance diagram for QgsContinuousColorRenderer:

Collaboration diagram for QgsContinuousColorRenderer:

List of all members.

Public Member Functions
	QgsContinuousColorRenderer (QGis::GeometryType type)
	QgsContinuousColorRenderer (const QgsContinuousColorRenderer &other)
virtual	~QgsContinuousColorRenderer ()
QgsAttributeList	classificationAttributes () const
	Returns a list with the index of the classification attribute.
int	classificationField () const
	Returns the number of the classification field.
QgsRenderer *	clone () const
	Returns a copy of the renderer (a deep copy on the heap)
bool	drawPolygonOutline () const
	whether to draw a polygon outline
const QgsSymbol *	maximumSymbol () const
	Returns the symbol for the maximum value.
const QgsSymbol *	minimumSymbol () const
	Returns the symbol for the minimum value.
QString	name () const
	Returns the renderers name.
bool	needsAttributes () const
	Returns true.
QgsContinuousColorRenderer &	operator= (const QgsContinuousColorRenderer &other)
virtual int	readXML (const QDomNode &rnode, QgsVectorLayer &vl)
	Reads the renderer configuration from an XML file.
void	renderFeature (QgsRenderContext &renderContext, QgsFeature &f, QImage *img, bool selected, double opacity=1.0)
	Renders the feature using the minimum and maximum value of the classification field added in 1.2.
void	setClassificationField (int id)
	Sets the id of the classification field.
void	setDrawPolygonOutline (bool draw)
	Sets whether to draw the polygon outline.
void	setMaximumSymbol (QgsSymbol *sy)
	Sets the symbol for the maximum value.
void	setMinimumSymbol (QgsSymbol *sy)
	Sets the symbol for the minimum value.
const QList< QgsSymbol * >	symbols () const
	Return symbology items.
virtual bool	writeXML (QDomNode &layer_node, QDomDocument &document, const QgsVectorLayer &vl) const
	Writes the contents of the renderer to a configuration file @ return true in case of success.
Protected Attributes
int	mClassificationField
	Number of the classification field (it must be a numerical field)
bool	mDrawPolygonOutline
	Whether to draw the polygon outline or not.
QgsSymbol *	mMaximumSymbol
	Item for the maximum value.
QgsSymbol *	mMinimumSymbol
	Item for the minimum value.

---

Detailed Description

Renderer class which interpolates rgb values linear between the minimum and maximum value of the classification field.

Definition at line 30 of file qgscontinuouscolorrenderer.h.

---

Constructor & Destructor Documentation

QgsContinuousColorRenderer::QgsContinuousColorRenderer

(

QGis::GeometryType

type

)

Definition at line 31 of file qgscontinuouscolorrenderer.cpp.

References QgsRenderer::mGeometryType.

Referenced by clone().

QgsContinuousColorRenderer::QgsContinuousColorRenderer

(

const QgsContinuousColorRenderer &

other

)

Definition at line 36 of file qgscontinuouscolorrenderer.cpp.

References mClassificationField, QgsRenderer::mGeometryType, mMaximumSymbol, and mMinimumSymbol.

QgsContinuousColorRenderer::~QgsContinuousColorRenderer

(

)

[virtual]

Definition at line 58 of file qgscontinuouscolorrenderer.cpp.

References mMaximumSymbol, and mMinimumSymbol.

---

Member Function Documentation

QgsAttributeList QgsContinuousColorRenderer::classificationAttributes

(

)

const [virtual]

Returns a list with the index of the classification attribute.

Implements QgsRenderer.

Definition at line 244 of file qgscontinuouscolorrenderer.cpp.

References mClassificationField.

int QgsContinuousColorRenderer::classificationField

(

)

const [inline]

Returns the number of the classification field.

Definition at line 87 of file qgscontinuouscolorrenderer.h.

References mClassificationField.

Referenced by readXML().

QgsRenderer * QgsContinuousColorRenderer::clone

(

)

const [virtual]

Returns a copy of the renderer (a deep copy on the heap)

Implements QgsRenderer.

Definition at line 310 of file qgscontinuouscolorrenderer.cpp.

References QgsContinuousColorRenderer().

bool QgsContinuousColorRenderer::drawPolygonOutline

(

)

const [inline]

whether to draw a polygon outline

Definition at line 57 of file qgscontinuouscolorrenderer.h.

const QgsSymbol * QgsContinuousColorRenderer::maximumSymbol

(

)

const [inline]

Returns the symbol for the maximum value.

Definition at line 102 of file qgscontinuouscolorrenderer.h.

References mMaximumSymbol.

const QgsSymbol * QgsContinuousColorRenderer::minimumSymbol

(

)

const [inline]

Returns the symbol for the minimum value.

Definition at line 97 of file qgscontinuouscolorrenderer.h.

References mMinimumSymbol.

QString QgsContinuousColorRenderer::name

(

)

const [virtual]

Returns the renderers name.

Implements QgsRenderer.

Definition at line 251 of file qgscontinuouscolorrenderer.cpp.

bool QgsContinuousColorRenderer::needsAttributes

(

)

const [inline, virtual]

Returns true.

Implements QgsRenderer.

Definition at line 107 of file qgscontinuouscolorrenderer.h.

QgsContinuousColorRenderer & QgsContinuousColorRenderer::operator=

(

const QgsContinuousColorRenderer &

other

)

Definition at line 44 of file qgscontinuouscolorrenderer.cpp.

References mClassificationField, QgsRenderer::mGeometryType, mMaximumSymbol, and mMinimumSymbol.

int QgsContinuousColorRenderer::readXML	(	const QDomNode &	rnode,
		QgsVectorLayer &	vl
	)		[virtual]

Reads the renderer configuration from an XML file.

Parameters:

rnode	the Dom node to read
vl	the vector layer which will be associated with the renderer

Returns:

0 in case of success, 1 if vector layer has no renderer, 2 if classification field not found

Implements QgsRenderer.

Definition at line 193 of file qgscontinuouscolorrenderer.cpp.

References classificationField(), QgsVectorLayer::dataProvider(), QgsVectorLayer::fieldNameIndex(), QgsVectorLayer::geometryType(), mDrawPolygonOutline, QgsRenderer::mGeometryType, QgsSymbol::readXML(), setClassificationField(), setMaximumSymbol(), setMinimumSymbol(), and QgsVectorLayer::setRenderer().

void QgsContinuousColorRenderer::renderFeature	(	QgsRenderContext &	renderContext,
		QgsFeature &	f,
		QImage *	img,
		bool	selected,
		double	opacity = 1.0
	)		[virtual]

Renders the feature using the minimum and maximum value of the classification field added in 1.2.

Implements QgsRenderer.

Definition at line 76 of file qgscontinuouscolorrenderer.cpp.

References QgsFeature::attributes(), QgsSymbol::brush(), QgsSymbol::fillColor(), QgsMarkerCatalogue::imageMarker(), QgsMarkerCatalogue::instance(), isNull(), QGis::Line, QgsSymbol::lowerValue(), mClassificationField, mDrawPolygonOutline, QgsRenderer::mGeometryType, mMaximumSymbol, mMinimumSymbol, QgsRenderer::mSelectionColor, QgsRenderContext::painter(), QgsSymbol::pen(), QGis::Point, QgsSymbol::pointSize(), QgsSymbol::pointSymbolName(), QGis::Polygon, QgsRenderContext::rasterScaleFactor(), and QgsRenderContext::scaleFactor().

void QgsContinuousColorRenderer::setClassificationField

(

int

id

)

[inline]

Sets the id of the classification field.

Definition at line 92 of file qgscontinuouscolorrenderer.h.

References mClassificationField.

Referenced by readXML().

void QgsContinuousColorRenderer::setDrawPolygonOutline

(

bool

draw

)

[inline]

Sets whether to draw the polygon outline.

Definition at line 51 of file qgscontinuouscolorrenderer.h.

void QgsContinuousColorRenderer::setMaximumSymbol

(

QgsSymbol *

sy

)

Sets the symbol for the maximum value.

The symbol has to be created using the new operator and is automatically deleted when inserting a new symbol or when the instance is destroyed

Definition at line 70 of file qgscontinuouscolorrenderer.cpp.

References mMaximumSymbol.

Referenced by readXML().

void QgsContinuousColorRenderer::setMinimumSymbol

(

QgsSymbol *

sy

)

Sets the symbol for the minimum value.

The symbol has to be created using the new operator and is automatically deleted when inserting a new symbol or when the instance is destroyed

Definition at line 64 of file qgscontinuouscolorrenderer.cpp.

References mMinimumSymbol.

Referenced by readXML().

const QList< QgsSymbol * > QgsContinuousColorRenderer::symbols

(

)

const [virtual]

Return symbology items.

Implements QgsRenderer.

Definition at line 302 of file qgscontinuouscolorrenderer.cpp.

References mMaximumSymbol, and mMinimumSymbol.

bool QgsContinuousColorRenderer::writeXML	(	QDomNode &	layer_node,
		QDomDocument &	document,
		const QgsVectorLayer &	vl
	)		const [virtual]

Writes the contents of the renderer to a configuration file @ return true in case of success.

Implements QgsRenderer.

Definition at line 256 of file qgscontinuouscolorrenderer.cpp.

References QgsFields::count(), QgsVectorLayer::dataProvider(), mClassificationField, mDrawPolygonOutline, mMaximumSymbol, mMinimumSymbol, QgsVectorLayer::pendingFields(), and QgsSymbol::writeXML().

---

Member Data Documentation

int QgsContinuousColorRenderer::mClassificationField [protected]

Number of the classification field (it must be a numerical field)

Definition at line 78 of file qgscontinuouscolorrenderer.h.

Referenced by classificationAttributes(), classificationField(), operator=(), QgsContinuousColorRenderer(), renderFeature(), setClassificationField(), and writeXML().

bool QgsContinuousColorRenderer::mDrawPolygonOutline [protected]

Whether to draw the polygon outline or not.

Definition at line 84 of file qgscontinuouscolorrenderer.h.

Referenced by readXML(), renderFeature(), and writeXML().

QgsSymbol* QgsContinuousColorRenderer::mMaximumSymbol [protected]

Item for the maximum value.

Definition at line 82 of file qgscontinuouscolorrenderer.h.

Referenced by maximumSymbol(), operator=(), QgsContinuousColorRenderer(), renderFeature(), setMaximumSymbol(), symbols(), writeXML(), and ~QgsContinuousColorRenderer().

QgsSymbol* QgsContinuousColorRenderer::mMinimumSymbol [protected]

Item for the minimum value.

Definition at line 80 of file qgscontinuouscolorrenderer.h.

Referenced by minimumSymbol(), operator=(), QgsContinuousColorRenderer(), renderFeature(), setMinimumSymbol(), symbols(), writeXML(), and ~QgsContinuousColorRenderer().

---

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

• src/core/renderer/qgscontinuouscolorrenderer.h
• src/core/renderer/qgscontinuouscolorrenderer.cpp