Mapper  0.9.0
API documentation
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
OpenOrienteering::EditTool Class Reference

Base class for object editing tools. More...

#include <edit_tool.h>

Inheritance diagram for OpenOrienteering::EditTool:
Inheritance graph
[legend]
Collaboration diagram for OpenOrienteering::EditTool:
Collaboration graph
[legend]

Public Types

enum  HoverFlag { OverNothing = 0, OverFrame = 1, OverObjectNode = 2, OverPathEdge = 4 }
 A type for general information on what is hovered over. More...
 
- 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...
 

Public Member Functions

 EditTool (MapEditorController *editor, MapEditorTool::Type type, QAction *tool_action)
 
 ~EditTool () override
 
- Public Member Functions inherited from OpenOrienteering::MapEditorToolBase
 MapEditorToolBase (const QCursor &cursor, MapEditorTool::Type type, MapEditorController *editor, QAction *tool_action)
 
 ~MapEditorToolBase () override
 
void init () override
 Performs initialization when the tool becomes active. More...
 
const QCursorgetCursor () const override
 Returns the cursor which should be used for the tool in the editor windows. More...
 
void mousePositionEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget)
 Updates the saved current position (raw and constrained), map widget, and modifiers. More...
 
bool mousePressEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget) override
 
bool mouseMoveEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget) override
 
bool mouseReleaseEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget) override
 
bool keyPressEvent (QKeyEvent *event) override
 
bool keyReleaseEvent (QKeyEvent *event) override
 
void draw (QPainter *painter, MapWidget *widget) override
 Draws the preview renderables. Should be overridden to draw custom elements. More...
 
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 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 bool mouseDoubleClickEvent (QMouseEvent *event, const MapCoordF &map_coord, MapWidget *widget)
 
virtual void leaveEvent (QEvent *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)
 
Type toolType () const
 Returns the type of this tool. More...
 
QActiontoolAction () const
 Returns the action which represents this tool. More...
 
bool usesTouchCursor () const
 Returns whether to use the touch helper cursor for this tool. More...
 
Mapmap () const
 Returns the map being edited. More...
 
MapWidgetmapWidget () const
 Returns the map widget being operated on. More...
 
MainWindowmainWindow () const
 Returns the main window the controller is attached to. More...
 
QWidgetwindow () 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 PointHandlespointHandles () 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 QMetaObjectmetaObject () 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)
 
QThreadthread () 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)
 
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
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
 

Static Public Attributes

static constexpr Qt::Key DeleteObjectKey = Qt::Key_Delete
 The platform's key for deleting selected objects. More...
 
- 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...
 

Protected Member Functions

void deleteSelectedObjects ()
 Deletes all selected objects and updates the status text. More...
 
void createReplaceUndoStep (Object *object)
 Creates a replace object undo step for the given object. More...
 
bool pointOverRectangle (const QPointF &point, const QRectF &rect) const
 Returns if the point is inside the click_tolerance from the rect's border. More...
 
void setupAngleHelperFromEditedObjects ()
 Configures the angle helper from the primary directions of the edited objects. More...
 
void drawBoundingBox (QPainter *painter, MapWidget *widget, const QRectF &bounding_box, const QRgb &color)
 Draws a bounding box with a dashed line of the given color. More...
 
void drawBoundingPath (QPainter *painter, MapWidget *widget, const std::vector< QPointF > &bounding_path, const QRgb &color)
 Draws a bounding path with a dashed line of the given color. More...
 
- Protected Member Functions inherited from OpenOrienteering::MapEditorToolBase
virtual void initImpl ()
 Can do additional initializations at a time where no other tool is active (in contrast to the constructor) More...
 
virtual int updateDirtyRectImpl (QRectF &rect)
 Must include the area of all custom drawings into the rect, which already contains the area of the selection preview and activated tool helpers when this method is called. More...
 
virtual void drawImpl (QPainter *painter, MapWidget *widget)
 Must draw the tool's graphics. More...
 
virtual void updateStatusText ()=0
 Must update the status bar text. More...
 
virtual void objectSelectionChangedImpl ()=0
 Called when the object selection in the map is changed. More...
 
virtual void clickPress ()
 Called when the left mouse button is pressed. More...
 
virtual void clickRelease ()
 Called when the left mouse button is released without a drag operation before. More...
 
virtual void mouseMove ()
 Called when the mouse is moved without the left mouse button being pressed. More...
 
void gestureStarted () override
 This is called to signal the start of a gesture. More...
 
void startDragging ()
 
void updateDragging ()
 
void finishDragging ()
 
void cancelDragging ()
 
bool isDragging () const
 Is the left mouse button pressed and has a drag move been started (by moving the mouse a minimum amount of pixels)? More...
 
virtual void dragStart ()
 Called when a drag operation is started. More...
 
virtual void dragMove ()
 Called when the mouse is moved with the left mouse button being pressed. More...
 
virtual void dragFinish ()
 Called when a drag operation is finished. More...
 
virtual void dragCanceled ()
 
virtual bool keyPress (QKeyEvent *event)
 Called when a key is pressed down. Return true if the key was processed by the tool. More...
 
virtual bool keyRelease (QKeyEvent *event)
 Called when a key is released. Return true if the key was processed by the tool. More...
 
void reapplyConstraintHelpers ()
 Applies the constraint helpers and generates a pointer event. More...
 
void startEditing ()
 Call this before editing the selected objects, and finish/abortEditing() afterwards. More...
 
void startEditing (Object *object)
 
void startEditing (const std::set< Object *> &objects)
 
void abortEditing ()
 
ObjectsRange editedObjects ()
 
bool editedObjectsModified () const
 
void resetEditedObjects ()
 
virtual void updatePreviewObjects ()
 Call this to display changes to the preview objects between startEditing() and finish/abortEditing(). More...
 
void updatePreviewObjectsAsynchronously ()
 Call this to display changes to the preview objects between startEditing() and finish/abortEditing(). More...
 
void drawSelectionOrPreviewObjects (QPainter *painter, MapWidget *widget, bool draw_opaque=false)
 If the tool created custom renderables (e.g. More...
 
void activateAngleHelperWhileEditing (bool enable=true)
 Activates or deactivates the angle helper, recalculates (un-)constrained cursor position, and calls mouseMove() or dragMove() to update the tool. More...
 
void activateSnapHelperWhileEditing (bool enable=true)
 Activates or deactivates the snap helper, recalculates (un-)constrained cursor position, and calls mouseMove() or dragMove() to update the tool. More...
 
void updateConstrainedPositions ()
 Calculates the constrained cursor position for the current position and map widget. 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
QObjectsender () 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)
 

Static Protected Member Functions

static MapCoordF closestPointOnRect (MapCoordF point, const QRectF &rect)
 Returns the point on the rect which is closest to the given point. 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...
 

Protected Attributes

QScopedPointer< ObjectSelectorobject_selector
 An utility implementing object selection logic. More...
 
- Protected Attributes inherited from OpenOrienteering::MapEditorToolBase
QPoint click_pos
 Position where the left mouse button was pressed, with no constraints applied. More...
 
MapCoordF click_pos_map
 
QPointF constrained_click_pos
 Position where the left mouse button was pressed, constrained by tool helpers, if active. More...
 
MapCoordF constrained_click_pos_map
 
QPoint cur_pos
 Position where the cursor is currently. More...
 
MapCoordF cur_pos_map
 
QPointF constrained_pos
 Position where the cursor is currently, constrained by tool helpers, if active. More...
 
MapCoordF constrained_pos_map
 
bool snapped_to_pos
 This is set to true when constrained_pos(_map) is a snapped position. More...
 
int effective_start_drag_distance
 The amount of pixels the mouse has to be moved to start dragging. More...
 
std::unique_ptr< ConstrainAngleToolHelperangle_helper
 Angle tool helper. If activated, it is included in the dirty rect and drawn automatically. More...
 
std::unique_ptr< SnappingToolHelpersnap_helper
 Snapping tool helper. If a non-null filter is set, it is included in the dirty rect and drawn automatically. More...
 
Objectsnap_exclude_object = nullptr
 An object to exclude from snapping, or nullptr to snap to all objects. More...
 
Qt::KeyboardModifiers active_modifiers
 Bitmask containing active modifiers. More...
 
MapWidgetcur_map_widget
 The map widget in which the tool was last used. More...
 
QPointer< KeyButtonBarkey_button_bar
 Must be set by derived classes if a key button bar is used. More...
 
- Protected Attributes inherited from OpenOrienteering::MapEditorTool
MapEditorController *const editor
 The map editor which uses this tool. More...
 

Additional Inherited Members

- 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
 
- Protected Slots inherited from OpenOrienteering::MapEditorToolBase
void updateDirtyRect ()
 
void objectSelectionChanged ()
 
void updatePreviewObjectsSlot ()
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Base class for object editing tools.

Member Enumeration Documentation

◆ HoverFlag

A type for general information on what is hovered over.

Enumerator
OverNothing 
OverFrame 
OverObjectNode 
OverPathEdge 

Constructor & Destructor Documentation

◆ EditTool()

OpenOrienteering::EditTool::EditTool ( MapEditorController editor,
MapEditorTool::Type  type,
QAction tool_action 
)

◆ ~EditTool()

OpenOrienteering::EditTool::~EditTool ( )
overridedefault

Member Function Documentation

◆ closestPointOnRect()

MapCoordF OpenOrienteering::EditTool::closestPointOnRect ( MapCoordF  point,
const QRectF rect 
)
staticprotected

Returns the point on the rect which is closest to the given point.

◆ createReplaceUndoStep()

void OpenOrienteering::EditTool::createReplaceUndoStep ( Object object)
protected

Creates a replace object undo step for the given object.

◆ deleteSelectedObjects()

void OpenOrienteering::EditTool::deleteSelectedObjects ( )
protected

Deletes all selected objects and updates the status text.

◆ drawBoundingBox()

void OpenOrienteering::EditTool::drawBoundingBox ( QPainter painter,
MapWidget widget,
const QRectF bounding_box,
const QRgb &  color 
)
protected

Draws a bounding box with a dashed line of the given color.

Parameters
bounding_boxthe box extent in map coordinates

◆ drawBoundingPath()

void OpenOrienteering::EditTool::drawBoundingPath ( QPainter painter,
MapWidget widget,
const std::vector< QPointF > &  bounding_path,
const QRgb &  color 
)
protected

Draws a bounding path with a dashed line of the given color.

Parameters
bounding_boxthe box extent in map coordinates

◆ pointOverRectangle()

bool OpenOrienteering::EditTool::pointOverRectangle ( const QPointF point,
const QRectF rect 
) const
protected

Returns if the point is inside the click_tolerance from the rect's border.

◆ setupAngleHelperFromEditedObjects()

void OpenOrienteering::EditTool::setupAngleHelperFromEditedObjects ( )
protected

Configures the angle helper from the primary directions of the edited objects.

If no primary directions are found, the default directions are set.

Member Data Documentation

◆ DeleteObjectKey

constexpr Qt::Key OpenOrienteering::EditTool::DeleteObjectKey = Qt::Key_Delete
static

The platform's key for deleting selected objects.

OS X use the backspace key for deleting selected objects, while other platforms use the delete key.

This causes translation issues and inconsistent behaviour on OS X:

  • In Finder, moving an object to trash is Cmd+Backspace.
  • Other programs are reported to use [forward] delete.
  • Some programs are reported to support multiple keys, e.g. Delete and Backspace.
  • A major source of irritation is the absence of a delete key on some Macbooks. On these keyboards, delete is entered as Fn+Backspace.
  • Some programs use another key for delete, e.g. "x". (Note that Cmd-x (aka Cut) will have a similar effect.)
Todo:
Either use a function for testing whether a key means "delete object", or switch to a QAction based implementation since QAction supports alternative QKeySequences.

◆ object_selector

QScopedPointer<ObjectSelector> OpenOrienteering::EditTool::object_selector
protected

An utility implementing object selection logic.


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