VTK
9.1.0
|
popup text balloons above instance of vtkProp when hovering occurs More...
#include <vtkBalloonWidget.h>
Public Member Functions | |
void | SetEnabled (int) override |
The method for activating and deactivating this widget. | |
void | SetRepresentation (vtkBalloonRepresentation *r) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. | |
vtkBalloonRepresentation * | GetBalloonRepresentation () |
Return the representation as a vtkBalloonRepresentation. | |
void | CreateDefaultRepresentation () override |
Create the default widget representation if one is not set. | |
virtual vtkProp * | GetCurrentProp () |
Return the current vtkProp that is being hovered over. | |
void | RegisterPickers () override |
Register internal Pickers in the Picking Manager. | |
void | AddBalloon (vtkProp *prop, vtkStdString *str, vtkImageData *img) |
Add and remove text and/or an image to be associated with a vtkProp. | |
void | AddBalloon (vtkProp *prop, const char *str, vtkImageData *img) |
Add and remove text and/or an image to be associated with a vtkProp. | |
void | AddBalloon (vtkProp *prop, const char *str) |
Add and remove text and/or an image to be associated with a vtkProp. | |
void | RemoveBalloon (vtkProp *prop) |
Add and remove text and/or an image to be associated with a vtkProp. | |
const char * | GetBalloonString (vtkProp *prop) |
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). | |
vtkImageData * | GetBalloonImage (vtkProp *prop) |
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). | |
void | UpdateBalloonString (vtkProp *prop, const char *str) |
Update the balloon string or image. | |
void | UpdateBalloonImage (vtkProp *prop, vtkImageData *image) |
Update the balloon string or image. | |
void | SetPicker (vtkAbstractPropPicker *) |
Set/Get the object used to perform pick operations. | |
virtual vtkAbstractPropPicker * | GetPicker () |
Set/Get the object used to perform pick operations. | |
Public Member Functions inherited from vtkHoverWidget | |
void | SetEnabled (int) override |
The method for activating and deactivating this widget. | |
void | CreateDefaultRepresentation () override |
A default representation, of which there is none, is created. | |
virtual void | SetTimerDuration (int) |
Specify the hovering interval (in milliseconds). | |
virtual int | GetTimerDuration () |
Specify the hovering interval (in milliseconds). | |
vtkHoverWidget * | NewInstance () const |
Standard methods for a VTK class. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard methods for a VTK class. | |
Public Member Functions inherited from vtkAbstractWidget | |
void | SetEnabled (int) override |
Methods for activating this widget. | |
vtkWidgetEventTranslator * | GetEventTranslator () |
Get the event translator. | |
virtual void | CreateDefaultRepresentation ()=0 |
Create the default widget representation if one is not set. | |
void | Render () |
This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. | |
void | SetParent (vtkAbstractWidget *parent) |
Specifying a parent to this widget is used when creating composite widgets. | |
virtual vtkAbstractWidget * | GetParent () |
void | SetPriority (float) override |
Override the superclass method. | |
virtual void | SetProcessEvents (vtkTypeBool) |
Methods to change whether the widget responds to interaction. | |
virtual vtkTypeBool | GetProcessEvents () |
Methods to change whether the widget responds to interaction. | |
virtual void | ProcessEventsOn () |
Methods to change whether the widget responds to interaction. | |
virtual void | ProcessEventsOff () |
Methods to change whether the widget responds to interaction. | |
vtkWidgetRepresentation * | GetRepresentation () |
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. | |
virtual void | SetManagesCursor (vtkTypeBool) |
Turn on or off the management of the cursor. | |
virtual vtkTypeBool | GetManagesCursor () |
Turn on or off the management of the cursor. | |
virtual void | ManagesCursorOn () |
Turn on or off the management of the cursor. | |
virtual void | ManagesCursorOff () |
Turn on or off the management of the cursor. | |
vtkAbstractWidget * | NewInstance () const |
Standard macros implementing standard VTK methods. | |
Public Member Functions inherited from vtkInteractorObserver | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkInteractorObserver * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | SetEnabled (int) |
Methods for turning the interactor observer on and off, and determining its state. | |
int | GetEnabled () |
void | EnabledOn () |
void | EnabledOff () |
void | On () |
void | Off () |
virtual void | OnChar () |
Sets up the keypress-i event. | |
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
This method is used to associate the widget with the render window interactor. | |
virtual vtkRenderWindowInteractor * | GetInteractor () |
This method is used to associate the widget with the render window interactor. | |
virtual float | GetPriority () |
Set/Get the priority at which events are processed. | |
virtual void | PickingManagedOn () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | PickingManagedOff () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | SetPickingManaged (bool managed) |
Enable/Disable the use of a manager to process the picking. | |
virtual bool | GetPickingManaged () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | SetKeyPressActivation (vtkTypeBool) |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual vtkTypeBool | GetKeyPressActivation () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual void | KeyPressActivationOn () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual void | KeyPressActivationOff () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual void | SetKeyPressActivationValue (char) |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). | |
virtual char | GetKeyPressActivationValue () |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). | |
virtual vtkRenderer * | GetDefaultRenderer () |
Set/Get the default renderer to use when activating the interactor observer. | |
virtual void | SetDefaultRenderer (vtkRenderer *) |
Set/Get the default renderer to use when activating the interactor observer. | |
virtual vtkRenderer * | GetCurrentRenderer () |
Set/Get the current renderer. | |
virtual void | SetCurrentRenderer (vtkRenderer *) |
Set/Get the current renderer. | |
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. | |
void | ReleaseFocus () |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkBalloonWidget * | New () |
Instantiate this class. | |
Static Public Member Functions inherited from vtkHoverWidget | |
static vtkHoverWidget * | New () |
Instantiate this class. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for a VTK class. | |
static vtkHoverWidget * | SafeDownCast (vtkObjectBase *o) |
Standard methods for a VTK class. | |
Static Public Member Functions inherited from vtkAbstractWidget | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard macros implementing standard VTK methods. | |
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
Standard macros implementing standard VTK methods. | |
Static Public Member Functions inherited from vtkInteractorObserver | |
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. | |
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
Convenience methods for outside classes. | |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
vtkBalloonWidget () | |
~vtkBalloonWidget () override | |
int | SubclassEndHoverAction () override |
int | SubclassHoverAction () override |
Protected Member Functions inherited from vtkHoverWidget | |
vtkHoverWidget () | |
~vtkHoverWidget () override | |
virtual int | SubclassHoverAction () |
virtual int | SubclassEndHoverAction () |
virtual int | SubclassSelectAction () |
Protected Member Functions inherited from vtkAbstractWidget | |
vtkAbstractWidget () | |
~vtkAbstractWidget () override | |
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
virtual void | SetCursor (int vtkNotUsed(state)) |
Protected Member Functions inherited from vtkInteractorObserver | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkInteractorObserver () | |
~vtkInteractorObserver () override | |
virtual void | RegisterPickers () |
Register internal Pickers in the Picking Manager. | |
void | UnRegisterPickers () |
Unregister internal pickers from the Picking Manager. | |
vtkPickingManager * | GetPickingManager () |
Return the picking manager associated on the context on which the observer currently belong. | |
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. | |
int | RequestCursorShape (int requestedShape) |
virtual void | StartInteraction () |
Utility routines used to start and end interaction. | |
virtual void | EndInteraction () |
Utility routines used to start and end interaction. | |
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
Helper method for subclasses. | |
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
Helper method for subclasses. | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Public Types inherited from vtkHoverWidget | |
typedef vtkAbstractWidget | Superclass |
Standard methods for a VTK class. | |
Public Types inherited from vtkAbstractWidget | |
typedef vtkInteractorObserver | Superclass |
Standard macros implementing standard VTK methods. | |
Public Types inherited from vtkInteractorObserver | |
typedef vtkObject | Superclass |
Protected Types inherited from vtkHoverWidget | |
enum | { Start = 0 , Timing , TimedOut } |
Static Protected Member Functions inherited from vtkHoverWidget | |
static void | MoveAction (vtkAbstractWidget *) |
static void | HoverAction (vtkAbstractWidget *) |
static void | SelectAction (vtkAbstractWidget *) |
Static Protected Member Functions inherited from vtkAbstractWidget | |
static void | ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
Static Protected Member Functions inherited from vtkInteractorObserver | |
static void | ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
Handles the char widget activation event. | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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).
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).
vtkWidgetEvent::Move -- start the timer vtkWidgetEvent::TimedOut -- when hovering occurs, vtkWidgetEvent::SelectAction -- activate any callbacks associated with the balloon.
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).
Definition at line 103 of file vtkBalloonWidget.h.
Standard methods for a VTK class.
Definition at line 115 of file vtkBalloonWidget.h.
|
protected |
|
overrideprotected |
|
static |
Instantiate this class.
|
static |
Standard methods for a VTK class.
|
virtual |
Standard methods for a VTK class.
Reimplemented from vtkHoverWidget.
|
static |
Standard methods for a VTK class.
|
protectedvirtual |
Standard methods for a VTK class.
Reimplemented from vtkHoverWidget.
vtkBalloonWidget * vtkBalloonWidget::NewInstance | ( | ) | const |
Standard methods for a VTK class.
|
overridevirtual |
Standard methods for a VTK class.
Reimplemented from vtkAbstractWidget.
|
overridevirtual |
The method for activating and deactivating this widget.
This method must be overridden because it performs special timer-related operations.
Reimplemented from vtkAbstractWidget.
|
inline |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.
Definition at line 130 of file vtkBalloonWidget.h.
|
inline |
Return the representation as a vtkBalloonRepresentation.
Definition at line 138 of file vtkBalloonWidget.h.
|
overridevirtual |
Create the default widget representation if one is not set.
Implements vtkAbstractWidget.
void vtkBalloonWidget::AddBalloon | ( | vtkProp * | prop, |
vtkStdString * | str, | ||
vtkImageData * | img | ||
) |
Add and remove text and/or an image to be associated with a vtkProp.
You may add one or both of them.
void vtkBalloonWidget::AddBalloon | ( | vtkProp * | prop, |
const char * | str, | ||
vtkImageData * | img | ||
) |
Add and remove text and/or an image to be associated with a vtkProp.
You may add one or both of them.
|
inline |
Add and remove text and/or an image to be associated with a vtkProp.
You may add one or both of them.
Definition at line 155 of file vtkBalloonWidget.h.
void vtkBalloonWidget::RemoveBalloon | ( | vtkProp * | prop | ) |
Add and remove text and/or an image to be associated with a vtkProp.
You may add one or both of them.
const char * vtkBalloonWidget::GetBalloonString | ( | vtkProp * | prop | ) |
vtkImageData * vtkBalloonWidget::GetBalloonImage | ( | vtkProp * | prop | ) |
void vtkBalloonWidget::UpdateBalloonString | ( | vtkProp * | prop, |
const char * | str | ||
) |
Update the balloon string or image.
If the specified prop does not exist, then nothing is added not changed.
void vtkBalloonWidget::UpdateBalloonImage | ( | vtkProp * | prop, |
vtkImageData * | image | ||
) |
Update the balloon string or image.
If the specified prop does not exist, then nothing is added not changed.
|
inlinevirtual |
Return the current vtkProp that is being hovered over.
Note that the value may be nullptr (if hovering over nothing or the mouse is moving).
Definition at line 186 of file vtkBalloonWidget.h.
void vtkBalloonWidget::SetPicker | ( | vtkAbstractPropPicker * | ) |
Set/Get the object used to perform pick operations.
Since the vtkBalloonWidget operates on vtkProps, the picker must be a subclass of vtkAbstractPropPicker. (Note: if not specified, an instance of vtkPropPicker is used.)
|
virtual |
Set/Get the object used to perform pick operations.
Since the vtkBalloonWidget operates on vtkProps, the picker must be a subclass of vtkAbstractPropPicker. (Note: if not specified, an instance of vtkPropPicker is used.)
|
overridevirtual |
Register internal Pickers in the Picking Manager.
Must be reimplemented by concrete widgets to register their pickers.
Reimplemented from vtkInteractorObserver.
|
overrideprotectedvirtual |
Reimplemented from vtkHoverWidget.
|
overrideprotectedvirtual |
Reimplemented from vtkHoverWidget.
|
protected |
Definition at line 213 of file vtkBalloonWidget.h.
|
protected |
Definition at line 216 of file vtkBalloonWidget.h.
|
protected |
Definition at line 219 of file vtkBalloonWidget.h.