the parent class of all the select and the transform tool classes More...
#include <toolInterface.h>
Public Member Functions | |
| virtual void | draw () const =0 |
| a rendering facility used by a tool. For instance, if this tool is a selection tool, this function draws highlighted points as well as selection region, e.g., rubberband, box, etc. | |
| virtual void | end (int x, int y, BitMask modifiers, BitMask buttons)=0 |
| set final state of the tool from the screen coordinates of the mouse as well as the value of the modifier. Also performs the corresponding functionalities of the tool. | |
| virtual void | start (int x, int y, BitMask modifiers, BitMask buttons)=0 |
| set the initial state of the tool from the screen coordinates of the mouse as well as the value of the modifier. | |
| virtual void | update (int x, int y, BitMask modifiers, BitMask buttons)=0 |
| update the state of the tool from the screen coordinates of the mouse as well as the value of the modifier. | |
| virtual | ~ToolInterface () |
| Destructor. | |
Protected Member Functions | |
| ToolInterface () | |
| Default constructor. | |
Private Member Functions | |
| ToolInterface & | operator= (const ToolInterface &) |
| Equal operator - tools are non-copyable. | |
| ToolInterface (const ToolInterface &) | |
| Copy constructor - tools are non-copyable. | |
Detailed Description
the parent class of all the select and the transform tool classes
Definition at line 48 of file toolInterface.h.
Constructor & Destructor Documentation
| virtual ToolInterface::~ToolInterface | ( | ) | [inline, virtual] |
Destructor.
Definition at line 52 of file toolInterface.h.
| ToolInterface::ToolInterface | ( | ) | [inline, protected] |
Default constructor.
Definition at line 105 of file toolInterface.h.
| ToolInterface::ToolInterface | ( | const ToolInterface & | ) | [inline, private] |
Copy constructor - tools are non-copyable.
Definition at line 111 of file toolInterface.h.
Member Function Documentation
| virtual void ToolInterface::draw | ( | ) | const [pure virtual] |
a rendering facility used by a tool. For instance, if this tool is a selection tool, this function draws highlighted points as well as selection region, e.g., rubberband, box, etc.
Implemented in SelectionTransformTool, CloudTransformTool, Select2DTool, and Select1DTool.
| virtual void ToolInterface::end | ( | int | x, |
| int | y, | ||
| BitMask | modifiers, | ||
| BitMask | buttons | ||
| ) | [pure virtual] |
set final state of the tool from the screen coordinates of the mouse as well as the value of the modifier. Also performs the corresponding functionalities of the tool.
- Parameters:
-
x the x coordinate of the mouse screen coordinates. y the y coordinate of the mouse screen coordinates. modifiers The keyboard modifiers. We use modifier to change the behavior of a tool. Values of a modifier can be control key, alt key shift key, or no key is pressed. See the subclasses of this class for specific usages of the modifiers. buttons The state of the mouse buttons
Implemented in SelectionTransformTool, CloudTransformTool, Select2DTool, and Select1DTool.
| ToolInterface& ToolInterface::operator= | ( | const ToolInterface & | ) | [inline, private] |
Equal operator - tools are non-copyable.
Definition at line 118 of file toolInterface.h.
| virtual void ToolInterface::start | ( | int | x, |
| int | y, | ||
| BitMask | modifiers, | ||
| BitMask | buttons | ||
| ) | [pure virtual] |
set the initial state of the tool from the screen coordinates of the mouse as well as the value of the modifier.
- Parameters:
-
x the x coordinate of the mouse screen coordinates. y the y coordinate of the mouse screen coordinates. modifiers The keyboard modifiers. We use modifier to change the behavior of a tool. Values of a modifier can be control key, alt key shift key, or no key is pressed. See the subclasses of this class for specific usages of the modifiers. buttons The state of the mouse buttons
Implemented in SelectionTransformTool, CloudTransformTool, Select2DTool, and Select1DTool.
| virtual void ToolInterface::update | ( | int | x, |
| int | y, | ||
| BitMask | modifiers, | ||
| BitMask | buttons | ||
| ) | [pure virtual] |
update the state of the tool from the screen coordinates of the mouse as well as the value of the modifier.
- Parameters:
-
x the x coordinate of the mouse screen coordinates. y the y coordinate of the mouse screen coordinates. modifiers The keyboard modifiers. We use modifier to change the behavior of a tool. Values of a modifier can be control key, alt key shift key, or no key is pressed. See the subclasses of this class for specific usages of the modifiers. buttons The state of the mouse buttons
Implemented in SelectionTransformTool, CloudTransformTool, Select2DTool, and Select1DTool.
The documentation for this class was generated from the following file: