Class QfRubberbandShape

ClassList > QfRubberbandShape

The QfRubberbandShape class is used to provide the shape data to draw rubber bands on the map canvas using the QML Shape item. It is aimed to be used with either aQfVertexModel or aQfRubberbandModel .

#include <qfrubberbandshape.h>

Inherits the following classes: QQuickItem

Inherited by the following classes: QfRubberband

Public Properties

Type	Name
property QColor	color Color of the rubberband.
property bool	freeze When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.
property Qgis::GeometryType	geometryType QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)
property qreal	lineWidth Line width of the rubberband.
property QgsQuickMapSettings *	mapSettings
property QfRubberbandModel *	model
property QColor	outlineColor Color of the rubberband outline.
property QList< QPolygonF >	polylines List of polylines representing the rubber band.
property Qgis::GeometryType	polylinesType The geometry type associated to the polylines.
property QfVertexModel *	vertexModel

Public Signals

Type	Name
signal void	colorChanged Color of the rubberband.
signal void	freezeChanged When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.
signal void	geometryTypeChanged QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)
signal void	lineWidthChanged Line width of the rubberband.
signal void	mapSettingsChanged
signal void	modelChanged
signal void	outlineColorChanged Color of the rubberband outline.
signal void	polylinesChanged List of polylines representing the rubber band.
signal void	polylinesTypeChanged The geometry type associated to the polylines.
signal void	vertexModelChanged

Public Functions

Type	Name
	QfRubberbandShape (QQuickItem * parent=nullptr)
QColor	color () const Color of the rubberband.
bool	freeze () const When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.
Qgis::GeometryType	geometryType () const QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)
float	lineWidth () const Line width of the rubberband.
QgsQuickMapSettings *	mapSettings () const
QfRubberbandModel *	model () const
QColor	outlineColor () const Color of the rubberband outline.
QList< QPolygonF >	polylines () const List of polylines representing the rubber band.
Qgis::GeometryType	polylinesType () const The geometry type associated to the polylines.
void	setColor (const QColor & color) Color of the rubberband.
void	setFreeze (bool freeze) When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.
void	setGeometryType (const Qgis::GeometryType geometryType) QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)
void	setLineWidth (float width) Line width of the rubberband.
void	setMapSettings (QgsQuickMapSettings * mapSettings)
void	setModel (QfRubberbandModel * model)
void	setOutlineColor (const QColor & color) Color of the rubberband outline.
void	setVertexModel (QfVertexModel * vertexModel)
QfVertexModel *	vertexModel () const

Public Properties Documentation

property color [1/2]

Color of the rubberband.

QColor QfRubberbandShape::color;

property freeze [1/2]

When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.

bool QfRubberbandShape::freeze;

property geometryType [1/2]

QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)

Qgis::GeometryType QfRubberbandShape::geometryType;

property lineWidth [1/2]

Line width of the rubberband.

qreal QfRubberbandShape::lineWidth;

property mapSettings [1/2]

QgsQuickMapSettings * QfRubberbandShape::mapSettings;

property model [1/2]

QfRubberbandModel * QfRubberbandShape::model;

property outlineColor [1/2]

Color of the rubberband outline.

QColor QfRubberbandShape::outlineColor;

property polylines [1/2]

List of polylines representing the rubber band.

QList<QPolygonF> QfRubberbandShape::polylines;

property polylinesType [1/2]

The geometry type associated to the polylines.

Qgis::GeometryType QfRubberbandShape::polylinesType;

property vertexModel [1/2]

QfVertexModel * QfRubberbandShape::vertexModel;

Public Signals Documentation

signal colorChanged

Color of the rubberband.

void QfRubberbandShape::colorChanged;

signal freezeChanged

When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.

void QfRubberbandShape::freezeChanged;

signal geometryTypeChanged

QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)

void QfRubberbandShape::geometryTypeChanged;

signal lineWidthChanged

Line width of the rubberband.

void QfRubberbandShape::lineWidthChanged;

signal mapSettingsChanged

void QfRubberbandShape::mapSettingsChanged;

signal modelChanged

void QfRubberbandShape::modelChanged;

signal outlineColorChanged

Color of the rubberband outline.

void QfRubberbandShape::outlineColorChanged;

signal polylinesChanged

List of polylines representing the rubber band.

void QfRubberbandShape::polylinesChanged;

signal polylinesTypeChanged

The geometry type associated to the polylines.

void QfRubberbandShape::polylinesTypeChanged;

signal vertexModelChanged

void QfRubberbandShape::vertexModelChanged;

Public Functions Documentation

function QfRubberbandShape

explicit QfRubberbandShape::QfRubberbandShape (
    QQuickItem * parent=nullptr
)

function color [2/2]

Color of the rubberband.

QColor QfRubberbandShape::color () const

function freeze [2/2]

When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.

bool QfRubberbandShape::freeze () const

function geometryType [2/2]

QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)

inline Qgis::GeometryType QfRubberbandShape::geometryType () const

function lineWidth [2/2]

Line width of the rubberband.

float QfRubberbandShape::lineWidth () const

function mapSettings [2/2]

QgsQuickMapSettings * QfRubberbandShape::mapSettings () const

function model [2/2]

QfRubberbandModel * QfRubberbandShape::model () const

function outlineColor [2/2]

Color of the rubberband outline.

QColor QfRubberbandShape::outlineColor () const

function polylines [2/2]

List of polylines representing the rubber band.

inline QList< QPolygonF > QfRubberbandShape::polylines () const

function polylinesType [2/2]

The geometry type associated to the polylines.

inline Qgis::GeometryType QfRubberbandShape::polylinesType () const

function setColor

Color of the rubberband.

void QfRubberbandShape::setColor (
    const QColor & color
)

function setFreeze

When set to TRUE, changes to the linked rubber band or vertex model as well as map settings will be ignored and the rubber band shape data will be left untouched.

void QfRubberbandShape::setFreeze (
    bool freeze
)

function setGeometryType

QfGeometry type used to render the rubber band (if not provided or set to null geometry, the type provided by the rubber band or vertex model will be used)

void QfRubberbandShape::setGeometryType (
    const Qgis::GeometryType geometryType
)

function setLineWidth

Line width of the rubberband.

void QfRubberbandShape::setLineWidth (
    float width
)

function setMapSettings

void QfRubberbandShape::setMapSettings (
    QgsQuickMapSettings * mapSettings
)

function setModel

void QfRubberbandShape::setModel (
    QfRubberbandModel * model
)

function setOutlineColor

Color of the rubberband outline.

void QfRubberbandShape::setOutlineColor (
    const QColor & color
)

function setVertexModel

void QfRubberbandShape::setVertexModel (
    QfVertexModel * vertexModel
)

function vertexModel [2/2]

QfVertexModel * QfRubberbandShape::vertexModel () const

The documentation for this class was generated from the following file src/core/qfrubberbandshape.h