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 =========================================================================*/
77 #ifndef vtkBalloonWidget_h
78 #define vtkBalloonWidget_h
79 
80 #include "vtkInteractionWidgetsModule.h" // For export macro
81 #include "vtkHoverWidget.h"
82 
84 class vtkProp;
86 class vtkStdString;
87 class vtkPropMap;
88 class vtkImageData;
89 
90 
91 class VTKINTERACTIONWIDGETS_EXPORT vtkBalloonWidget : public vtkHoverWidget
92 {
93 public:
97  static vtkBalloonWidget *New();
98 
100 
104  void PrintSelf(ostream& os, vtkIndent indent) override;
106 
111  void SetEnabled(int) override;
112 
119  {this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}
120 
125  {return reinterpret_cast<vtkBalloonRepresentation*>(this->WidgetRep);}
126 
131 
133 
137  void AddBalloon(vtkProp *prop, vtkStdString *str, vtkImageData *img);
138  void AddBalloon(vtkProp *prop, const char *str, vtkImageData *img);
139  void AddBalloon(vtkProp *prop, const char *str) //for wrapping
140  {this->AddBalloon(prop,str,nullptr);}
141  void RemoveBalloon(vtkProp *prop);
143 
145 
151  const char *GetBalloonString(vtkProp *prop);
154 
156 
160  void UpdateBalloonString(vtkProp *prop, const char *str);
163 
169  {return this->CurrentProp;}
170 
172 
179  vtkGetObjectMacro(Picker,vtkAbstractPropPicker);
181 
182  /*
183  * Register internal Pickers within PickingManager
184  */
185  void RegisterPickers() override;
186 
187 protected:
189  ~vtkBalloonWidget() override;
190 
191  // This class implements the method called from its superclass.
192  int SubclassEndHoverAction() override;
193  int SubclassHoverAction() override;
194 
195  // Classes for managing balloons
196  vtkPropMap *PropMap; //PIMPL'd map of (vtkProp,vtkStdString)
197 
198  // Support for picking
200 
201  // The vtkProp that is being hovered over (which may be nullptr)
203 
204 private:
205  vtkBalloonWidget(const vtkBalloonWidget&) = delete;
206  void operator=(const vtkBalloonWidget&) = delete;
207 };
208 
209 #endif
vtkBalloonWidget::vtkBalloonWidget
vtkBalloonWidget()
vtkBalloonWidget::SetPicker
void SetPicker(vtkAbstractPropPicker *)
Set/Get the object used to perform pick operations.
vtkBalloonWidget
popup text balloons above instance of vtkProp when hovering occurs
Definition: vtkBalloonWidget.h:92
vtkBalloonWidget::New
static vtkBalloonWidget * New()
Instantiate this class.
vtkBalloonWidget::SetEnabled
void SetEnabled(int) override
The method for activating and deactivating this widget.
vtkBalloonWidget::UpdateBalloonImage
void UpdateBalloonImage(vtkProp *prop, vtkImageData *image)
vtkBalloonWidget::Picker
vtkAbstractPropPicker * Picker
Definition: vtkBalloonWidget.h:199
vtkBalloonWidget::RemoveBalloon
void RemoveBalloon(vtkProp *prop)
vtkX3D::image
@ image
Definition: vtkX3D.h:374
vtkHoverWidget
invoke a vtkTimerEvent when hovering
Definition: vtkHoverWidget.h:81
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:61
vtkAbstractWidget::WidgetRep
vtkWidgetRepresentation * WidgetRep
Definition: vtkAbstractWidget.h:174
vtkBalloonWidget::GetCurrentProp
virtual vtkProp * GetCurrentProp()
Return the current vtkProp that is being hovered over.
Definition: vtkBalloonWidget.h:168
vtkBalloonWidget::AddBalloon
void AddBalloon(vtkProp *prop, const char *str)
Definition: vtkBalloonWidget.h:139
vtkBalloonWidget::PropMap
vtkPropMap * PropMap
Definition: vtkBalloonWidget.h:196
vtkBalloonWidget::SubclassHoverAction
int SubclassHoverAction() override
vtkBalloonWidget::SetRepresentation
void SetRepresentation(vtkBalloonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkBalloonWidget.h:118
vtkBalloonWidget::RegisterPickers
void RegisterPickers() override
Register internal Pickers in the Picking Manager.
vtkBalloonWidget::GetBalloonString
const char * GetBalloonString(vtkProp *prop)
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up...
vtkBalloonWidget::GetBalloonImage
vtkImageData * GetBalloonImage(vtkProp *prop)
vtkBalloonWidget::AddBalloon
void AddBalloon(vtkProp *prop, vtkStdString *str, vtkImageData *img)
Add and remove text and/or an image to be associated with a vtkProp.
vtkBalloonWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkBalloonWidget::~vtkBalloonWidget
~vtkBalloonWidget() override
vtkAbstractPropPicker
abstract API for pickers that can pick an instance of vtkProp
Definition: vtkAbstractPropPicker.h:80
vtkBalloonRepresentation
represent the vtkBalloonWidget
Definition: vtkBalloonRepresentation.h:83
vtkBalloonWidget::CurrentProp
vtkProp * CurrentProp
Definition: vtkBalloonWidget.h:202
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkBalloonWidget::UpdateBalloonString
void UpdateBalloonString(vtkProp *prop, const char *str)
Update the balloon string or image.
vtkHoverWidget.h
vtkBalloonWidget::AddBalloon
void AddBalloon(vtkProp *prop, const char *str, vtkImageData *img)
vtkBalloonWidget::GetBalloonRepresentation
vtkBalloonRepresentation * GetBalloonRepresentation()
Return the representation as a vtkBalloonRepresentation.
Definition: vtkBalloonWidget.h:124
vtkBalloonWidget::SubclassEndHoverAction
int SubclassEndHoverAction() override
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
vtkBalloonWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.