VTK  9.3.20240726
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
51#ifndef vtkCaptionWidget_h
52#define vtkCaptionWidget_h
53
54#include "vtkBorderWidget.h"
55#include "vtkInteractionWidgetsModule.h" // For export macro
56#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
57
58VTK_ABI_NAMESPACE_BEGIN
61class vtkHandleWidget;
63class vtkCaptionAnchorCallback;
64
65class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkCaptionWidget : public vtkBorderWidget
66{
67public:
72
74
78 void PrintSelf(ostream& os, vtkIndent indent) override;
80
85 void SetEnabled(int enabling) override;
86
93 {
95 }
96
98
106
111
112protected:
115
116 // Handles callbacks from the anchor point
117 vtkCaptionAnchorCallback* AnchorCallback;
118
119 // Widget for the anchor point
121
122 // Special callbacks for the anchor interaction
126
127 friend class vtkCaptionAnchorCallback;
128
129private:
130 vtkCaptionWidget(const vtkCaptionWidget&) = delete;
131 void operator=(const vtkCaptionWidget&) = delete;
132};
133
134VTK_ABI_NAMESPACE_END
135#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()
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.
static vtkCaptionWidget * New()
Instantiate this class.
void EndAnchorInteraction()
vtkCaptionAnchorCallback * AnchorCallback
~vtkCaptionWidget() override
a general widget for moving handles
a simple class to control print indentation
Definition vtkIndent.h:108
represent the position of a point in 3D space
abstract class defines interface between the widget and widget representation classes
#define VTK_MARSHALAUTO