|
| void | SetEnabled (int) override |
| | The method for activating and deactivating this widget. More...
|
| |
| void | CreateDefaultRepresentation () override |
| | A default representation, of which there is none, is created. More...
|
| |
|
| virtual void | SetTimerDuration (int) |
| | Specify the hovering interval (in milliseconds). More...
|
| |
| virtual int | GetTimerDuration () |
| | Specify the hovering interval (in milliseconds). More...
|
| |
| vtkWidgetEventTranslator * | GetEventTranslator () |
| | Get the event translator. More...
|
| |
| void | Render () |
| | This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
|
| |
| void | SetParent (vtkAbstractWidget *parent) |
| | Specifying a parent to this widget is used when creating composite widgets. More...
|
| |
| virtual vtkAbstractWidget * | GetParent () |
| |
| void | SetPriority (float) override |
| | Override the superclass method. More...
|
| |
| virtual void | SetProcessEvents (vtkTypeBool) |
| | Methods to change whether the widget responds to interaction. More...
|
| |
| virtual vtkTypeBool | GetProcessEvents () |
| | Methods to change whether the widget responds to interaction. More...
|
| |
| virtual void | ProcessEventsOn () |
| | Methods to change whether the widget responds to interaction. More...
|
| |
| virtual void | ProcessEventsOff () |
| | Methods to change whether the widget responds to interaction. More...
|
| |
| vtkWidgetRepresentation * | GetRepresentation () |
| | Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
|
| |
| virtual void | SetManagesCursor (vtkTypeBool) |
| | Turn on or off the management of the cursor. More...
|
| |
| virtual vtkTypeBool | GetManagesCursor () |
| | Turn on or off the management of the cursor. More...
|
| |
| virtual void | ManagesCursorOn () |
| | Turn on or off the management of the cursor. More...
|
| |
| virtual void | ManagesCursorOff () |
| | Turn on or off the management of the cursor. More...
|
| |
| vtkAbstractWidget * | NewInstance () const |
| | Standard macros implementing standard VTK methods. More...
|
| |
| vtkInteractorObserver * | NewInstance () const |
| |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses. More...
|
| |
| int | GetEnabled () |
| |
| void | EnabledOn () |
| |
| void | EnabledOff () |
| |
| void | On () |
| |
| void | Off () |
| |
| virtual void | OnChar () |
| | Sets up the keypress-i event. More...
|
| |
| virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
| | This method is used to associate the widget with the render window interactor. More...
|
| |
| virtual vtkRenderWindowInteractor * | GetInteractor () |
| | This method is used to associate the widget with the render window interactor. More...
|
| |
| virtual float | GetPriority () |
| | Set/Get the priority at which events are processed. More...
|
| |
| virtual void | PickingManagedOn () |
| | Enable/Disable the use of a manager to process the picking. More...
|
| |
| virtual void | PickingManagedOff () |
| | Enable/Disable the use of a manager to process the picking. More...
|
| |
| virtual void | SetPickingManaged (bool managed) |
| | Enable/Disable the use of a manager to process the picking. More...
|
| |
| virtual bool | GetPickingManaged () |
| | Enable/Disable the use of a manager to process the picking. More...
|
| |
| virtual void | SetKeyPressActivation (vtkTypeBool) |
| | Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
| |
| virtual vtkTypeBool | GetKeyPressActivation () |
| | Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
| |
| virtual void | KeyPressActivationOn () |
| | Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
| |
| virtual void | KeyPressActivationOff () |
| | Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
| |
| virtual void | SetKeyPressActivationValue (char) |
| | Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
|
| |
| virtual char | GetKeyPressActivationValue () |
| | Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
|
| |
| virtual vtkRenderer * | GetDefaultRenderer () |
| | Set/Get the default renderer to use when activating the interactor observer. More...
|
| |
| virtual void | SetDefaultRenderer (vtkRenderer *) |
| | Set/Get the default renderer to use when activating the interactor observer. More...
|
| |
| virtual vtkRenderer * | GetCurrentRenderer () |
| | Set/Get the current renderer. More...
|
| |
| virtual void | SetCurrentRenderer (vtkRenderer *) |
| | Set/Get the current renderer. More...
|
| |
| void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| | These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
|
| |
| void | ReleaseFocus () |
| | These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
|
| |
| | vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
| |
| virtual void | DebugOn () |
| | Turn debugging output on. More...
|
| |
| virtual void | DebugOff () |
| | Turn debugging output off. More...
|
| |
| bool | GetDebug () |
| | Get the value of the debug flag. More...
|
| |
| void | SetDebug (bool debugFlag) |
| | Set the value of the debug flag. More...
|
| |
| virtual void | Modified () |
| | Update the modification time for this object. More...
|
| |
| virtual vtkMTimeType | GetMTime () |
| | Return this object's modified time. More...
|
| |
| void | RemoveObserver (unsigned long tag) |
| |
| void | RemoveObservers (unsigned long event) |
| |
| void | RemoveObservers (const char *event) |
| |
| void | RemoveAllObservers () |
| |
| vtkTypeBool | HasObserver (unsigned long event) |
| |
| vtkTypeBool | HasObserver (const char *event) |
| |
| int | InvokeEvent (unsigned long event) |
| |
| int | InvokeEvent (const char *event) |
| |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| vtkCommand * | GetCommand (unsigned long tag) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| void | RemoveObserver (vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| void | RemoveObservers (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
|
| |
| template<class U , class T > |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| | Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
|
| |
| template<class U , class T > |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| | Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
|
| |
| template<class U , class T > |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| | Allow user to set the AbortFlagOn() with the return value of the callback method. More...
|
| |
| int | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not. More...
|
| |
| int | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not. More...
|
| |
| const char * | GetClassName () const |
| | Return the class name as a string. More...
|
| |
| virtual void | Delete () |
| | Delete a VTK object. More...
|
| |
| virtual void | FastDelete () |
| | Delete a reference to this object. More...
|
| |
| void | InitializeObjectBase () |
| |
| void | Print (ostream &os) |
| | Print an object to an ostream. More...
|
| |
| virtual void | Register (vtkObjectBase *o) |
| | Increase the reference count (mark as used by another object). More...
|
| |
| virtual void | UnRegister (vtkObjectBase *o) |
| | Decrease the reference count (release by another object). More...
|
| |
| int | GetReferenceCount () |
| | Return the current reference count of this object. More...
|
| |
| void | SetReferenceCount (int) |
| | Sets the reference count. More...
|
| |
| void | PrintRevisions (ostream &) |
| | Legacy. More...
|
| |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses. More...
|
| |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses. More...
|
| |
|
| static vtkHoverWidget * | New () |
| | Instantiate this class. More...
|
| |
| static vtkTypeBool | IsTypeOf (const char *type) |
| | Standard macros implementing standard VTK methods. More...
|
| |
| static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
| | Standard macros implementing standard VTK methods. More...
|
| |
| static vtkTypeBool | IsTypeOf (const char *type) |
| |
| static vtkInteractorObserver * | SafeDownCast (vtkObjectBase *o) |
| |
| static void | ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4]) |
| | Convenience methods for outside classes. More...
|
| |
| static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
| | Convenience methods for outside classes. More...
|
| |
| static vtkObject * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
| |
| static void | BreakOnError () |
| | This method is called when vtkErrorMacro executes. More...
|
| |
| static void | SetGlobalWarningDisplay (int val) |
| | This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
| |
| static void | GlobalWarningDisplayOn () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
| |
| static void | GlobalWarningDisplayOff () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
| |
| static int | GetGlobalWarningDisplay () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed. More...
|
| |
| static vtkTypeBool | IsTypeOf (const char *name) |
| | Return 1 if this class type is the same type of (or a subclass of) the named class. More...
|
| |
| static vtkObjectBase * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
|
| |
invoke a vtkTimerEvent when hovering
The 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 activated (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 occurred and the
mouse begins moving again).
vtkCommand::WidgetActivateEvent (when the balloon is selected with a
keypress).
- See also
- vtkAbstractWidget
- Tests:
- vtkHoverWidget (Tests)
Definition at line 80 of file vtkHoverWidget.h.
Public Member Functions inherited from vtkAbstractWidget