mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
This change is being driven by: - need for consistent terminology in the api. Currently there's a confusing mix of border/outline used - need for consistent terminology in the gui - we have a mix of "border"/"outline"/"pen" - bringing QGIS into line with the standard terminology used in other graphic editing programs
291 lines
9.6 KiB
Plaintext
291 lines
9.6 KiB
Plaintext
class QgsSimpleLineSymbolLayer : QgsLineSymbolLayer
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgslinesymbollayer.h>
|
|
%End
|
|
|
|
public:
|
|
QgsSimpleLineSymbolLayer( const QColor& color = DEFAULT_SIMPLELINE_COLOR,
|
|
double width = DEFAULT_SIMPLELINE_WIDTH,
|
|
Qt::PenStyle penStyle = DEFAULT_SIMPLELINE_PENSTYLE );
|
|
|
|
// static stuff
|
|
|
|
static QgsSymbolLayer* create( const QgsStringMap& properties = QgsStringMap() ) /Factory/;
|
|
static QgsSymbolLayer* createFromSld( QDomElement &element ) /Factory/;
|
|
|
|
// implemented from base classes
|
|
|
|
QString layerType() const;
|
|
|
|
void startRender( QgsSymbolRenderContext& context );
|
|
|
|
void stopRender( QgsSymbolRenderContext& context );
|
|
|
|
void renderPolyline( const QPolygonF& points, QgsSymbolRenderContext& context );
|
|
|
|
//overridden so that clip path can be set when using draw inside polygon option
|
|
void renderPolygonStroke( const QPolygonF& points, QList<QPolygonF>* rings, QgsSymbolRenderContext& context );
|
|
|
|
QgsStringMap properties() const;
|
|
|
|
virtual QgsSimpleLineSymbolLayer* clone() const /Factory/;
|
|
|
|
void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap& props ) const;
|
|
|
|
QString ogrFeatureStyle( double mmScaleFactor, double mapUnitScaleFactor ) const;
|
|
|
|
void setOutputUnit( QgsUnitTypes::RenderUnit unit );
|
|
QgsUnitTypes::RenderUnit outputUnit() const;
|
|
|
|
void setMapUnitScale( const QgsMapUnitScale &scale );
|
|
QgsMapUnitScale mapUnitScale() const;
|
|
|
|
double estimateMaxBleed( const QgsRenderContext& context ) const;
|
|
|
|
// new stuff
|
|
|
|
Qt::PenStyle penStyle() const;
|
|
void setPenStyle( Qt::PenStyle style );
|
|
|
|
Qt::PenJoinStyle penJoinStyle() const;
|
|
void setPenJoinStyle( Qt::PenJoinStyle style );
|
|
|
|
Qt::PenCapStyle penCapStyle() const;
|
|
void setPenCapStyle( Qt::PenCapStyle style );
|
|
|
|
bool useCustomDashPattern() const;
|
|
void setUseCustomDashPattern( bool b );
|
|
|
|
/** Sets the units for lengths used in the custom dash pattern.
|
|
* @param unit length units
|
|
* @see customDashPatternUnit()
|
|
*/
|
|
void setCustomDashPatternUnit( QgsUnitTypes::RenderUnit unit );
|
|
|
|
/** Returns the units for lengths used in the custom dash pattern.
|
|
* @see setCustomDashPatternUnit()
|
|
*/
|
|
QgsUnitTypes::RenderUnit customDashPatternUnit() const;
|
|
|
|
const QgsMapUnitScale& customDashPatternMapUnitScale() const;
|
|
void setCustomDashPatternMapUnitScale( const QgsMapUnitScale& scale);
|
|
|
|
QVector<qreal> customDashVector() const;
|
|
void setCustomDashVector( const QVector<qreal>& vector );
|
|
|
|
//Returns true if the line should only be drawn inside the polygon
|
|
bool drawInsidePolygon() const;
|
|
//Set to true if the line should only be drawn inside the polygon
|
|
void setDrawInsidePolygon( bool drawInsidePolygon );
|
|
|
|
QVector<qreal> dxfCustomDashPattern( QgsUnitTypes::RenderUnit& unit ) const;
|
|
Qt::PenStyle dxfPenStyle() const;
|
|
|
|
double dxfWidth( const QgsDxfExport& e, QgsSymbolRenderContext &context ) const;
|
|
double dxfOffset( const QgsDxfExport& e, QgsSymbolRenderContext& context ) const;
|
|
QColor dxfColor( QgsSymbolRenderContext& context ) const;
|
|
};
|
|
|
|
/////////
|
|
|
|
class QgsMarkerLineSymbolLayer : QgsLineSymbolLayer
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgslinesymbollayer.h>
|
|
%End
|
|
|
|
public:
|
|
QgsMarkerLineSymbolLayer( bool rotateMarker = DEFAULT_MARKERLINE_ROTATE,
|
|
double interval = DEFAULT_MARKERLINE_INTERVAL );
|
|
|
|
~QgsMarkerLineSymbolLayer();
|
|
|
|
/**
|
|
* Defines how/where the marker should be placed on the line
|
|
*/
|
|
enum Placement
|
|
{
|
|
Interval,
|
|
Vertex,
|
|
LastVertex,
|
|
FirstVertex,
|
|
CentralPoint,
|
|
CurvePoint
|
|
};
|
|
|
|
// static stuff
|
|
|
|
/**
|
|
* Create a new MarkerLineSymbolLayerV2
|
|
*
|
|
* @param properties A property map to deserialize saved information from properties()
|
|
*
|
|
* @return A new MarkerLineSymbolLayerV2
|
|
*/
|
|
static QgsSymbolLayer* create( const QgsStringMap& properties = QgsStringMap() ) /Factory/;
|
|
|
|
/**
|
|
* Create a new MarkerLineSymbolLayerV2 from SLD
|
|
*
|
|
* @param element An SLD XML DOM element
|
|
*
|
|
* @return A new MarkerLineSymbolLayerV2
|
|
*/
|
|
static QgsSymbolLayer* createFromSld( QDomElement &element ) /Factory/;
|
|
|
|
// implemented from base classes
|
|
|
|
QString layerType() const;
|
|
|
|
void startRender( QgsSymbolRenderContext& context );
|
|
|
|
void stopRender( QgsSymbolRenderContext& context );
|
|
|
|
void renderPolyline( const QPolygonF& points, QgsSymbolRenderContext& context );
|
|
|
|
void renderPolygonStroke( const QPolygonF& points, QList<QPolygonF>* rings, QgsSymbolRenderContext& context );
|
|
|
|
QgsStringMap properties() const;
|
|
|
|
virtual QgsMarkerLineSymbolLayer* clone() const;
|
|
|
|
void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap& props ) const;
|
|
|
|
void setColor( const QColor& color );
|
|
virtual QColor color() const;
|
|
|
|
QgsSymbol* subSymbol();
|
|
bool setSubSymbol( QgsSymbol* symbol /Transfer/);
|
|
|
|
virtual void setWidth( double width );
|
|
virtual double width() const;
|
|
|
|
double estimateMaxBleed( const QgsRenderContext& context ) const;
|
|
|
|
// new stuff
|
|
|
|
/**
|
|
* Shall the marker be rotated.
|
|
*
|
|
* @return True if the marker should be rotated.
|
|
*/
|
|
bool rotateMarker() const;
|
|
|
|
/**
|
|
* Shall the marker be rotated.
|
|
*/
|
|
void setRotateMarker( bool rotate );
|
|
|
|
/**
|
|
* Returns the interval between individual markers. Units are specified through intervalUnits().
|
|
* @see setInterval()
|
|
* @see intervalUnit()
|
|
*/
|
|
double interval() const;
|
|
|
|
/**
|
|
* Sets the interval between individual markers.
|
|
* @param interval interval size. Units are specified through setIntervalUnits()
|
|
* @see interval()
|
|
* @see setIntervalUnits()
|
|
*/
|
|
void setInterval( double interval );
|
|
|
|
/**
|
|
* The placement of the markers.
|
|
*/
|
|
Placement placement() const;
|
|
|
|
/**
|
|
* The placement of the markers.
|
|
*/
|
|
void setPlacement( Placement p );
|
|
|
|
/** Returns the offset along the line for the marker placement. For Interval placements, this is the distance
|
|
* between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the
|
|
* distance between the marker and the start of the line or the end of the line respectively.
|
|
* This setting has no effect for Vertex or CentralPoint placements.
|
|
* @returns The offset along the line. The unit for the offset is retrievable via offsetAlongLineUnit.
|
|
* @note added in 2.3
|
|
* @see setOffsetAlongLine
|
|
* @see offsetAlongLineUnit
|
|
* @see placement
|
|
*/
|
|
double offsetAlongLine() const;
|
|
|
|
/** Sets the the offset along the line for the marker placement. For Interval placements, this is the distance
|
|
* between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the
|
|
* distance between the marker and the start of the line or the end of the line respectively.
|
|
* This setting has no effect for Vertex or CentralPoint placements.
|
|
* @param offsetAlongLine Distance to offset markers along the line. The offset
|
|
* unit is set via setOffsetAlongLineUnit.
|
|
* @note added in 2.3
|
|
* @see offsetAlongLine
|
|
* @see setOffsetAlongLineUnit
|
|
* @see setPlacement
|
|
*/
|
|
void setOffsetAlongLine( double offsetAlongLine );
|
|
|
|
/** Returns the unit used for calculating the offset along line for markers.
|
|
* @returns Offset along line unit type.
|
|
* @see setOffsetAlongLineUnit
|
|
* @see offsetAlongLine
|
|
*/
|
|
QgsUnitTypes::RenderUnit offsetAlongLineUnit() const;
|
|
|
|
/** Sets the unit used for calculating the offset along line for markers.
|
|
* @param unit Offset along line unit type.
|
|
* @see offsetAlongLineUnit
|
|
* @see setOffsetAlongLine
|
|
*/
|
|
void setOffsetAlongLineUnit( QgsUnitTypes::RenderUnit unit );
|
|
|
|
/** Returns the map unit scale used for calculating the offset in map units along line for markers.
|
|
* @returns Offset along line map unit scale.
|
|
*/
|
|
const QgsMapUnitScale& offsetAlongLineMapUnitScale() const;
|
|
|
|
/** Sets the map unit scale used for calculating the offset in map units along line for markers.
|
|
* @param scale Offset along line map unit scale.
|
|
*/
|
|
void setOffsetAlongLineMapUnitScale( const QgsMapUnitScale& scale );
|
|
|
|
/** Sets the units for the interval between markers.
|
|
* @param unit interval units
|
|
* @see intervalUnit()
|
|
* @see setInterval()
|
|
*/
|
|
void setIntervalUnit( QgsUnitTypes::RenderUnit unit );
|
|
|
|
/** Returns the units for the interval between markers.
|
|
* @see setIntervalUnit()
|
|
* @see interval()
|
|
*/
|
|
QgsUnitTypes::RenderUnit intervalUnit() const;
|
|
|
|
void setIntervalMapUnitScale( const QgsMapUnitScale& scale );
|
|
const QgsMapUnitScale& intervalMapUnitScale() const;
|
|
|
|
void setOutputUnit( QgsUnitTypes::RenderUnit unit );
|
|
QgsUnitTypes::RenderUnit outputUnit() const;
|
|
|
|
void setMapUnitScale( const QgsMapUnitScale& scale );
|
|
QgsMapUnitScale mapUnitScale() const;
|
|
|
|
QSet<QString> usedAttributes( const QgsRenderContext& context ) const;
|
|
|
|
void setDataDefinedProperty( QgsSymbolLayer::Property key, const QgsProperty& property );
|
|
|
|
protected:
|
|
|
|
void renderPolylineInterval( const QPolygonF& points, QgsSymbolRenderContext& context );
|
|
void renderPolylineVertex( const QPolygonF& points, QgsSymbolRenderContext& context, Placement placement = Vertex );
|
|
void renderPolylineCentral( const QPolygonF& points, QgsSymbolRenderContext& context );
|
|
double markerAngle( const QPolygonF& points, bool isRing, int vertex );
|
|
|
|
private:
|
|
|
|
QgsMarkerLineSymbolLayer( const QgsMarkerLineSymbolLayer& other );
|
|
};
|