VTK
Public Types | 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 Types

typedef vtkHoverWidget Superclass
 Standard methods for a VTK class. More...
 
- 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
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkBalloonWidgetNewInstance () 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...
 
vtkBalloonRepresentationGetBalloonRepresentation ()
 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...
 
vtkImageDataGetBalloonImage (vtkProp *prop)
 
void UpdateBalloonString (vtkProp *prop, const char *str)
 Update the balloon string or image. More...
 
void UpdateBalloonImage (vtkProp *prop, vtkImageData *image)
 
virtual vtkPropGetCurrentProp ()
 Return the current vtkProp that is being hovered over. More...
 
void SetPicker (vtkAbstractPropPicker *)
 Set/Get the object used to perform pick operations. More...
 
virtual vtkAbstractPropPickerGetPicker ()
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
- Public Member Functions inherited from vtkHoverWidget
vtkHoverWidgetNewInstance () 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...
 
- Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidgetNewInstance () const
 
virtual void SetProcessEvents (vtkTypeBool)
 Methods to change whether the widget responds to interaction. More...
 
virtual vtkTypeBool GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
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 ()
 
vtkWidgetRepresentationGetRepresentation ()
 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...
 
- 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 SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
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 vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 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 ()
 
- 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...
 
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)
 
vtkCommandGetCommand (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)
 
- 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 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 Public Member Functions

static vtkBalloonWidgetNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBalloonWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHoverWidget
static vtkHoverWidgetNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHoverWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool 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])
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBalloonWidget ()
 
 ~vtkBalloonWidget () override
 
int SubclassEndHoverAction () override
 
int SubclassHoverAction () override
 
- 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
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 
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])
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. 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)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- 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
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- 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

◆ Superclass

Standard methods for a VTK class.

Definition at line 103 of file vtkBalloonWidget.h.

Constructor & Destructor Documentation

◆ vtkBalloonWidget()

vtkBalloonWidget::vtkBalloonWidget ( )
protected

◆ ~vtkBalloonWidget()

vtkBalloonWidget::~vtkBalloonWidget ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBalloonWidget* vtkBalloonWidget::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkBalloonWidget::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkHoverWidget.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBalloonWidget::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHoverWidget.

◆ NewInstance()

vtkBalloonWidget* vtkBalloonWidget::NewInstance ( ) const

◆ PrintSelf()

void vtkBalloonWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractWidget.

◆ SetEnabled()

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.

◆ SetRepresentation()

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.

◆ GetBalloonRepresentation()

vtkBalloonRepresentation* vtkBalloonWidget::GetBalloonRepresentation ( )
inline

Return the representation as a vtkBalloonRepresentation.

Definition at line 124 of file vtkBalloonWidget.h.

◆ CreateDefaultRepresentation()

void vtkBalloonWidget::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ AddBalloon() [1/3]

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.

◆ AddBalloon() [2/3]

void vtkBalloonWidget::AddBalloon ( vtkProp prop,
const char *  str,
vtkImageData img 
)

◆ AddBalloon() [3/3]

void vtkBalloonWidget::AddBalloon ( vtkProp prop,
const char *  str 
)
inline

Definition at line 139 of file vtkBalloonWidget.h.

◆ RemoveBalloon()

void vtkBalloonWidget::RemoveBalloon ( vtkProp prop)

◆ GetBalloonString()

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 nullptr will be returned if the vtkProp does not exist, or if a string or image have not been associated with the specified vtkProp.

◆ GetBalloonImage()

vtkImageData* vtkBalloonWidget::GetBalloonImage ( vtkProp prop)

◆ UpdateBalloonString()

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.

◆ UpdateBalloonImage()

void vtkBalloonWidget::UpdateBalloonImage ( vtkProp prop,
vtkImageData image 
)

◆ GetCurrentProp()

virtual vtkProp* vtkBalloonWidget::GetCurrentProp ( )
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 168 of file vtkBalloonWidget.h.

◆ SetPicker()

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.)

◆ GetPicker()

virtual vtkAbstractPropPicker* vtkBalloonWidget::GetPicker ( )
virtual

◆ RegisterPickers()

void vtkBalloonWidget::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

◆ SubclassEndHoverAction()

int vtkBalloonWidget::SubclassEndHoverAction ( )
overrideprotectedvirtual

Reimplemented from vtkHoverWidget.

◆ SubclassHoverAction()

int vtkBalloonWidget::SubclassHoverAction ( )
overrideprotectedvirtual

Reimplemented from vtkHoverWidget.

Member Data Documentation

◆ PropMap

vtkPropMap* vtkBalloonWidget::PropMap
protected

Definition at line 196 of file vtkBalloonWidget.h.

◆ Picker

vtkAbstractPropPicker* vtkBalloonWidget::Picker
protected

Definition at line 199 of file vtkBalloonWidget.h.

◆ CurrentProp

vtkProp* vtkBalloonWidget::CurrentProp
protected

Definition at line 202 of file vtkBalloonWidget.h.


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