2007-01-09 02:39:15 +00:00
/**Abstract base class for renderers. A renderer holds all the information necessary to draw the contents of a vector layer to a map canvas. The vector layer then passes each feature to paint to the renderer*/
2007-05-31 00:19:27 +00:00
class QgsRenderer
2007-01-09 02:39:15 +00:00
{
%TypeHeaderCode
#include <qgsrenderer.h>
%End
public:
/** Default ctor sets up selection colour from project properties */
QgsRenderer();
/** Virtual destructor because we have virtual methods... */
virtual ~QgsRenderer();
/**A vector layer passes features to a renderer object to change the brush and pen of the qpainter
@param p the painter storing brush and pen
@param f a pointer to the feature to be rendered
@param pic pointer to a marker from SVG (is only used by marker renderers)
@param scalefactor pointer to the scale factor for the marker image*/
2008-05-15 08:13:05 +00:00
virtual void renderFeature(QPainter* p, QgsFeature& f,QImage* pic, bool selected, double widthScale = 1.0, double rasterScaleFactor = 1.0)=0;
2007-01-09 02:39:15 +00:00
/**Reads the renderer configuration from an XML file
2008-08-23 09:19:49 +00:00
@param rnode the Dom node to read
2007-01-09 02:39:15 +00:00
@param vl the vector layer which will be associated with the renderer*/
virtual void readXML(const QDomNode& rnode, QgsVectorLayer& vl)=0;
/**Writes the contents of the renderer to a configuration file
@ return true in case of success*/
virtual bool writeXML( QDomNode & layer_node, QDomDocument & document ) const=0;
/** Returns true, if attribute values are used by the renderer and false otherwise*/
virtual bool needsAttributes() const=0;
/**Returns a list with indexes of classification attributes*/
2007-05-31 00:19:27 +00:00
virtual QList<int> classificationAttributes() const=0;
2007-01-09 02:39:15 +00:00
/**Returns the renderers name*/
virtual QString name() const=0;
/**Return symbology items*/
2007-04-02 17:41:47 +00:00
virtual const QList<QgsSymbol*> symbols() const=0;
2007-01-09 02:39:15 +00:00
/**Returns a copy of the renderer (a deep copy on the heap)*/
virtual QgsRenderer* clone() const=0;
/** Change selection color */
static void setSelectionColor(QColor color);
/**Returns true if this renderer returns a pixmap in the render method (e.g. for point data or diagrams)*/
virtual bool containsPixmap() const;
2007-05-30 10:02:12 +00:00
/**Returns true if this renderer uses its own transparency settings, e.g. differentiated by classification.
This is a hint for QgsVectorLayer to not use the transparency setting on layer level in this cases*/
virtual bool usesTransparency() const;
2007-01-09 02:39:15 +00:00
};