VTK  9.1.0
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 =========================================================================*/
79 #ifndef vtkBorderWidget_h
80 #define vtkBorderWidget_h
81 
82 #include "vtkAbstractWidget.h"
83 #include "vtkInteractionWidgetsModule.h" // For export macro
84 
86 
87 class VTKINTERACTIONWIDGETS_EXPORT vtkBorderWidget : public vtkAbstractWidget
88 {
89 public:
93  static vtkBorderWidget* New();
94 
96 
100  void PrintSelf(ostream& os, vtkIndent indent) override;
102 
104 
110  vtkSetMacro(Selectable, vtkTypeBool);
111  vtkGetMacro(Selectable, vtkTypeBool);
112  vtkBooleanMacro(Selectable, vtkTypeBool);
114 
116 
121  vtkSetMacro(Resizable, vtkTypeBool);
122  vtkGetMacro(Resizable, vtkTypeBool);
123  vtkBooleanMacro(Resizable, vtkTypeBool);
125 
132  {
133  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
134  }
135 
140  {
141  return reinterpret_cast<vtkBorderRepresentation*>(this->WidgetRep);
142  }
143 
148 
149 protected:
151  ~vtkBorderWidget() override;
152 
158  virtual void SelectRegion(double eventPos[2]);
159 
160  // enable the selection of the region interior to the widget
163 
164  // processes the registered events
170 
171  // Special internal methods to support subclasses handling events.
172  // If a non-zero value is returned, the subclass is handling the event.
173  virtual int SubclassSelectAction() { return 0; }
174  virtual int SubclassTranslateAction() { return 0; }
175  virtual int SubclassEndSelectAction() { return 0; }
176  virtual int SubclassMoveAction() { return 0; }
177 
178  // helper methods for cursoe management
179  void SetCursor(int State) override;
180 
181  // widget state
184  {
185  Start = 0,
188  Selected
189  };
190 
191 private:
192  vtkBorderWidget(const vtkBorderWidget&) = delete;
193  void operator=(const vtkBorderWidget&) = delete;
194 };
195 
196 #endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
represent a vtkBorderWidget
place a border around a 2D rectangular region
vtkTypeBool Resizable
static void SelectAction(vtkAbstractWidget *)
static void TranslateAction(vtkAbstractWidget *)
virtual void SelectRegion(double eventPos[2])
Subclasses generally implement this method.
~vtkBorderWidget() override
static vtkBorderWidget * New()
Method to instantiate class.
void SetCursor(int State) override
vtkTypeBool Selectable
vtkBorderRepresentation * GetBorderRepresentation()
Return the representation as a vtkBorderRepresentation.
virtual int SubclassSelectAction()
static void EndSelectAction(vtkAbstractWidget *)
static void HoverLeaveAction(vtkAbstractWidget *)
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
virtual int SubclassMoveAction()
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for class.
virtual int SubclassEndSelectAction()
virtual int SubclassTranslateAction()
void SetRepresentation(vtkBorderRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
static void MoveAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69