VTK  9.2.5
vtkBalloonWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBalloonWidget.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
93 #ifndef vtkBalloonWidget_h
94 #define vtkBalloonWidget_h
95 
96 #include "vtkHoverWidget.h"
97 #include "vtkInteractionWidgetsModule.h" // For export macro
98 
100 class vtkProp;
102 class vtkStdString;
103 class vtkPropMap;
104 class vtkImageData;
105 
106 class VTKINTERACTIONWIDGETS_EXPORT vtkBalloonWidget : public vtkHoverWidget
107 {
108 public:
113 
115 
119  void PrintSelf(ostream& os, vtkIndent indent) override;
121 
126  void SetEnabled(int) override;
127 
134  {
136  }
137 
142  {
143  return reinterpret_cast<vtkBalloonRepresentation*>(this->WidgetRep);
144  }
145 
150 
152 
156  void AddBalloon(vtkProp* prop, vtkStdString* str, vtkImageData* img);
157  void AddBalloon(vtkProp* prop, const char* str, vtkImageData* img);
158  void AddBalloon(vtkProp* prop, const char* str) // for wrapping
159  {
160  this->AddBalloon(prop, str, nullptr);
161  }
162  void RemoveBalloon(vtkProp* prop);
164 
166 
172  const char* GetBalloonString(vtkProp* prop);
175 
177 
181  void UpdateBalloonString(vtkProp* prop, const char* str);
184 
189  virtual vtkProp* GetCurrentProp() { return this->CurrentProp; }
190 
192 
199  vtkGetObjectMacro(Picker, vtkAbstractPropPicker);
201 
202  /*
203  * Register internal Pickers within PickingManager
204  */
205  void RegisterPickers() override;
206 
207 protected:
209  ~vtkBalloonWidget() override;
210 
211  // This class implements the method called from its superclass.
212  int SubclassEndHoverAction() override;
213  int SubclassHoverAction() override;
214 
215  // Classes for managing balloons
216  vtkPropMap* PropMap; // PIMPL'd map of (vtkProp,vtkStdString)
217 
218  // Support for picking
220 
221  // The vtkProp that is being hovered over (which may be nullptr)
223 
224 private:
225  vtkBalloonWidget(const vtkBalloonWidget&) = delete;
226  void operator=(const vtkBalloonWidget&) = delete;
227 };
228 
229 #endif
abstract API for pickers that can pick an instance of vtkProp
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
vtkWidgetRepresentation * WidgetRep
represent the vtkBalloonWidget
popup text balloons above instance of vtkProp when hovering occurs
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
void SetEnabled(int) override
The method for activating and deactivating this widget.
~vtkBalloonWidget() override
const char * GetBalloonString(vtkProp *prop)
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up...
vtkBalloonRepresentation * GetBalloonRepresentation()
Return the representation as a vtkBalloonRepresentation.
void RemoveBalloon(vtkProp *prop)
Add and remove text and/or an image to be associated with a vtkProp.
vtkPropMap * PropMap
virtual vtkProp * GetCurrentProp()
Return the current vtkProp that is being hovered over.
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
void SetPicker(vtkAbstractPropPicker *)
Set/Get the object used to perform pick operations.
void UpdateBalloonImage(vtkProp *prop, vtkImageData *image)
Update the balloon string or image.
void AddBalloon(vtkProp *prop, const char *str)
Add and remove text and/or an image to be associated with a vtkProp.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for a VTK class.
void UpdateBalloonString(vtkProp *prop, const char *str)
Update the balloon string or image.
static vtkBalloonWidget * New()
Instantiate this class.
int SubclassHoverAction() override
void SetRepresentation(vtkBalloonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
int SubclassEndHoverAction() override
void AddBalloon(vtkProp *prop, vtkStdString *str, vtkImageData *img)
Add and remove text and/or an image to be associated with a vtkProp.
vtkAbstractPropPicker * Picker
void AddBalloon(vtkProp *prop, const char *str, vtkImageData *img)
Add and remove text and/or an image to be associated with a vtkProp.
vtkImageData * GetBalloonImage(vtkProp *prop)
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up...
invoke a vtkTimerEvent when hovering
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:76
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:108
abstract class defines interface between the widget and widget representation classes
@ image
Definition: vtkX3D.h:380