VTK
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 =========================================================================*/
71 #ifndef vtkBalloonWidget_h
72 #define vtkBalloonWidget_h
73 
74 #include "vtkInteractionWidgetsModule.h" // For export macro
75 #include "vtkHoverWidget.h"
76 
78 class vtkProp;
80 class vtkStdString;
81 class vtkPropMap;
82 class vtkImageData;
83 
84 
85 class VTKINTERACTIONWIDGETS_EXPORT vtkBalloonWidget : public vtkHoverWidget
86 {
87 public:
91  static vtkBalloonWidget *New();
92 
94 
98  void PrintSelf(ostream& os, vtkIndent indent) override;
100 
105  void SetEnabled(int) override;
106 
113  {this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}
114 
119  {return reinterpret_cast<vtkBalloonRepresentation*>(this->WidgetRep);}
120 
124  void CreateDefaultRepresentation() override;
125 
127 
131  void AddBalloon(vtkProp *prop, vtkStdString *str, vtkImageData *img);
132  void AddBalloon(vtkProp *prop, const char *str, vtkImageData *img);
133  void AddBalloon(vtkProp *prop, const char *str) //for wrapping
134  {this->AddBalloon(prop,str,nullptr);}
135  void RemoveBalloon(vtkProp *prop);
137 
139 
145  const char *GetBalloonString(vtkProp *prop);
146  vtkImageData *GetBalloonImage(vtkProp *prop);
148 
150 
154  void UpdateBalloonString(vtkProp *prop, const char *str);
155  void UpdateBalloonImage(vtkProp *prop, vtkImageData *image);
157 
163  {return this->CurrentProp;}
164 
166 
172  void SetPicker(vtkAbstractPropPicker*);
173  vtkGetObjectMacro(Picker,vtkAbstractPropPicker);
175 
176  /*
177  * Register internal Pickers within PickingManager
178  */
179  void RegisterPickers() override;
180 
181 protected:
183  ~vtkBalloonWidget() override;
184 
185  // This class implements the method called from its superclass.
186  int SubclassEndHoverAction() override;
187  int SubclassHoverAction() override;
188 
189  // Classes for managing balloons
190  vtkPropMap *PropMap; //PIMPL'd map of (vtkProp,vtkStdString)
191 
192  // Support for picking
194 
195  // The vtkProp that is being hovered over (which may be nullptr)
197 
198 private:
199  vtkBalloonWidget(const vtkBalloonWidget&) = delete;
200  void operator=(const vtkBalloonWidget&) = delete;
201 };
202 
203 #endif
vtkHoverWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkBalloonWidget
popup text balloons above instance of vtkProp when hovering occurs
Definition: vtkBalloonWidget.h:85
vtkBalloonWidget::Picker
vtkAbstractPropPicker * Picker
Definition: vtkBalloonWidget.h:193
vtkX3D::image
Definition: vtkX3D.h:374
vtkHoverWidget
invoke a vtkTimerEvent when hovering
Definition: vtkHoverWidget.h:77
vtkBalloonWidget::GetCurrentProp
virtual vtkProp * GetCurrentProp()
Return the current vtkProp that is being hovered over.
Definition: vtkBalloonWidget.h:162
vtkBalloonWidget::AddBalloon
void AddBalloon(vtkProp *prop, const char *str)
Definition: vtkBalloonWidget.h:133
vtkBalloonWidget::PropMap
vtkPropMap * PropMap
Definition: vtkBalloonWidget.h:190
vtkBalloonWidget::SetRepresentation
void SetRepresentation(vtkBalloonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkBalloonWidget.h:112
vtkHoverWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkAbstractPropPicker
abstract API for pickers that can pick an instance of vtkProp
Definition: vtkAbstractPropPicker.h:79
vtkBalloonRepresentation
represent the vtkBalloonWidget
Definition: vtkBalloonRepresentation.h:76
vtkInteractorObserver::RegisterPickers
virtual void RegisterPickers()
Register internal Pickers in the Picking Manager.
vtkBalloonWidget::CurrentProp
vtkProp * CurrentProp
Definition: vtkBalloonWidget.h:196
vtkHoverWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
A default representation, of which there is none, is created.
Definition: vtkHoverWidget.h:114
vtkHoverWidget::SubclassHoverAction
virtual int SubclassHoverAction()
Definition: vtkHoverWidget.h:134
vtkHoverWidget::New
static vtkHoverWidget * New()
Instantiate this class.
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:46
vtkHoverWidget.h
vtkBalloonWidget::GetBalloonRepresentation
vtkBalloonRepresentation * GetBalloonRepresentation()
Return the representation as a vtkBalloonRepresentation.
Definition: vtkBalloonWidget.h:118
vtkHoverWidget::SubclassEndHoverAction
virtual int SubclassEndHoverAction()
Definition: vtkHoverWidget.h:135
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)