VTK  9.2.6
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 "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
84 #include "vtkInteractionWidgetsModule.h" // For export macro
85 
87 
88 class VTKINTERACTIONWIDGETS_EXPORT vtkBorderWidget : public vtkAbstractWidget
89 {
90 public:
94  static vtkBorderWidget* New();
95 
97 
101  void PrintSelf(ostream& os, vtkIndent indent) override;
103 
105 
111  vtkSetMacro(Selectable, vtkTypeBool);
112  vtkGetMacro(Selectable, vtkTypeBool);
113  vtkBooleanMacro(Selectable, vtkTypeBool);
115 
117 
122  vtkSetMacro(Resizable, vtkTypeBool);
123  vtkGetMacro(Resizable, vtkTypeBool);
124  vtkBooleanMacro(Resizable, vtkTypeBool);
126 
133  {
134  this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
135  }
136 
141  {
142  return reinterpret_cast<vtkBorderRepresentation*>(this->WidgetRep);
143  }
144 
148  void CreateDefaultRepresentation() override;
149 
154  vtkTypeBool GetProcessEvents() override;
155 
156 protected:
157  vtkBorderWidget();
158  ~vtkBorderWidget() override;
159 
165  virtual void SelectRegion(double eventPos[2]);
166 
167  // enable the selection of the region interior to the widget
170 
171  // processes the registered events
172  static void SelectAction(vtkAbstractWidget*);
173  static void TranslateAction(vtkAbstractWidget*);
174  static void EndSelectAction(vtkAbstractWidget*);
175  static void MoveAction(vtkAbstractWidget*);
176  static void HoverLeaveAction(vtkAbstractWidget*);
177 
178  // Special internal methods to support subclasses handling events.
179  // If a non-zero value is returned, the subclass is handling the event.
180  virtual int SubclassSelectAction() { return 0; }
181  virtual int SubclassTranslateAction() { return 0; }
182  virtual int SubclassEndSelectAction() { return 0; }
183  virtual int SubclassMoveAction() { return 0; }
184 
185  // helper methods for cursoe management
186  void SetCursor(int State) override;
187 
188  // widget state
191  {
192  Start = 0,
195  Selected
196  };
197 #if !defined(VTK_LEGACY_REMOVE)
198  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
200 #endif
201 
202 private:
203  vtkBorderWidget(const vtkBorderWidget&) = delete;
204  void operator=(const vtkBorderWidget&) = delete;
205 };
206 
207 #endif
virtual void SetCursor(int vtkNotUsed(state))
place a border around a 2D rectangular region
#define VTK_DEPRECATED_IN_9_2_0(reason)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard macros implementing standard VTK methods.
virtual int SubclassTranslateAction()
virtual void CreateDefaultRepresentation()=0
Create the default widget representation if one is not set.
virtual int SubclassMoveAction()
vtkWidgetRepresentation * WidgetRep
int vtkTypeBool
Definition: vtkABI.h:69
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual vtkTypeBool GetProcessEvents()
Methods to change whether the widget responds to interaction.
represent a vtkBorderWidget
virtual int SubclassEndSelectAction()
vtkTypeBool Resizable
define the API for widget / widget representation
vtkBorderRepresentation * GetBorderRepresentation()
Return the representation as a vtkBorderRepresentation.
vtkTypeBool Selectable
virtual int SubclassSelectAction()
void SetRepresentation(vtkBorderRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene...
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...