OpenStructure
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions
Tool Class Referenceabstract

#include <tool.hh>

Inherits QObject.

Inherited by Manipulator, MapTool, MeasureTool, and SelectionTool.

Public Member Functions

virtual ~Tool ()
 
virtual void Click (const MouseEvent &event)
 
virtual void DoubleClick (const MouseEvent &event)
 
virtual void MousePress (const MouseEvent &event)
 
virtual void MouseMove (const MouseEvent &event)
 
virtual void RenderGL ()
 
virtual void Activate ()
 
virtual void Deactivate ()
 
virtual bool CanOperateOn (gfx::NodePtrList nodes)=0
 
ToolOptions * GetToolOptions () const
 
const String & GetName () const
 
virtual QIcon GetIcon () const
 

Protected Member Functions

 Tool (const String &name)
 

Detailed Description

base class for tools

Parameters of the tool that are configurable should be implemented using the ToolOptions facility. This automatically takes care of remembering the used options over different sessions (in the future) and creates a widget to modify these options.

Input Events

Tools receive input events when the Control key (Command on macOS) is pressed. This includes both keyboard events and mouse events such as mouse move events, clicks and Real clicks.

Tools only receive mouse move events when one of the mouse buttons is pressed.

CanOperateOn() determines if the tool can manipulate a certain gfx::GfxNodeP. This method is used to enabled/disable certain actions (in the toolbar, for example).

See Also
Color Tool Example

Definition at line 62 of file tool.hh.

Constructor & Destructor Documentation

Tool ( const String &  name)
protected
virtual ~Tool ( )
virtual

Member Function Documentation

virtual void Activate ( )
inlinevirtual

called when the tool becomes active

Definition at line 82 of file tool.hh.

virtual bool CanOperateOn ( gfx::NodePtrList  nodes)
pure virtual

whether the tool is capable of manipulating the given node

Implemented in MeasureTool, Manipulator, SelectionTool, and MapTool.

virtual void Click ( const MouseEvent &  event)
inlinevirtual

left mouse click

Reimplemented in MeasureTool, and SelectionTool.

Definition at line 69 of file tool.hh.

virtual void Deactivate ( )
inlinevirtual

called when the tool becomes inactive

Definition at line 85 of file tool.hh.

virtual void DoubleClick ( const MouseEvent &  event)
inlinevirtual

Real click.

Reimplemented in Manipulator.

Definition at line 72 of file tool.hh.

virtual QIcon GetIcon ( ) const
virtual

Reimplemented in MeasureTool, Manipulator, SelectionTool, and MapTool.

const String& GetName ( ) const
ToolOptions* GetToolOptions ( ) const
virtual void MouseMove ( const MouseEvent &  event)
inlinevirtual

Reimplemented in Manipulator, and MapTool.

Definition at line 76 of file tool.hh.

virtual void MousePress ( const MouseEvent &  event)
inlinevirtual

Definition at line 74 of file tool.hh.

virtual void RenderGL ( )
inlinevirtual

Reimplemented in MeasureTool.

Definition at line 78 of file tool.hh.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5