vtkHoverWidget Class Reference
#include <vtkHoverWidget.h>
Detailed Description
invoke a vtkTimerEvent when hoveringThe vtkHoverWidget is used to invoke an event when hovering in a render window. Hovering occurs when mouse motion (in the render window) does not occur for a specified amount of time (i.e., TimerDuration). This class can be used as is (by observing TimerEvents) or for class derivation for those classes wishing to do more with the hover event.
To use this widget, specify an instance of vtkHoverWidget and specify the time (in milliseconds) defining the hover period. Unlike most widgets, this widget does not require a representation (although subclasses like vtkBalloonWidget do require a representation).
- Event Bindings:
- By default, the widget observes the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
MouseMoveEvent - manages a timer used to determine whether the mouse is hovering. TimerEvent - when the time between events (e.g., mouse move), then a timer event is invoked. KeyPressEvent - when the "Enter" key is pressed after the balloon appears, a callback is activited (e.g., WidgetActivateEvent).
- Event Bindings:
- Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkHoverWidget's widget events:
vtkWidgetEvent::Move -- start (or reset) the timer vtkWidgetEvent::TimedOut -- when enough time is elapsed between defined VTK events the hover event is invoked. vtkWidgetEvent::SelectAction -- activate any callbacks associated with the balloon.
- Event Bindings:
- This widget invokes the following VTK events on itself when the widget determines that it is hovering. Note that observers of this widget can listen for these events and take appropriate action.
vtkCommand::TimerEvent (when hovering is determined to occur) vtkCommand::EndInteractionEvent (after a hover has occured and the mouse begins moving again). vtkCommand::WidgetActivateEvent (when the balloon is selected with a keypress).
- See also:
- vtkAbstractWidget
- Events:
- vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::TimerEvent vtkCommand::EnableEvent vtkCommand::WidgetActivateEvent
Definition at line 78 of file vtkHoverWidget.h.
| typedef vtkAbstractWidget | Superclass |
| static int | IsTypeOf (const char *type) |
| static vtkHoverWidget * | SafeDownCast (vtkObject *o) |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
Public Member Functions | |
| virtual void | SetEnabled (int) |
| virtual void | SetTimerDuration (int) |
| virtual int | GetTimerDuration () |
| void | CreateDefaultRepresentation () |
Static Public Member Functions | |
| static vtkHoverWidget * | New () |
Protected Types | |
| enum | { Start = 0, Timing, TimedOut } |
Protected Member Functions | |
| vtkHoverWidget () | |
| ~vtkHoverWidget () | |
| virtual int | SubclassHoverAction () |
| virtual int | SubclassEndHoverAction () |
| virtual int | SubclassSelectAction () |
Static Protected Member Functions | |
| static void | MoveAction (vtkAbstractWidget *) |
| static void | HoverAction (vtkAbstractWidget *) |
| static void | SelectAction (vtkAbstractWidget *) |
Protected Attributes | |
| int | WidgetState |
| int | TimerId |
| int | TimerDuration |
Member Typedef Documentation
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
Definition at line 86 of file vtkHoverWidget.h.
Member Enumeration Documentation
anonymous enum [protected] |
Constructor & Destructor Documentation
| vtkHoverWidget::vtkHoverWidget | ( | ) | [protected] |
| vtkHoverWidget::~vtkHoverWidget | ( | ) | [protected] |
Member Function Documentation
| static vtkHoverWidget* vtkHoverWidget::New | ( | ) | [static] |
| virtual const char* vtkHoverWidget::GetClassName | ( | ) | [virtual] |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
| static int vtkHoverWidget::IsTypeOf | ( | const char * | type | ) | [static] |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
| virtual int vtkHoverWidget::IsA | ( | const char * | type | ) | [virtual] |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
| static vtkHoverWidget* vtkHoverWidget::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
| void vtkHoverWidget::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
| virtual void vtkHoverWidget::SetTimerDuration | ( | int | ) | [virtual] |
Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.
| virtual int vtkHoverWidget::GetTimerDuration | ( | ) | [virtual] |
Specify the hovering interval (in milliseconds). If after moving the mouse the pointer stays over a vtkProp for this duration, then a vtkTimerEvent::TimerEvent is invoked.
| virtual void vtkHoverWidget::SetEnabled | ( | int | ) | [virtual] |
The method for activiating and deactiviating this widget. This method must be overridden because it performs special timer-related operations.
Reimplemented from vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
| void vtkHoverWidget::CreateDefaultRepresentation | ( | ) | [inline, virtual] |
A default representation, of which there is none, is created. Note that the superclasses vtkAbstractWidget::GetRepresentation() method returns NULL.
Implements vtkAbstractWidget.
Reimplemented in vtkBalloonWidget.
Definition at line 107 of file vtkHoverWidget.h.
| static void vtkHoverWidget::MoveAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkHoverWidget::HoverAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| static void vtkHoverWidget::SelectAction | ( | vtkAbstractWidget * | ) | [static, protected] |
| virtual int vtkHoverWidget::SubclassHoverAction | ( | ) | [inline, protected, virtual] |
| virtual int vtkHoverWidget::SubclassEndHoverAction | ( | ) | [inline, protected, virtual] |
| virtual int vtkHoverWidget::SubclassSelectAction | ( | ) | [inline, protected, virtual] |
Definition at line 130 of file vtkHoverWidget.h.
Member Data Documentation
int vtkHoverWidget::WidgetState [protected] |
Definition at line 119 of file vtkHoverWidget.h.
int vtkHoverWidget::TimerId [protected] |
Helper methods for creating and destroying timers.
Definition at line 134 of file vtkHoverWidget.h.
int vtkHoverWidget::TimerDuration [protected] |
Helper methods for creating and destroying timers.
Definition at line 135 of file vtkHoverWidget.h.
The documentation for this class was generated from the following file:
- dox/Widgets/vtkHoverWidget.h
