VTK  9.1.0
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=========================================================================*/
90#ifndef vtkBalloonWidget_h
91#define vtkBalloonWidget_h
92
93#include "vtkHoverWidget.h"
94#include "vtkInteractionWidgetsModule.h" // For export macro
95
97class vtkProp;
99class vtkStdString;
100class vtkPropMap;
101class vtkImageData;
102
103class VTKINTERACTIONWIDGETS_EXPORT vtkBalloonWidget : public vtkHoverWidget
104{
105public:
110
112
116 void PrintSelf(ostream& os, vtkIndent indent) override;
118
123 void SetEnabled(int) override;
124
131 {
133 }
134
139 {
140 return reinterpret_cast<vtkBalloonRepresentation*>(this->WidgetRep);
141 }
142
147
149
154 void AddBalloon(vtkProp* prop, const char* str, vtkImageData* img);
155 void AddBalloon(vtkProp* prop, const char* str) // for wrapping
156 {
157 this->AddBalloon(prop, str, nullptr);
158 }
161
163
169 const char* GetBalloonString(vtkProp* prop);
172
174
178 void UpdateBalloonString(vtkProp* prop, const char* str);
181
186 virtual vtkProp* GetCurrentProp() { return this->CurrentProp; }
187
189
196 vtkGetObjectMacro(Picker, vtkAbstractPropPicker);
198
199 /*
200 * Register internal Pickers within PickingManager
201 */
202 void RegisterPickers() override;
203
204protected:
207
208 // This class implements the method called from its superclass.
210 int SubclassHoverAction() override;
211
212 // Classes for managing balloons
213 vtkPropMap* PropMap; // PIMPL'd map of (vtkProp,vtkStdString)
214
215 // Support for picking
217
218 // The vtkProp that is being hovered over (which may be nullptr)
220
221private:
222 vtkBalloonWidget(const vtkBalloonWidget&) = delete;
223 void operator=(const vtkBalloonWidget&) = delete;
224};
225
226#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.
const char * GetBalloonString(vtkProp *prop)
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up...
~vtkBalloonWidget() override
void RemoveBalloon(vtkProp *prop)
Add and remove text and/or an image to be associated with a vtkProp.
vtkPropMap * PropMap
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.
virtual vtkProp * GetCurrentProp()
Return the current vtkProp that is being hovered over.
vtkBalloonRepresentation * GetBalloonRepresentation()
Return the representation as a vtkBalloonRepresentation.
void UpdateBalloonString(vtkProp *prop, const char *str)
Update the balloon string or image.
int SubclassHoverAction() override
void SetRepresentation(vtkBalloonRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
vtkImageData * GetBalloonImage(vtkProp *prop)
Methods to retrieve the information associated with each vtkProp (i.e., the information that makes up...
int SubclassEndHoverAction() override
static vtkBalloonWidget * New()
Instantiate this class.
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.
invoke a vtkTimerEvent when hovering
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:76
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
abstract class defines interface between the widget and widget representation classes