VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBalloonWidget Class Reference

popup text balloons above instance of vtkProp when hovering occurs More...

#include <vtkBalloonWidget.h>

Inheritance diagram for vtkBalloonWidget:
[legend]
Collaboration diagram for vtkBalloonWidget:
[legend]

Public Member Functions

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...
 
vtkBalloonRepresentationGetBalloonRepresentation ()
 Return the representation as a vtkBalloonRepresentation. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
virtual vtkPropGetCurrentProp ()
 Return the current vtkProp that is being hovered over. 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)
 Add and remove text and/or an image to be associated with a vtkProp. More...
 
void AddBalloon (vtkProp *prop, const char *str)
 Add and remove text and/or an image to be associated with a vtkProp. More...
 
void RemoveBalloon (vtkProp *prop)
 Add and remove text and/or an image to be associated with a vtkProp. More...
 
const char * GetBalloonString (vtkProp *prop)
 Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). More...
 
vtkImageDataGetBalloonImage (vtkProp *prop)
 Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up each balloon). More...
 
void UpdateBalloonString (vtkProp *prop, const char *str)
 Update the balloon string or image. More...
 
void UpdateBalloonImage (vtkProp *prop, vtkImageData *image)
 Update the balloon string or image. More...
 
void SetPicker (vtkAbstractPropPicker *)
 Set/Get the object used to perform pick operations. More...
 
virtual vtkAbstractPropPickerGetPicker ()
 Set/Get the object used to perform pick operations. More...
 
- Public Member Functions inherited from vtkHoverWidget
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...
 
vtkHoverWidgetNewInstance () const
 Standard methods for a VTK class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for a VTK class. More...
 
- Public Member Functions inherited from vtkAbstractWidget
vtkWidgetEventTranslatorGetEventTranslator ()
 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 vtkAbstractWidgetGetParent ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
virtual void SetProcessEvents (int)
 Methods to change whether the widget responds to interaction. More...
 
virtual int 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...
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
virtual void SetManagesCursor (int)
 Turn on or off the management of the cursor. More...
 
virtual int 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...
 
vtkAbstractWidgetNewInstance () const
 Standard macros implementing standard VTK methods. More...
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () 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 vtkRenderWindowInteractorGetInteractor ()
 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)
 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 (int)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual int 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 vtkRendererGetDefaultRenderer ()
 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 vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 Set/Get the current renderer. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 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...
 
- Public Member Functions inherited from vtkObject
 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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...
 
- Public Member Functions inherited from vtkObjectBase
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 Public Member Functions

static vtkBalloonWidgetNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkHoverWidget
static vtkHoverWidgetNew ()
 Instantiate this class. More...
 
static int IsTypeOf (const char *type)
 Standard methods for a VTK class. More...
 
static vtkHoverWidgetSafeDownCast (vtkObjectBase *o)
 Standard methods for a VTK class. More...
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 Standard macros implementing standard VTK methods. More...
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 Standard macros implementing standard VTK methods. More...
 
- Static Public Member Functions inherited from vtkInteractorObserver
static int IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (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 Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

 vtkBalloonWidget ()
 
 ~vtkBalloonWidget () override
 
int SubclassEndHoverAction () override
 
int SubclassHoverAction () override
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
- Protected Member Functions inherited from vtkHoverWidget
 vtkHoverWidget ()
 
 ~vtkHoverWidget () override
 
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
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
virtual void PickersModified ()
 Update the pickers registered in the Picking Manager when pickers are modified. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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. More...
 
int RequestCursorShape (int requestedShape)
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 Utility routines used to start and end interaction. More...
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 Helper method for subclasses. More...
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPropMap * PropMap
 
vtkAbstractPropPickerPicker
 
vtkPropCurrentProp
 
- Protected Attributes inherited from vtkHoverWidget
int WidgetState
 
int TimerId
 Helper methods for creating and destroying timers. More...
 
int TimerDuration
 Helper methods for creating and destroying timers. More...
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
int KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkHoverWidget Superclass
 Standard methods for a VTK class. More...
 
static int IsTypeOf (const char *type)
 Standard methods for a VTK class. More...
 
static vtkBalloonWidgetSafeDownCast (vtkObjectBase *o)
 Standard methods for a VTK class. More...
 
virtual int IsA (const char *type)
 Standard methods for a VTK class. More...
 
vtkBalloonWidgetNewInstance () const
 Standard methods for a VTK class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for a VTK class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for a VTK class. More...
 

Additional Inherited Members

- Public Types inherited from vtkHoverWidget
typedef vtkAbstractWidget Superclass
 Standard methods for a VTK class. More...
 
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 Standard macros implementing standard VTK methods. More...
 
- 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. More...
 

Detailed Description

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.

Member Typedef Documentation

Standard methods for a VTK class.

Definition at line 103 of file vtkBalloonWidget.h.

Constructor & Destructor Documentation

vtkBalloonWidget::vtkBalloonWidget ( )
protected
vtkBalloonWidget::~vtkBalloonWidget ( )
overrideprotected

Member Function Documentation

static vtkBalloonWidget* vtkBalloonWidget::New ( )
static

Instantiate this class.

static int vtkBalloonWidget::IsTypeOf ( const char *  type)
static

Standard methods for a VTK class.

virtual int vtkBalloonWidget::IsA ( const char *  type)
virtual

Standard methods for a VTK class.

Reimplemented from vtkHoverWidget.

static vtkBalloonWidget* vtkBalloonWidget::SafeDownCast ( vtkObjectBase o)
static

Standard methods for a VTK class.

virtual vtkObjectBase* vtkBalloonWidget::NewInstanceInternal ( ) const
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 
)
overridevirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

void vtkBalloonWidget::SetEnabled ( int  )
overridevirtual

The method for activating and deactivating this widget.

This method must be overridden because it performs special timer-related operations.

Reimplemented from vtkAbstractWidget.

void vtkBalloonWidget::SetRepresentation ( vtkBalloonRepresentation r)
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 118 of file vtkBalloonWidget.h.

vtkBalloonRepresentation* vtkBalloonWidget::GetBalloonRepresentation ( )
inline

Return the representation as a vtkBalloonRepresentation.

Definition at line 124 of file vtkBalloonWidget.h.

void vtkBalloonWidget::CreateDefaultRepresentation ( )
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.

void vtkBalloonWidget::AddBalloon ( vtkProp prop,
const char *  str 
)
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 139 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.

virtual vtkProp* vtkBalloonWidget::GetCurrentProp ( )
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 168 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 vtkAbstractPropPicker* vtkBalloonWidget::GetPicker ( )
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.)

int vtkBalloonWidget::SubclassEndHoverAction ( )
overrideprotectedvirtual

Reimplemented from vtkHoverWidget.

int vtkBalloonWidget::SubclassHoverAction ( )
overrideprotectedvirtual

Reimplemented from vtkHoverWidget.

void vtkBalloonWidget::RegisterPickers ( )
overrideprotectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

Member Data Documentation

vtkPropMap* vtkBalloonWidget::PropMap
protected

Definition at line 191 of file vtkBalloonWidget.h.

vtkAbstractPropPicker* vtkBalloonWidget::Picker
protected

Definition at line 194 of file vtkBalloonWidget.h.

vtkProp* vtkBalloonWidget::CurrentProp
protected

Definition at line 200 of file vtkBalloonWidget.h.


The documentation for this class was generated from the following file: