mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
f3cb57b1eb
- update methods of existing classes - add comment to methods missing in the sip bindings - split up collective sip files into single files and use same directory structure in python/ as in src/ - add a lot of missing classes (some might not make sense because of missing python methods in those classes) - remove some non-existing methods from the header files - add scripts/sipdiff - replace some usages of std::vector and std::set with QVector/QSet
88 lines
4.2 KiB
Plaintext
88 lines
4.2 KiB
Plaintext
|
|
/**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*/
|
|
class QgsRenderer
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgsrenderer.h>
|
|
#include <qgssinglesymbolrenderer.h>
|
|
#include <qgsuniquevaluerenderer.h>
|
|
#include <qgsgraduatedsymbolrenderer.h>
|
|
#include <qgscontinuouscolorrenderer.h>
|
|
%End
|
|
|
|
%ConvertToSubClassCode
|
|
if (dynamic_cast<QgsSingleSymbolRenderer*>(sipCpp) != NULL)
|
|
sipClass = sipClass_QgsSingleSymbolRenderer;
|
|
else if (dynamic_cast<QgsUniqueValueRenderer*>(sipCpp) != NULL)
|
|
sipClass = sipClass_QgsUniqueValueRenderer;
|
|
else if (dynamic_cast<QgsGraduatedSymbolRenderer*>(sipCpp) != NULL)
|
|
sipClass = sipClass_QgsGraduatedSymbolRenderer;
|
|
else if (dynamic_cast<QgsContinuousColorRenderer*>(sipCpp) != NULL)
|
|
sipClass = sipClass_QgsContinuousColorRenderer;
|
|
else
|
|
sipClass = 0;
|
|
%End
|
|
|
|
|
|
public:
|
|
/** Default ctor sets up selection color from project properties */
|
|
QgsRenderer();
|
|
/** Virtual destructor because we have virtual methods... */
|
|
virtual ~QgsRenderer();
|
|
/** Determines if a feature will be rendered or not
|
|
@param f a pointer to the feature to determine if rendering will happen*/
|
|
virtual bool willRenderFeature( QgsFeature *f );
|
|
/**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 img a pointer to picture
|
|
@param selected feature is selected
|
|
@param widthScale scale
|
|
@param rasterScaleFactor raster scale
|
|
@note deprecated */
|
|
void renderFeature( QPainter* p, QgsFeature& f, QImage* img, bool selected, double widthScale = 1.0, double rasterScaleFactor = 1.0 ) /Deprecated/;
|
|
|
|
/**A vector layer passes features to a renderer object to change the brush ans pen of the qpainter
|
|
@note added in 1.2 */
|
|
void renderFeature( QgsRenderContext &renderContext, QgsFeature& f, QImage* pic, bool selected );
|
|
|
|
virtual void renderFeature( QgsRenderContext &renderContext, QgsFeature& f, QImage* pic, bool selected, double opacity ) = 0;
|
|
|
|
/**Reads the renderer configuration from an XML file
|
|
@param rnode the Dom node to read
|
|
@param vl the vector layer which will be associated with the renderer
|
|
@return 0 in case of success, 1 if vector layer has no renderer, 2 if classification field not found*/
|
|
virtual int 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 QgsVectorLayer& vl ) 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*/
|
|
virtual QList<int> classificationAttributes() const = 0;
|
|
/**Returns the renderers name*/
|
|
virtual QString name() const = 0;
|
|
/**Return symbology items*/
|
|
virtual const QList<QgsSymbol*> symbols() const = 0;
|
|
/**Returns a copy of the renderer (a deep copy on the heap)*/
|
|
virtual QgsRenderer* clone() const = 0 /Factory/;
|
|
/** Change selection color */
|
|
static void setSelectionColor( QColor color );
|
|
/** Get selection color. Added in QGIS v1.4 */
|
|
static QColor selectionColor();
|
|
/**Returns true if this renderer returns a pixmap in the render method (e.g. for point data or diagrams)*/
|
|
virtual bool containsPixmap() const;
|
|
/**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;
|
|
|
|
/**Returns renderer symbol for a feature.
|
|
@note: this method was added in version 1.6*/
|
|
virtual QgsSymbol* symbolForFeature( const QgsFeature* f );
|
|
|
|
/**Scales a brush to a given raster scale factor (e.g. for printing)*/
|
|
static void scaleBrush( QBrush& b, double rasterScaleFactor );
|
|
};
|
|
|