VTK  9.2.5
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 =========================================================================*/
138 #ifndef vtkBorderWidget_h
139 #define vtkBorderWidget_h
140 
141 #include "vtkAbstractWidget.h"
142 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
143 #include "vtkInteractionWidgetsModule.h" // For export macro
144 
146 
147 class VTKINTERACTIONWIDGETS_EXPORT vtkBorderWidget : public vtkAbstractWidget
148 {
149 public:
153  static vtkBorderWidget* New();
154 
156 
160  void PrintSelf(ostream& os, vtkIndent indent) override;
162 
164 
170  vtkSetMacro(Selectable, vtkTypeBool);
171  vtkGetMacro(Selectable, vtkTypeBool);
172  vtkBooleanMacro(Selectable, vtkTypeBool);
174 
176 
181  vtkSetMacro(Resizable, vtkTypeBool);
182  vtkGetMacro(Resizable, vtkTypeBool);
183  vtkBooleanMacro(Resizable, vtkTypeBool);
185 
192  {
193  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
194  }
195 
200  {
201  return reinterpret_cast<vtkBorderRepresentation*>(this->WidgetRep);
202  }
203 
208 
214 
215 protected:
217  ~vtkBorderWidget() override;
218 
224  virtual void SelectRegion(double eventPos[2]);
225 
226  // enable the selection of the region interior to the widget
229 
230  // processes the registered events
236 
237  // Special internal methods to support subclasses handling events.
238  // If a non-zero value is returned, the subclass is handling the event.
239  virtual int SubclassSelectAction() { return 0; }
240  virtual int SubclassTranslateAction() { return 0; }
241  virtual int SubclassEndSelectAction() { return 0; }
242  virtual int SubclassMoveAction() { return 0; }
243 
244  // helper methods for cursoe management
245  void SetCursor(int State) override;
246 
247  // widget state
250  {
251  Start = 0,
254  Selected
255  };
256 #if !defined(VTK_LEGACY_REMOVE)
257  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
259 #endif
260 
261 private:
262  vtkBorderWidget(const vtkBorderWidget&) = delete;
263  void operator=(const vtkBorderWidget&) = delete;
264 };
265 
266 #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.
vtkTypeBool GetProcessEvents() override
Reimplement ProcessEvents to disable it when using relative location with windowLocation.
static void MoveAction(vtkAbstractWidget *)
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_DEPRECATED_IN_9_2_0(reason)