|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkBalloonWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
void | SetEnabled (int) override |
| The method for activating and deactivating this widget. More...
|
|
void | SetRepresentation (vtkBalloonRepresentation *r) |
| Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
|
|
vtkBalloonRepresentation * | GetBalloonRepresentation () |
| Return the representation as a vtkBalloonRepresentation. More...
|
|
void | CreateDefaultRepresentation () override |
| Create the default widget representation if one is not set. More...
|
|
void | AddBalloon (vtkProp *prop, vtkStdString *str, vtkImageData *img) |
| Add and remove text and/or an image to be associated with a vtkProp. More...
|
|
void | AddBalloon (vtkProp *prop, const char *str, vtkImageData *img) |
|
void | AddBalloon (vtkProp *prop, const char *str) |
|
void | RemoveBalloon (vtkProp *prop) |
|
const char * | GetBalloonString (vtkProp *prop) |
| Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). More...
|
|
vtkImageData * | GetBalloonImage (vtkProp *prop) |
|
void | UpdateBalloonString (vtkProp *prop, const char *str) |
| Update the balloon string or image. More...
|
|
void | UpdateBalloonImage (vtkProp *prop, vtkImageData *image) |
|
virtual vtkProp * | GetCurrentProp () |
| Return the current vtkProp that is being hovered over. More...
|
|
void | SetPicker (vtkAbstractPropPicker *) |
| Set/Get the object used to perform pick operations. More...
|
|
virtual vtkAbstractPropPicker * | GetPicker () |
|
void | RegisterPickers () override |
| Register internal Pickers in the Picking Manager. More...
|
|
vtkHoverWidget * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
virtual void | SetTimerDuration (int) |
| Specify the hovering interval (in milliseconds). More...
|
|
virtual int | GetTimerDuration () |
|
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...
|
|
vtkAbstractWidget * | NewInstance () const |
|
virtual void | SetProcessEvents (vtkTypeBool) |
| Methods to change whether the widget responds to interaction. More...
|
|
virtual vtkTypeBool | GetProcessEvents () |
|
virtual void | ProcessEventsOn () |
|
virtual void | ProcessEventsOff () |
|
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 () |
|
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 () |
|
virtual void | ManagesCursorOn () |
|
virtual void | ManagesCursorOff () |
|
void | SetPriority (float) override |
| Override the superclass method. 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 | SetInteractor (vtkRenderWindowInteractor *iren) |
| This method is used to associate the widget with the render window interactor. More...
|
|
virtual vtkRenderWindowInteractor * | GetInteractor () |
|
virtual float | GetPriority () |
|
virtual void | PickingManagedOn () |
| Enable/Disable the use of a manager to process the picking. More...
|
|
virtual void | PickingManagedOff () |
|
virtual void | SetPickingManaged (bool managed) |
|
virtual bool | GetPickingManaged () |
|
virtual void | SetKeyPressActivation (vtkTypeBool) |
| Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
|
|
virtual vtkTypeBool | GetKeyPressActivation () |
|
virtual void | KeyPressActivationOn () |
|
virtual void | KeyPressActivationOff () |
|
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 () |
|
virtual vtkRenderer * | GetDefaultRenderer () |
| Set/Get the default renderer to use when activating the interactor observer. More...
|
|
virtual void | SetDefaultRenderer (vtkRenderer *) |
|
virtual vtkRenderer * | GetCurrentRenderer () |
| Set/Get the current renderer. More...
|
|
virtual void | SetCurrentRenderer (vtkRenderer *) |
|
virtual void | OnChar () |
| Sets up the keypress-i event. 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 () |
|
| 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...
|
|
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) |
|
vtkCommand * | GetCommand (unsigned long tag) |
|
void | RemoveObserver (vtkCommand *) |
|
void | RemoveObservers (unsigned long event, vtkCommand *) |
|
void | RemoveObservers (const char *event, vtkCommand *) |
|
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
|
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
|
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) |
|
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) |
|
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) |
|
int | InvokeEvent (unsigned long event) |
|
int | InvokeEvent (const char *event) |
|
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 | PrintHeader (ostream &os, vtkIndent indent) |
|
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
|
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...
|
|
|
static vtkBalloonWidget * | New () |
| Instantiate this class. More...
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkBalloonWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkHoverWidget * | New () |
| Instantiate this class. More...
|
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkHoverWidget * | SafeDownCast (vtkObjectBase *o) |
|
static vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
|
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]) |
|
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 () |
|
static void | GlobalWarningDisplayOff () |
|
static int | GetGlobalWarningDisplay () |
|
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...
|
|
popup text balloons above instance of vtkProp when hovering occurs
The vtkBalloonWidget is used to popup text and/or an image when the mouse hovers over an instance of vtkProp. The widget keeps track of (vtkProp,vtkBalloon) pairs (where the internal vtkBalloon class is defined by a pair of vtkStdString and vtkImageData), and when the mouse stops moving for a user-specified period of time over the vtkProp, then the vtkBalloon is drawn nearby the vtkProp. Note that an instance of vtkBalloonRepresentation is used to draw the balloon.
To use this widget, specify an instance of vtkBalloonWidget and a representation (e.g., vtkBalloonRepresentation). Then list all instances of vtkProp, a text string, and/or an instance of vtkImageData to be associated with each vtkProp. (Note that you can specify both text and an image, or just one or the other.) You may also wish to specify the hover delay (i.e., set in the superclass vtkHoverWidget).
- Event Bindings:
- By default, the widget observes the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
MouseMoveEvent - occurs when mouse is moved in render window.
TimerEvent - occurs when the time between events (e.g., mouse move)
is greater than TimerDuration.
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 vtkBalloonWidget's widget events:
vtkWidgetEvent::Move -- start the timer
vtkWidgetEvent::TimedOut -- when hovering occurs,
vtkWidgetEvent::SelectAction -- activate any callbacks associated
with the balloon.
- Event Bindings:
- This widget invokes the following VTK events on itself (which observers can listen for):
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
- Examples:
- vtkBalloonWidget (Examples)
- Tests:
- vtkBalloonWidget (Tests)
Definition at line 91 of file vtkBalloonWidget.h.