VTK  9.3.0
vtkCaptionWidget.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
41 #ifndef vtkCaptionWidget_h
42 #define vtkCaptionWidget_h
43 
44 #include "vtkBorderWidget.h"
45 #include "vtkInteractionWidgetsModule.h" // For export macro
46 
47 VTK_ABI_NAMESPACE_BEGIN
49 class vtkCaptionActor2D;
50 class vtkHandleWidget;
52 class vtkCaptionAnchorCallback;
53 
54 class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionWidget : public vtkBorderWidget
55 {
56 public:
60  static vtkCaptionWidget* New();
61 
63 
67  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
74  void SetEnabled(int enabling) override;
75 
82  {
84  }
85 
87 
95 
99  void CreateDefaultRepresentation() override;
100 
101 protected:
103  ~vtkCaptionWidget() override;
104 
105  // Handles callbacks from the anchor point
106  vtkCaptionAnchorCallback* AnchorCallback;
107 
108  // Widget for the anchor point
110 
111  // Special callbacks for the anchor interaction
115 
116  friend class vtkCaptionAnchorCallback;
117 
118 private:
119  vtkCaptionWidget(const vtkCaptionWidget&) = delete;
120  void operator=(const vtkCaptionWidget&) = delete;
121 };
122 
123 VTK_ABI_NAMESPACE_END
124 #endif
void SetWidgetRepresentation(vtkWidgetRepresentation *r)
place a border around a 2D rectangular region
draw text label associated with a point
represents vtkCaptionWidget in the scene
widget for placing a caption (text plus leader)
void AnchorInteraction()
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK class methods.
void StartAnchorInteraction()
static vtkCaptionWidget * New()
Instantiate this class.
void SetEnabled(int enabling) override
Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget.
vtkHandleWidget * HandleWidget
vtkCaptionActor2D * GetCaptionActor2D()
Specify a vtkCaptionActor2D to manage.
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
void SetRepresentation(vtkCaptionRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
void SetCaptionActor2D(vtkCaptionActor2D *capActor)
Specify a vtkCaptionActor2D to manage.
void EndAnchorInteraction()
vtkCaptionAnchorCallback * AnchorCallback
~vtkCaptionWidget() override
a general widget for moving handles
a simple class to control print indentation
Definition: vtkIndent.h:38
represent the position of a point in 3D space
abstract class defines interface between the widget and widget representation classes