QGIS/python/core/symbology-ng/qgsarrowsymbollayer.sip
Nyall Dawson d75eaff573 Fixes to arrow line symbology:
- Fix crash in Python bindings caused by subsymbol ownership
- Make symbol work correctly with categorised and graduated
renderers
2016-05-05 16:56:20 +10:00

115 lines
3.9 KiB
Plaintext

class QgsArrowSymbolLayer : public QgsLineSymbolLayerV2
{
%TypeHeaderCode
#include <qgsarrowsymbollayer.h>
%End
public:
/** Simple constructor */
QgsArrowSymbolLayer();
/**
* Create a new QgsArrowSymbolLayer
*
* @param properties A property map to deserialize saved information from properties()
*
* @return A new QgsArrowSymbolLayer
*/
static QgsSymbolLayerV2* create( const QgsStringMap& properties ) /Factory/;
/** Virtual constructor */
virtual QgsArrowSymbolLayer* clone() const /Factory/;
/** Get the sub symbol used for filling */
virtual QgsSymbolV2* subSymbol();
/** Set the sub symbol used for filling */
virtual bool setSubSymbol( QgsSymbolV2* symbol /Transfer/ );
/** Return a list of attributes required to render this feature */
virtual QSet<QString> usedAttributes() const;
/** Get current arrow width */
double arrowWidth() const;
/** Set the arrow width */
void setArrowWidth( double w );
/** Get the unit for the arrow width */
QgsSymbolV2::OutputUnit arrowWidthUnit() const;
/** Set the unit for the arrow width */
void setArrowWidthUnit( QgsSymbolV2::OutputUnit u );
/** Get the scale for the arrow width */
QgsMapUnitScale arrowWidthUnitScale() const;
/** Set the scale for the arrow width */
void setArrowWidthUnitScale( const QgsMapUnitScale& s );
/** Get current arrow start width. Only meaningfull for single headed arrows */
double arrowStartWidth() const;
/** Set the arrow start width */
void setArrowStartWidth( double w );
/** Get the unit for the arrow start width */
QgsSymbolV2::OutputUnit arrowStartWidthUnit() const;
/** Set the unit for the arrow start width */
void setArrowStartWidthUnit( QgsSymbolV2::OutputUnit u );
/** Get the scale for the arrow start width */
QgsMapUnitScale arrowStartWidthUnitScale() const;
/** Set the scale for the arrow start width */
void setArrowStartWidthUnitScale( const QgsMapUnitScale& s );
/** Get the current arrow head size */
double headSize() const;
/** Set the arrow head size */
void setHeadSize( double s );
/** Get the unit for the head size */
QgsSymbolV2::OutputUnit headSizeUnit() const;
/** Set the unit for the head size */
void setHeadSizeUnit( QgsSymbolV2::OutputUnit u );
/** Get the scale for the head size */
QgsMapUnitScale headSizeUnitScale() const;
/** Set the scale for the head size */
void setHeadSizeUnitScale( const QgsMapUnitScale& s );
/** Return whether it is a curved arrow or a straight one */
bool isCurved() const;
/** Set whether it is a curved arrow or a straight one */
void setIsCurved( bool isCurved );
/** Possible head types */
enum HeadType
{
HeadSingle, //< One single head at the end
HeadReversed, //< One single head at the beginning
HeadDouble //< Two heads
};
/** Get the current head type */
HeadType headType() const;
/** Set the head type */
void setHeadType( HeadType t );
/**
* Should be reimplemented by subclasses to return a string map that
* contains the configuration information for the symbol layer. This
* is used to serialize a symbol layer perstistently.
*/
QgsStringMap properties() const;
/**
* Returns a string that represents this layer type. Used for serialization.
* Should match with the string used to register this symbol layer in the registry.
*/
QString layerType() const;
/** Prepare the rendering */
void startRender( QgsSymbolV2RenderContext& context );
/** End of the rendering */
void stopRender( QgsSymbolV2RenderContext& context );
/** Main drawing method */
void renderPolyline( const QPolygonF& points, QgsSymbolV2RenderContext& context );
void setColor( const QColor& c );
private:
QgsArrowSymbolLayer( const QgsArrowSymbolLayer& );
};