VTK
vtkBorderWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBorderWidget.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 =========================================================================*/
73 #ifndef vtkBorderWidget_h
74 #define vtkBorderWidget_h
75 
76 #include "vtkAbstractWidget.h"
77 #include "vtkInteractionWidgetsModule.h" // For export macro
78 
80 
81 class VTKINTERACTIONWIDGETS_EXPORT vtkBorderWidget : public vtkAbstractWidget
82 {
83 public:
87  static vtkBorderWidget* New();
88 
90 
94  void PrintSelf(ostream& os, vtkIndent indent) override;
96 
98 
104  vtkSetMacro(Selectable, vtkTypeBool);
105  vtkGetMacro(Selectable, vtkTypeBool);
106  vtkBooleanMacro(Selectable, vtkTypeBool);
108 
110 
115  vtkSetMacro(Resizable, vtkTypeBool);
116  vtkGetMacro(Resizable, vtkTypeBool);
117  vtkBooleanMacro(Resizable, vtkTypeBool);
119 
126  {
127  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
128  }
129 
134  {
135  return reinterpret_cast<vtkBorderRepresentation*>(this->WidgetRep);
136  }
137 
141  void CreateDefaultRepresentation() override;
142 
143 protected:
144  vtkBorderWidget();
145  ~vtkBorderWidget() override;
146 
152  virtual void SelectRegion(double eventPos[2]);
153 
154  // enable the selection of the region interior to the widget
157 
158  // processes the registered events
159  static void SelectAction(vtkAbstractWidget*);
160  static void TranslateAction(vtkAbstractWidget*);
161  static void EndSelectAction(vtkAbstractWidget*);
162  static void MoveAction(vtkAbstractWidget*);
163 
164  // Special internal methods to support subclasses handling events.
165  // If a non-zero value is returned, the subclass is handling the event.
166  virtual int SubclassSelectAction() { return 0; }
167  virtual int SubclassTranslateAction() { return 0; }
168  virtual int SubclassEndSelectAction() { return 0; }
169  virtual int SubclassMoveAction() { return 0; }
170 
171  // helper methods for cursoe management
172  void SetCursor(int State) override;
173 
174  // widget state
177  {
178  Start = 0,
181  Selected
182  };
183 
184 private:
185  vtkBorderWidget(const vtkBorderWidget&) = delete;
186  void operator=(const vtkBorderWidget&) = delete;
187 };
188 
189 #endif
vtkAbstractWidget::SetCursor
virtual void SetCursor(int vtkNotUsed(state))
Definition: vtkAbstractWidget.h:176
vtkBorderWidget::Define
Definition: vtkBorderWidget.h:179
vtkBorderWidget::SubclassEndSelectAction
virtual int SubclassEndSelectAction()
Definition: vtkBorderWidget.h:168
vtkBorderWidget::Manipulate
Definition: vtkBorderWidget.h:180
vtkBorderRepresentation
represent a vtkBorderWidget
Definition: vtkBorderRepresentation.h:54
vtkBorderWidget
place a border around a 2D rectangular region
Definition: vtkBorderWidget.h:81
vtkBorderWidget::GetBorderRepresentation
vtkBorderRepresentation * GetBorderRepresentation()
Return the representation as a vtkBorderRepresentation.
Definition: vtkBorderWidget.h:133
vtkAbstractWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractWidget.h
vtkBorderWidget::Selectable
vtkTypeBool Selectable
Definition: vtkBorderWidget.h:155
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkBorderWidget::SubclassMoveAction
virtual int SubclassMoveAction()
Definition: vtkBorderWidget.h:169
vtkBorderWidget::Resizable
vtkTypeBool Resizable
Definition: vtkBorderWidget.h:156
vtkBorderWidget::WidgetState
int WidgetState
Definition: vtkBorderWidget.h:175
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:62
vtkBorderWidget::SubclassSelectAction
virtual int SubclassSelectAction()
Definition: vtkBorderWidget.h:166
vtkAbstractWidget::CreateDefaultRepresentation
virtual void CreateDefaultRepresentation()=0
Create the default widget representation if one is not set.
vtkBorderWidget::_WidgetState
_WidgetState
Definition: vtkBorderWidget.h:176
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkBorderWidget::SubclassTranslateAction
virtual int SubclassTranslateAction()
Definition: vtkBorderWidget.h:167
vtkBorderWidget::SetRepresentation
void SetRepresentation(vtkBorderRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkBorderWidget.h:125
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69