forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkTextWidget.h
94 lines (78 loc) · 2.8 KB
/
vtkTextWidget.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*=========================================================================
Program: Visualization Toolkit
Module: vtkTextWidget.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkTextWidget
* @brief widget for placing text on overlay plane
*
* This class provides support for interactively placing text on the 2D
* overlay plane. The text is defined by an instance of vtkTextActor. It uses
* the event bindings of its superclass (vtkBorderWidget). In addition, when
* the text is selected, the widget emits a WidgetActivateEvent that
* observers can watch for. This is useful for opening GUI dialogues to
* adjust font characteristics, etc. (Please see the superclass for a
* description of event bindings.)
*
* @sa
* vtkBorderWidget vtkCaptionWidget
*/
#ifndef vtkTextWidget_h
#define vtkTextWidget_h
class vtkTextRepresentation;
class vtkTextActor;
#include "vtkBorderWidget.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
class VTKINTERACTIONWIDGETS_EXPORT vtkTextWidget : public vtkBorderWidget
{
public:
/**
* Instantiate class.
*/
static vtkTextWidget* New();
///@{
/**
* Standard VTK methods.
*/
vtkTypeMacro(vtkTextWidget, vtkBorderWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@}
/**
* 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.
*/
void SetRepresentation(vtkTextRepresentation* r);
///@{
/**
* Specify a vtkTextActor to manage. This is a convenient, alternative
* method to specify the representation for the widget (i.e., used instead
* of SetRepresentation()). It internally creates a vtkTextRepresentation
* and then invokes vtkTextRepresentation::SetTextActor().
*/
void SetTextActor(vtkTextActor* textActor);
vtkTextActor* GetTextActor();
///@}
/**
* Create the default widget representation if one is not set.
*/
void CreateDefaultRepresentation() override;
/**
* This allows us to set interactivity in the widget
* since this method can block vtkAbstractWidget::ProcessEventsHandler
*/
vtkTypeBool GetProcessEvents() override;
protected:
vtkTextWidget();
~vtkTextWidget() override;
private:
vtkTextWidget(const vtkTextWidget&) = delete;
void operator=(const vtkTextWidget&) = delete;
};
#endif