sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-06-18 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

[FEATURE] Add a secondary stroke color to QgsRubberBand (#4301)

Browse Source 
This comes in handy when in need of insure visibility of a
marker/line/polygon overlay over both light and dark areas.
This also updates the map view's extent to make use of a
secondary stroke color instead of a semi-transparent fill.
This commit is contained in:
Mathieu Pellerin 2017-03-24 14:49:37 +07:00 committed by GitHub
parent 8b0e3d8da3
commit 9c5abc9587
4 changed files with 162 additions and 218 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
python/gui/qgsrubberband.sip
View File

@ -6,206 +6,79 @@ class QgsRubberBand: QgsMapCanvasItem
public:
/** Icons */
enum IconType
{
/**
* No icon is used
*/
ICON_NONE,
/**
* A cross is used to highlight points (+)
*/
ICON_CROSS,
/**
* A cross is used to highlight points (x)
*/
ICON_X,
/**
* A box is used to highlight points (□)
*/
ICON_BOX,
/**
* A circle is used to highlight points (○)
*/
ICON_CIRCLE,
/**
* A full box is used to highlight points (■)
*/
ICON_FULL_BOX
};
/**
* Creates a new RubberBand.
* @param mapCanvas The map canvas to draw onto. It's CRS will be used map points onto screen coordinates.
* @param geometryType Defines how the data should be drawn onto the screen. (Use QgsWkbTypes::LineGeometry, QgsWkbTypes::PolygonGeometry or QgsWkbTypes::PointGeometry)
*/
QgsRubberBand( QgsMapCanvas* mapCanvas /TransferThis/, QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );
~QgsRubberBand();
/**
* Set the color for the rubberband
* @param color The color used to render this rubberband
*/
void setColor( const QColor & color );
/**
* Set the fill color for the rubberband
* @param color The color used to render this rubberband
* @note Added in 2.6
*/
void setFillColor( const QColor & color );
/**
* Set the stroke color for the rubberband
* @param color The color used to render this rubberband
* @note Added in 2.6
*/
QColor fillColor() const;
void setStrokeColor( const QColor & color );
/**
* Set the width of the line. Stroke width for polygon.
* @param width The width for any lines painted for this rubberband
*/
QColor strokeColor() const;
void setSecondaryStrokeColor( const QColor &color );
QColor secondaryStrokeColor() const;
void setWidth( int width );
/**
* Set the icon type to highlight point geometries.
* @param icon The icon to visualize point geometries
*/
int width() const;
void setIcon( IconType icon );
/**
* Set the size of the point icons
*/
IconType icon() const;
void setIconSize( int iconSize );
/**
* Set the style of the line
*/
int iconSize() const;
void setLineStyle( Qt::PenStyle penStyle );
/**
* Set the style of the brush
*/
void setBrushStyle( Qt::BrushStyle brushStyle );
/**
* Clears all the geometries in this rubberband.
* Sets the representation type according to geometryType.
* @param geometryType Defines how the data should be drawn onto the screen. (Use QgsWkbTypes::LineGeometry, QgsWkbTypes::PolygonGeometry or QgsWkbTypes::PointGeometry)
*/
void reset( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );
/**
* Add a vertex to the rubberband and update canvas.
* The rendering of the vertex depends on the current GeometryType and icon.
* If adding more points consider using update=false for better performance
* @param p The vertex/point to add
* @param doUpdate Should the map canvas be updated immediately?
* @param geometryIndex The index of the feature part (in case of multipart geometries)
*/
void addPoint( const QgsPoint & p, bool doUpdate = true, int geometryIndex = 0 );
/** Ensures that a polygon geometry is closed and that the last vertex equals the
* first vertex.
* @param doUpdate set to true to update the map canvas immediately
* @param geometryIndex index of the feature part (in case of multipart geometries)
* @note added in QGIS 2.16
*/
void closePoints( bool doUpdate = true, int geometryIndex = 0 );
/**
* Remove a vertex from the rubberband and (optionally) update canvas.
* @param index The index of the vertex/point to remove, negative indexes start at end
* @param doUpdate Should the map canvas be updated immediately?
* @param geometryIndex The index of the feature part (in case of multipart geometries)
*/
void removePoint( int index = 0, bool doUpdate = true, int geometryIndex = 0 );
/**
* Removes the last point. Most useful in connection with undo operations
*/
void removeLastPoint( int geometryIndex = 0, bool doUpdate = true );
/**
* Moves the rubber band point specified by index. Note that if the rubber band is
* not used to track the last mouse position, the first point of the rubber band has two vertices
*/
void movePoint( const QgsPoint & p, int geometryIndex = 0 );
/**
* Moves the rubber band point specified by index. Note that if the rubber band is
* not used to track the last mouse position, the first point of the rubber band has two vertices
*/
void movePoint( int index, const QgsPoint& p, int geometryIndex = 0 );
/**
* Returns number of vertices in feature part
* @param geometryIndex The index of the feature part (in case of multipart geometries)
* @return number of vertices
*/
int partSize( int geometryIndex ) const;
/**
* Sets this rubber band to the geometry of an existing feature.
* This is useful for feature highlighting.
* In contrast to {@link addGeometry}, this method does also change the geometry type of the rubberband.
* @param geom the geometry object
* @param layer the layer containing the feature, used for coord transformation to map
* crs. In case of 0 pointer, the coordinates are not going to be transformed.
*/
void setToGeometry( const QgsGeometry& geom, QgsVectorLayer* layer );
/**
* Sets this rubber band to a map canvas rectangle
* @param rect rectangle in canvas coordinates
*/
void setToCanvasRectangle( QRect rect );
/**
* Add the geometry of an existing feature to a rubberband
* This is useful for multi feature highlighting.
* As of 2.0, this method does not change the GeometryType any more. You need to set the GeometryType
* of the rubberband explicitly by calling {@link reset} or {@link setToGeometry} with appropriate arguments.
* {@link setToGeometry} is also to be preferred for backwards-compatibility.
*
* @param geom the geometry object. Will be treated as a collection of vertices.
* @param layer the layer containing the feature, used for coord transformation to map
* crs. In case of 0 pointer, the coordinates are not going to be transformed.
*/
void addGeometry( const QgsGeometry& geom, QgsVectorLayer* layer );
/**
* Adds translation to original coordinates (all in map coordinates)
* @param dx x translation
* @param dy y translation
*/
void setTranslationOffset( double dx, double dy );
/**
* Returns number of geometries
* @return number of geometries
*/
int size() const;
/**
* Returns count of vertices in all lists of mPoint
* @return The total number of vertices
*/
int numberOfVertices() const;
/**
* Return vertex
* @param i The geometry index
* @param j The vertex index within geometry i
*/
const QgsPoint *getPoint( int i, int j = 0 ) const;
/**
* Returns the rubberband as a Geometry.
* @return A geometry object which reflects the current state of the rubberband.
*/
QgsGeometry asGeometry() const;
virtual void updatePosition();
@ -213,7 +86,8 @@ class QgsRubberBand: QgsMapCanvasItem
protected:
virtual void paint( QPainter* p );
//! recalculates needed rectangle
void drawShape( QPainter *p, QVector<QPointF> &pts );
void updateRect();
};

2
src/app/qgsmapcanvasdockwidget.cpp
View File

@ -53,6 +53,8 @@ QgsMapCanvasDockWidget::QgsMapCanvasDockWidget( const QString &name, QWidget *pa
mExtentRubberBand = new QgsRubberBand( mMapCanvas, QgsWkbTypes::PolygonGeometry );
mExtentRubberBand->setStrokeColor( Qt::red );
mExtentRubberBand->setSecondaryStrokeColor( QColor( 255, 255, 255, 225 ) );
mExtentRubberBand->setFillColor( Qt::transparent );
mPanTool = new QgsMapToolPan( mMapCanvas );
mMapCanvas->setMapTool( mPanTool );

140
src/gui/qgsrubberband.cpp
View File

@ -41,6 +41,7 @@ QgsRubberBand::QgsRubberBand( QgsMapCanvas *mapCanvas, QgsWkbTypes::GeometryType
setWidth( 1 );
setLineStyle( Qt::SolidLine );
setBrushStyle( Qt::SolidPattern );
setSecondaryStrokeColor( QColor() );
}
QgsRubberBand::QgsRubberBand()
@ -67,8 +68,7 @@ void QgsRubberBand::setColor( const QColor &color )
*/
void QgsRubberBand::setFillColor( const QColor &color )
{
QColor fillColor( color.red(), color.green(), color.blue(), color.alpha() );
mBrush.setColor( fillColor );
mBrush.setColor( color );
}
/*!
@ -76,10 +76,13 @@ void QgsRubberBand::setFillColor( const QColor &color )
*/
void QgsRubberBand::setStrokeColor( const QColor &color )
{
QColor penColor( color.red(), color.green(), color.blue(), color.alpha() );
mPen.setColor( penColor );
mPen.setColor( color );
}
void QgsRubberBand::setSecondaryStrokeColor( const QColor &color )
{
mSecondaryPen.setColor( color );
}
/*!
Set the stroke width.
@ -436,15 +439,12 @@ void QgsRubberBand::setToCanvasRectangle( QRect rect )
}
/*!
Draw the shape in response to an update event.
Paint the rubber band in response to an update event.
*/
void QgsRubberBand::paint( QPainter *p )
{
if ( !mPoints.isEmpty() )
{
p->setBrush( mBrush );
p->setPen( mPen );
Q_FOREACH ( const QList<QgsPoint> &line, mPoints )
{
QVector<QPointF> pts;
@ -455,65 +455,81 @@ void QgsRubberBand::paint( QPainter *p )
pts.append( cur );
}
switch ( mGeometryType )
if ( mSecondaryPen.color().isValid() )
{
case QgsWkbTypes::PolygonGeometry:
mSecondaryPen.setWidth( mPen.width() + 2 );
p->setBrush( Qt::NoBrush );
p->setPen( mSecondaryPen );
drawShape( p, pts );
}
p->setBrush( mBrush );
p->setPen( mPen );
drawShape( p, pts );
}
}
}
void QgsRubberBand::drawShape( QPainter *p, QVector<QPointF> &pts )
{
switch ( mGeometryType )
{
case QgsWkbTypes::PolygonGeometry:
{
p->drawPolygon( pts );
}
break;
case QgsWkbTypes::PointGeometry:
{
Q_FOREACH ( QPointF pt, pts )
{
double x = pt.x();
double y = pt.y();
qreal s = ( mIconSize - 1 ) / 2.0;
switch ( mIconType )
{
p->drawPolygon( pts );
case ICON_NONE:
break;
case ICON_CROSS:
p->drawLine( QLineF( x - s, y, x + s, y ) );
p->drawLine( QLineF( x, y - s, x, y + s ) );
break;
case ICON_X:
p->drawLine( QLineF( x - s, y - s, x + s, y + s ) );
p->drawLine( QLineF( x - s, y + s, x + s, y - s ) );
break;
case ICON_BOX:
p->drawLine( QLineF( x - s, y - s, x + s, y - s ) );
p->drawLine( QLineF( x + s, y - s, x + s, y + s ) );
p->drawLine( QLineF( x + s, y + s, x - s, y + s ) );
p->drawLine( QLineF( x - s, y + s, x - s, y - s ) );
break;
case ICON_FULL_BOX:
p->drawRect( x - s, y - s, mIconSize, mIconSize );
break;
case ICON_CIRCLE:
p->drawEllipse( x - s, y - s, mIconSize, mIconSize );
break;
}
break;
case QgsWkbTypes::PointGeometry:
{
Q_FOREACH ( QPointF pt, pts )
{
double x = pt.x();
double y = pt.y();
qreal s = ( mIconSize - 1 ) / 2.0;
switch ( mIconType )
{
case ICON_NONE:
break;
case ICON_CROSS:
p->drawLine( QLineF( x - s, y, x + s, y ) );
p->drawLine( QLineF( x, y - s, x, y + s ) );
break;
case ICON_X:
p->drawLine( QLineF( x - s, y - s, x + s, y + s ) );
p->drawLine( QLineF( x - s, y + s, x + s, y - s ) );
break;
case ICON_BOX:
p->drawLine( QLineF( x - s, y - s, x + s, y - s ) );
p->drawLine( QLineF( x + s, y - s, x + s, y + s ) );
p->drawLine( QLineF( x + s, y + s, x - s, y + s ) );
p->drawLine( QLineF( x - s, y + s, x - s, y - s ) );
break;
case ICON_FULL_BOX:
p->drawRect( x - s, y - s, mIconSize, mIconSize );
break;
case ICON_CIRCLE:
p->drawEllipse( x - s, y - s, mIconSize, mIconSize );
break;
}
}
}
break;
case QgsWkbTypes::LineGeometry:
default:
{
p->drawPolyline( pts );
}
break;
}
}
break;
case QgsWkbTypes::LineGeometry:
default:
{
p->drawPolyline( pts );
}
break;
}
}

80
src/gui/qgsrubberband.h
View File

@ -77,49 +77,88 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
QgsRubberBand( QgsMapCanvas *mapCanvas, QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );
/**
* Set the color for the rubberband
* Sets the color for the rubberband
* @param color The color used to render this rubberband
*/
void setColor( const QColor &color );
/**
* Set the fill color for the rubberband
* Sets the fill color for the rubberband
* @param color The color used to render this rubberband
* @note Added in 2.6
*/
void setFillColor( const QColor &color );
/**
* Set the stroke color for the rubberband
* Returns the current fill color.
*/
QColor fillColor() const { return mBrush.color(); }
/**
* Sets the stroke color for the rubberband
* @param color The color used to render this rubberband
* @note Added in 2.6
*/
void setStrokeColor( const QColor &color );
/**
* Set the width of the line. Stroke width for polygon.
* Returns the current stroke color.
*/
QColor strokeColor() const { return mPen.color(); }
/**
* Sets a secondary stroke color for the rubberband which will be drawn under the main stroke color.
* Set to an invalid color to avoid drawing the secondary stroke.
* @param color The color used to render a secondary stroke color to this rubberband
* @note Added in 3.0
*/
void setSecondaryStrokeColor( const QColor &color );
/**
* Returns the current secondary stroke color.
*/
QColor secondaryStrokeColor() const { return mSecondaryPen.color(); }
/**
* Sets the width of the line. Stroke width for polygon.
* @param width The width for any lines painted for this rubberband
*/
void setWidth( int width );
/**
* Set the icon type to highlight point geometries.
* Returns the current width of the line or stroke width for polygon.
*/
int width() const { return mPen.width(); }
/**
* Sets the icon type to highlight point geometries.
* @param icon The icon to visualize point geometries
*/
void setIcon( IconType icon );
/**
* Set the size of the point icons
* Returns the current icon type to highlight point geometries.
*/
IconType icon() const { return mIconType; }
/**
* Sets the size of the point icons
*/
void setIconSize( int iconSize );
/**
* Set the style of the line
* Returns the current icon size of the point icons.
*/
int iconSize() const { return mIconSize; }
/**
* Sets the style of the line
*/
void setLineStyle( Qt::PenStyle penStyle );
/**
* Set the style of the brush
* Sets the style of the brush
*/
void setBrushStyle( Qt::BrushStyle brushStyle );
@ -131,7 +170,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
void reset( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );
/**
* Add a vertex to the rubberband and update canvas.
* Adds a vertex to the rubberband and update canvas.
* The rendering of the vertex depends on the current GeometryType and icon.
* If adding more points consider using update=false for better performance
* @param p The vertex/point to add
@ -149,7 +188,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
void closePoints( bool doUpdate = true, int geometryIndex = 0 );
/**
* Remove a vertex from the rubberband and (optionally) update canvas.
* Removes a vertex from the rubberband and (optionally) updates canvas.
* @param index The index of the vertex/point to remove, negative indexes start at end
* @param doUpdate Should the map canvas be updated immediately?
* @param geometryIndex The index of the feature part (in case of multipart geometries)
@ -197,7 +236,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
void setToCanvasRectangle( QRect rect );
/**
* Add the geometry of an existing feature to a rubberband
* Adds the geometry of an existing feature to a rubberband
* This is useful for multi feature highlighting.
* As of 2.0, this method does not change the GeometryType any more. You need to set the GeometryType
* of the rubberband explicitly by calling {@link reset} or {@link setToGeometry} with appropriate arguments.
@ -229,14 +268,14 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
int numberOfVertices() const;
/**
* Return vertex
* Returns a vertex
* @param i The geometry index
* @param j The vertex index within geometry i
*/
const QgsPoint *getPoint( int i, int j = 0 ) const;
/**
* Returns the rubberband as a Geometry.
* Returns the rubberband as a Geometry
* @return A geometry object which reflects the current state of the rubberband.
*/
QgsGeometry asGeometry() const;
@ -244,14 +283,27 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
virtual void updatePosition() override;
protected:
/**
* Paints the rubber band in response to an update event.
* @param p The QPainter object
*/
virtual void paint( QPainter *p ) override;
//! recalculates needed rectangle
/**
* Draws shape of the rubber band.
* @param p The QPainter object
* @param pts A list of points used to draw the shape
*/
void drawShape( QPainter *p, QVector<QPointF> &pts );
//! Recalculates needed rectangle
void updateRect();
private:
QBrush mBrush;
QPen mPen;
QPen mSecondaryPen;
//! The size of the icon for points.
int mIconSize;