VTK
vtkCaptionWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCaptionWidget.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 =========================================================================*/
41 #ifndef vtkCaptionWidget_h
42 #define vtkCaptionWidget_h
43 
44 #include "vtkInteractionWidgetsModule.h" // For export macro
45 #include "vtkBorderWidget.h"
46 
48 class vtkCaptionActor2D;
49 class vtkHandleWidget;
51 class vtkCaptionAnchorCallback;
52 
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  {this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}
83 
85 
90  void SetCaptionActor2D(vtkCaptionActor2D *capActor);
91  vtkCaptionActor2D *GetCaptionActor2D();
93 
97  void CreateDefaultRepresentation() override;
98 
99 protected:
101  ~vtkCaptionWidget() override;
102 
103  // Handles callbacks from the anchor point
104  vtkCaptionAnchorCallback *AnchorCallback;
105 
106  // Widget for the anchor point
108 
109  // Special callbacks for the anchor interaction
110  void StartAnchorInteraction();
111  void AnchorInteraction();
112  void EndAnchorInteraction();
113 
114  friend class vtkCaptionAnchorCallback;
115 
116 private:
117  vtkCaptionWidget(const vtkCaptionWidget&) = delete;
118  void operator=(const vtkCaptionWidget&) = delete;
119 };
120 
121 #endif
vtkCaptionWidget::AnchorCallback
vtkCaptionAnchorCallback * AnchorCallback
Definition: vtkCaptionWidget.h:104
vtkHandleWidget
a general widget for moving handles
Definition: vtkHandleWidget.h:76
vtkBorderWidget
place a border around a 2D rectangular region
Definition: vtkBorderWidget.h:85
vtkBorderWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkPointHandleRepresentation3D
represent the position of a point in 3D space
Definition: vtkPointHandleRepresentation3D.h:43
vtkCaptionRepresentation
represents vtkCaptionWidget in the scene
Definition: vtkCaptionRepresentation.h:51
vtkCaptionWidget
widget for placing a caption (text plus leader)
Definition: vtkCaptionWidget.h:54
vtkBorderWidget.h
vtkBorderWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkBorderWidget::New
static vtkBorderWidget * New()
Method to instantiate class.
vtkCaptionWidget::SetRepresentation
void SetRepresentation(vtkCaptionRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkCaptionWidget.h:81
vtkCaptionWidget::HandleWidget
vtkHandleWidget * HandleWidget
Definition: vtkCaptionWidget.h:107
vtkAbstractWidget::SetEnabled
void SetEnabled(int) override
Methods for activating this widget.
vtkCaptionActor2D
draw text label associated with a point
Definition: vtkCaptionActor2D.h:77
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)