Base class for drawing tools for line and area symbols. More...

#include <draw_line_and_area_tool.h>

Inheritance diagram for OpenOrienteering::DrawLineAndAreaTool:

[legend]

Collaboration diagram for OpenOrienteering::DrawLineAndAreaTool:

[legend]

Signals
void	dirtyRectChanged (const QRectF &rect)

void	pathAborted ()

void	pathFinished (OpenOrienteering::PathObject *path)

Public Member Functions
	DrawLineAndAreaTool (MapEditorController editor, Type type, QAction tool_action, bool is_helper_tool)

	~DrawLineAndAreaTool () override

void	leaveEvent (QEvent *event) override

void	finishEditing () override
	Finishes editing if it is currently in progress. More...

Public Member Functions inherited from OpenOrienteering::MapEditorTool
	MapEditorTool (MapEditorController editor, Type type, QAction tool_action=nullptr)
	Constructs a new MapEditorTool. More...

	~MapEditorTool () override
	Destructs the MapEditorTool. More...

virtual void	init ()
	Performs initialization when the tool becomes active. More...

virtual void	deactivate ()
	Makes this tool inactive in the editor. More...

virtual void	switchToDefaultDrawTool (const Symbol *symbol) const
	Switch to a default draw tool for the given symbol. More...

virtual const QCursor &	getCursor () const =0
	Returns the cursor which should be used for the tool in the editor windows. More...

virtual void	draw (QPainter painter, MapWidget widget)
	Draws the tool's visualisation for a map widget. More...

virtual bool	mousePressEvent (QMouseEvent event, const MapCoordF &map_coord, MapWidget widget)

virtual bool	mouseMoveEvent (QMouseEvent event, const MapCoordF &map_coord, MapWidget widget)

virtual bool	mouseReleaseEvent (QMouseEvent event, const MapCoordF &map_coord, MapWidget widget)

virtual bool	mouseDoubleClickEvent (QMouseEvent event, const MapCoordF &map_coord, MapWidget widget)

virtual bool	keyPressEvent (QKeyEvent *event)

virtual bool	keyReleaseEvent (QKeyEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual bool	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery property, const QVariant &argument) const

virtual bool	gestureEvent (QGestureEvent event, MapWidget widget)

virtual void	gestureStarted ()
	This is called to signal the start of a gesture. More...

Type	toolType () const
	Returns the type of this tool. More...

QAction *	toolAction () const
	Returns the action which represents this tool. More...

bool	usesTouchCursor () const
	Returns whether to use the touch helper cursor for this tool. More...

Map *	map () const
	Returns the map being edited. More...

MapWidget *	mapWidget () const
	Returns the map widget being operated on. More...

MainWindow *	mainWindow () const
	Returns the main window the controller is attached to. More...

QWidget *	window () const
	Returns the main window the controller is attached to as a QWidget. More...

bool	drawOnRightClickEnabled () const
	Returns true if Mapper is configured to finish drawing on right click. More...

bool	editingInProgress () const
	Returns whether an editing operation is currently in progress. More...

bool	isDrawTool () const
	Returns true if the given tool is for drawing new objects. More...

const PointHandles &	pointHandles () const
	Returns the point handles utility for this tool. More...

unsigned int	scaleFactor () const
	The factor by which all drawing shall be scaled. More...

qreal	clickTolerance () const
	A value representing how close the user must click or hover to select a point. More...

int	startDragDistance () const
	The number of pixels the mouse has to be moved to start dragging. More...

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Protected Slots
virtual void	setDrawingSymbol (const OpenOrienteering::Symbol *symbol)

Protected Member Functions
void	createPreviewPoints ()
	Creates point objects and symbols which serve as a preview for drawing the selected symbol. More...

void	addPreviewPointSymbols (const Symbol *symbol)
	Creates preview point symbols for the given symbol. More...

void	addPreviewPointSymbolsForBorder (const LineSymbol line, const LineSymbolBorder border)
	Creates preview point symbols for the border of the given line symbol. More...

void	setPreviewPointsPosition (const MapCoordF &map_coord, int points_index=0)
	Sets the position of the preview objects (after cursor movements). More...

void	hidePreviewPoints ()
	Hides all preview points. More...

void	startDrawing ()
	Does necessary preparations to start drawing. More...

virtual void	updatePreviewPath ()
	Calls update() on the preview path, correctly handling its renderables. More...

virtual void	abortDrawing ()
	Aborts drawing. More...

virtual void	finishDrawing ()
	Finishes drawing, creating a new undo step. More...

void	finishDrawing (PathObject *append_to_object)
	Finishes drawing, appending to the given object if not nullptr. More...

void	deletePreviewObjects ()
	Deletes preview all objects and points. More...

void	includePreviewRects (QRectF &rect)
	Extends the rect to conver all preview objects. More...

void	drawPreviewObjects (QPainter painter, MapWidget widget)
	Draws the preview objects. More...

Protected Member Functions inherited from OpenOrienteering::MapEditorTool
void	useTouchCursor (bool enabled)
	Sets the flag which indicates whether the touch cursor shall be used. More...

void	setEditingInProgress (bool state)
	Sets a flag which indicates an active editing operation. More...

void	setStatusBarText (const QString &text)
	Sends text to the window's status bar. More...

void	drawSelectionBox (QPainter painter, MapWidget widget, const MapCoordF &corner1, const MapCoordF &corner2) const
	Draws a selection box for the given corner points. More...

MapCoordVector::size_type	findHoverPoint (const QPointF &cursor, const MapWidget widget, const Object object, bool include_curve_handles, MapCoordF *out_handle_pos=nullptr) const
	Finds and returns the point of the given object over which the cursor hovers. More...

bool	containsDrawingButtons (Qt::MouseButtons buttons) const
	Checks if the given buttons contain one which controls drawing. More...

bool	isDrawingButton (Qt::MouseButton button) const
	Checks if the given event was triggered by press or release of a mouse button for drawing. More...

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Protected Attributes
std::vector< PointSymbol * >	preview_point_symbols

std::vector< bool >	preview_point_symbols_external

std::vector< PointObject * >	preview_points [2]

std::unique_ptr< CombinedSymbol >	path_combination

std::unique_ptr< MapRenderables >	renderables

const Symbol *	drawing_symbol = nullptr

PathObject *	preview_path = nullptr

int	preview_point_radius = 0

bool	preview_points_shown = false

bool	is_helper_tool = false

Protected Attributes inherited from OpenOrienteering::MapEditorTool
MapEditorController *const	editor
	The map editor which uses this tool. More...

Additional Inherited Members
Public Types inherited from OpenOrienteering::MapEditorTool
enum	Type { EditPoint = 1, EditLine = 2, DrawPoint = 3, DrawPath = 4, DrawCircle = 5, DrawRectangle = 6, DrawText = 7, DrawFreehand = 8, Pan = 9, Scribble = 10, Other = 0 }
	Types of tool. More...

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QObject
typedef	QObjectList

Static Public Attributes inherited from OpenOrienteering::MapEditorTool
static const QRgb	inactive_color = qRgb(0, 0, 255)
	Color for normal (not active) elements. More...

static const QRgb	active_color = qRgb(255, 150, 0)
	Color for active elements (which are hovered over by the cursor) More...

static const QRgb	selection_color = qRgb(210, 0, 229)
	Color for selected elements. More...

Static Protected Member Functions inherited from OpenOrienteering::MapEditorTool
static QCursor	scaledToScreen (const QCursor &unscaled_cursor)
	Returns a cursor which is scaled to the screen's resolution. More...

Properties inherited from QObject
	objectName

Detailed Description

Base class for drawing tools for line and area symbols.

Provides some common functionality, e.g. displaying the preview objects or coping with changing symbols.

Constructor & Destructor Documentation

◆ DrawLineAndAreaTool()

OpenOrienteering::DrawLineAndAreaTool::DrawLineAndAreaTool	(	MapEditorController *	editor,
		Type	type,
		QAction *	tool_action,
		bool	is_helper_tool
	)

◆ ~DrawLineAndAreaTool()

OpenOrienteering::DrawLineAndAreaTool::~DrawLineAndAreaTool ( )

override

Member Function Documentation

◆ abortDrawing()

void OpenOrienteering::DrawLineAndAreaTool::abortDrawing ( )

protectedvirtual

Aborts drawing.

Reimplemented in OpenOrienteering::DrawPathTool, OpenOrienteering::DrawRectangleTool, OpenOrienteering::DrawFreehandTool, and OpenOrienteering::DrawCircleTool.

◆ addPreviewPointSymbols()

void OpenOrienteering::DrawLineAndAreaTool::addPreviewPointSymbols ( const Symbol * symbol )

protected

Creates preview point symbols for the given symbol.

◆ addPreviewPointSymbolsForBorder()

void OpenOrienteering::DrawLineAndAreaTool::addPreviewPointSymbolsForBorder	(	const LineSymbol *	line,
		const LineSymbolBorder *	border
	)

protected

Creates preview point symbols for the border of the given line symbol.

◆ createPreviewPoints()

void OpenOrienteering::DrawLineAndAreaTool::createPreviewPoints ( )

protected

Creates point objects and symbols which serve as a preview for drawing the selected symbol.

◆ deletePreviewObjects()

void OpenOrienteering::DrawLineAndAreaTool::deletePreviewObjects ( )

protected

Deletes preview all objects and points.

◆ dirtyRectChanged

void OpenOrienteering::DrawLineAndAreaTool::dirtyRectChanged ( const QRectF & rect )

signal

◆ drawPreviewObjects()

void OpenOrienteering::DrawLineAndAreaTool::drawPreviewObjects	(	QPainter *	painter,
		MapWidget *	widget
	)

protected

Draws the preview objects.

◆ finishDrawing() [1/2]

void OpenOrienteering::DrawLineAndAreaTool::finishDrawing ( )

protectedvirtual

Finishes drawing, creating a new undo step.

Reimplemented in OpenOrienteering::DrawPathTool, OpenOrienteering::DrawRectangleTool, OpenOrienteering::DrawFreehandTool, and OpenOrienteering::DrawCircleTool.

◆ finishDrawing() [2/2]

void OpenOrienteering::DrawLineAndAreaTool::finishDrawing ( PathObject * append_to_object )

protected

Finishes drawing, appending to the given object if not nullptr.

◆ finishEditing()

void OpenOrienteering::DrawLineAndAreaTool::finishEditing ( )

overridevirtual

Finishes editing if it is currently in progress.

Deriving functions shall call this class' implementation (which calls setEditingInProgress(false)).

Reimplemented from OpenOrienteering::MapEditorTool.

◆ hidePreviewPoints()

void OpenOrienteering::DrawLineAndAreaTool::hidePreviewPoints ( )

protected

Hides all preview points.

◆ includePreviewRects()

void OpenOrienteering::DrawLineAndAreaTool::includePreviewRects ( QRectF & rect )

protected

Extends the rect to conver all preview objects.

◆ leaveEvent()

void OpenOrienteering::DrawLineAndAreaTool::leaveEvent ( QEvent * event )

overridevirtual

Reimplemented from OpenOrienteering::MapEditorTool.

◆ pathAborted

void OpenOrienteering::DrawLineAndAreaTool::pathAborted ( )

signal

◆ pathFinished

void OpenOrienteering::DrawLineAndAreaTool::pathFinished ( OpenOrienteering::PathObject * path )

signal

◆ setDrawingSymbol

void OpenOrienteering::DrawLineAndAreaTool::setDrawingSymbol ( const OpenOrienteering::Symbol * symbol )

protectedvirtualslot

◆ setPreviewPointsPosition()

void OpenOrienteering::DrawLineAndAreaTool::setPreviewPointsPosition	(	const MapCoordF &	map_coord,
		int	points_index = `0`
	)

protected

Sets the position of the preview objects (after cursor movements).

Parameters

map_coord	The new position.
points_index	The index of the points set; there are two sets, so the preview points can be displayed at two positions at the same time.

◆ startDrawing()

void OpenOrienteering::DrawLineAndAreaTool::startDrawing ( )

protected

Does necessary preparations to start drawing.

◆ updatePreviewPath()

void OpenOrienteering::DrawLineAndAreaTool::updatePreviewPath ( )

protectedvirtual

Calls update() on the preview path, correctly handling its renderables.

Reimplemented in OpenOrienteering::DrawPathTool.

Member Data Documentation

◆ drawing_symbol

const Symbol* OpenOrienteering::DrawLineAndAreaTool::drawing_symbol = nullptr

protected

◆ is_helper_tool

bool OpenOrienteering::DrawLineAndAreaTool::is_helper_tool = false

protected

◆ path_combination

std::unique_ptr<CombinedSymbol> OpenOrienteering::DrawLineAndAreaTool::path_combination

protected

◆ preview_path

PathObject* OpenOrienteering::DrawLineAndAreaTool::preview_path = nullptr

protected

◆ preview_point_radius

int OpenOrienteering::DrawLineAndAreaTool::preview_point_radius = 0

protected

◆ preview_point_symbols

std::vector<PointSymbol*> OpenOrienteering::DrawLineAndAreaTool::preview_point_symbols

protected

◆ preview_point_symbols_external

std::vector<bool> OpenOrienteering::DrawLineAndAreaTool::preview_point_symbols_external

protected

◆ preview_points

std::vector<PointObject*> OpenOrienteering::DrawLineAndAreaTool::preview_points[2]

protected

◆ preview_points_shown

bool OpenOrienteering::DrawLineAndAreaTool::preview_points_shown = false

protected

◆ renderables

std::unique_ptr<MapRenderables> OpenOrienteering::DrawLineAndAreaTool::renderables

protected

The documentation for this class was generated from the following files:

src/tools/draw_line_and_area_tool.h (f16dd5f on 8 Aug 2019)
src/tools/draw_line_and_area_tool.cpp (f7e08a0 on 23 Dec 2018)

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DrawLineAndAreaTool()

◆ ~DrawLineAndAreaTool()

Member Function Documentation

◆ abortDrawing()

◆ addPreviewPointSymbols()

◆ addPreviewPointSymbolsForBorder()

◆ createPreviewPoints()

◆ deletePreviewObjects()

◆ dirtyRectChanged

◆ drawPreviewObjects()

◆ finishDrawing() [1/2]

◆ finishDrawing() [2/2]

◆ finishEditing()

◆ hidePreviewPoints()

◆ includePreviewRects()

◆ leaveEvent()

◆ pathAborted

◆ pathFinished

◆ setDrawingSymbol

◆ setPreviewPointsPosition()

◆ startDrawing()

◆ updatePreviewPath()

Member Data Documentation

◆ drawing_symbol

◆ is_helper_tool

◆ path_combination

◆ preview_path

◆ preview_point_radius

◆ preview_point_symbols

◆ preview_point_symbols_external

◆ preview_points

◆ preview_points_shown

◆ renderables