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);
69 
74  virtual void SetEnabled(int enabling);
75 
82  {this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}
83 
85 
93 
98 
99 protected:
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
113 
114  friend class vtkCaptionAnchorCallback;
115 
116 private:
117  vtkCaptionWidget(const vtkCaptionWidget&) VTK_DELETE_FUNCTION;
118  void operator=(const vtkCaptionWidget&) VTK_DELETE_FUNCTION;
119 };
120 
121 #endif
vtkCaptionWidget::AnchorCallback
vtkCaptionAnchorCallback * AnchorCallback
Definition: vtkCaptionWidget.h:104
vtkCaptionWidget::EndAnchorInteraction
void EndAnchorInteraction()
vtkCaptionWidget::~vtkCaptionWidget
~vtkCaptionWidget()
vtkCaptionWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkHandleWidget
a general widget for moving handles
Definition: vtkHandleWidget.h:77
vtkBorderWidget
place a border around a 2D rectangular region
Definition: vtkBorderWidget.h:86
vtkPointHandleRepresentation3D
represent the position of a point in 3D space
Definition: vtkPointHandleRepresentation3D.h:44
vtkCaptionRepresentation
represents vtkCaptionWidget in the scene
Definition: vtkCaptionRepresentation.h:52
vtkCaptionWidget
widget for placing a caption (text plus leader)
Definition: vtkCaptionWidget.h:55
vtkWidgetRepresentation
abstract class defines interface between the widget and widget representation classes
Definition: vtkWidgetRepresentation.h:55
vtkCaptionWidget::GetCaptionActor2D
vtkCaptionActor2D * GetCaptionActor2D()
vtkBorderWidget.h
vtkCaptionWidget::New
static vtkCaptionWidget * New()
Instantiate this class.
vtkCaptionWidget::AnchorInteraction
void AnchorInteraction()
vtkCaptionWidget::SetCaptionActor2D
void SetCaptionActor2D(vtkCaptionActor2D *capActor)
Specify a vtkCaptionActor2D to manage.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
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
vtkCaptionActor2D
draw text label associated with a point
Definition: vtkCaptionActor2D.h:78
vtkCaptionWidget::vtkCaptionWidget
vtkCaptionWidget()
vtkCaptionWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation()
Create the default widget representation if one is not set.
vtkCaptionWidget::StartAnchorInteraction
void StartAnchorInteraction()
vtkCaptionWidget::SetEnabled
virtual void SetEnabled(int enabling)
Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget.
vtkAbstractWidget::SetWidgetRepresentation
void SetWidgetRepresentation(vtkWidgetRepresentation *r)