VTK
|
popup text balloons above instance of vtkProp when hovering occurs More...
#include <vtkBalloonWidget.h>
Public Member Functions | |
virtual void | SetEnabled (int) |
void | CreateDefaultRepresentation () |
void | SetRepresentation (vtkBalloonRepresentation *r) |
vtkBalloonRepresentation * | GetBalloonRepresentation () |
void | AddBalloon (vtkProp *prop, vtkStdString *str, vtkImageData *img) |
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) |
vtkImageData * | GetBalloonImage (vtkProp *prop) |
void | UpdateBalloonString (vtkProp *prop, const char *str) |
void | UpdateBalloonImage (vtkProp *prop, vtkImageData *image) |
virtual vtkProp * | GetCurrentProp () |
void | SetPicker (vtkAbstractPropPicker *) |
virtual vtkAbstractPropPicker * | GetPicker () |
![]() | |
virtual void | SetTimerDuration (int) |
virtual int | GetTimerDuration () |
void | CreateDefaultRepresentation () |
vtkHoverWidget * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
![]() | |
void | Render () |
virtual void | SetPriority (float) |
virtual void | SetProcessEvents (int) |
virtual int | GetProcessEvents () |
virtual void | ProcessEventsOn () |
virtual void | ProcessEventsOff () |
vtkWidgetEventTranslator * | GetEventTranslator () |
void | SetParent (vtkAbstractWidget *parent) |
virtual vtkAbstractWidget * | GetParent () |
vtkWidgetRepresentation * | GetRepresentation () |
virtual void | SetManagesCursor (int) |
virtual int | GetManagesCursor () |
virtual void | ManagesCursorOn () |
virtual void | ManagesCursorOff () |
vtkAbstractWidget * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
static vtkBalloonWidget * | New () |
![]() | |
static vtkHoverWidget * | New () |
static int | IsTypeOf (const char *type) |
static vtkHoverWidget * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
vtkBalloonWidget () | |
~vtkBalloonWidget () | |
virtual int | SubclassEndHoverAction () |
virtual int | SubclassHoverAction () |
virtual void | RegisterPickers () |
![]() | |
vtkHoverWidget () | |
~vtkHoverWidget () | |
virtual int | SubclassSelectAction () |
![]() | |
vtkAbstractWidget () | |
~vtkAbstractWidget () | |
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
virtual void | SetCursor (int vtkNotUsed(state)) |
Protected Attributes | |
vtkPropMap * | PropMap |
vtkAbstractPropPicker * | Picker |
vtkProp * | CurrentProp |
![]() | |
int | WidgetState |
int | TimerId |
int | TimerDuration |
![]() | |
vtkWidgetRepresentation * | WidgetRep |
int | ManagesCursor |
vtkWidgetEventTranslator * | EventTranslator |
vtkWidgetCallbackMapper * | CallbackMapper |
vtkAbstractWidget * | Parent |
void * | CallData |
int | ProcessEvents |
typedef vtkHoverWidget | Superclass |
static int | IsTypeOf (const char *type) |
static vtkBalloonWidget * | SafeDownCast (vtkObjectBase *o) |
virtual int | IsA (const char *type) |
vtkBalloonWidget * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual vtkObjectBase * | NewInstanceInternal () const |
Additional Inherited Members | |
![]() | |
typedef vtkAbstractWidget | Superclass |
![]() | |
typedef vtkInteractorObserver | Superclass |
![]() | |
enum | { Start =0, Timing, TimedOut } |
![]() | |
static void | MoveAction (vtkAbstractWidget *) |
static void | HoverAction (vtkAbstractWidget *) |
static void | SelectAction (vtkAbstractWidget *) |
![]() | |
static void | ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata) |
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 90 of file vtkBalloonWidget.h.
Standard methods for a VTK class.
Definition at line 98 of file vtkBalloonWidget.h.
|
protected |
|
protected |
|
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.
void vtkBalloonWidget::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
Standard methods for a VTK class.
|
virtual |
The method for activating and deactivating this widget. This method must be overridden because it performs special timer-related operations.
Reimplemented from vtkHoverWidget.
|
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 111 of file vtkBalloonWidget.h.
|
inline |
Return the representation as a vtkBalloonRepresentation.
Definition at line 117 of file vtkBalloonWidget.h.
|
virtual |
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 129 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 | ) |
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). A NULL will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.
vtkImageData* vtkBalloonWidget::GetBalloonImage | ( | vtkProp * | prop | ) |
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). A NULL will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.
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 NULL (if hovering over nothing or the mouse is moving).
Definition at line 153 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.)
|
protectedvirtual |
Reimplemented from vtkHoverWidget.
|
protectedvirtual |
Reimplemented from vtkHoverWidget.
|
protectedvirtual |
|
protected |
Definition at line 175 of file vtkBalloonWidget.h.
|
protected |
Definition at line 178 of file vtkBalloonWidget.h.
|
protected |
Definition at line 184 of file vtkBalloonWidget.h.