VTK  9.3.0
vtkBorderWidget.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
76 #ifndef vtkBorderWidget_h
77 #define vtkBorderWidget_h
78 
79 #include "vtkAbstractWidget.h"
80 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
81 #include "vtkInteractionWidgetsModule.h" // For export macro
82 #include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
83 
84 VTK_ABI_NAMESPACE_BEGIN
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 
154 
155 protected:
157  ~vtkBorderWidget() override;
158 
164  virtual void SelectRegion(double eventPos[2]);
165 
166  // enable the selection of the region interior to the widget
169 
170  // processes the registered events
176 
177  // Special internal methods to support subclasses handling events.
178  // If a non-zero value is returned, the subclass is handling the event.
179  virtual int SubclassSelectAction() { return 0; }
180  virtual int SubclassTranslateAction() { return 0; }
181  virtual int SubclassEndSelectAction() { return 0; }
182  virtual int SubclassMoveAction() { return 0; }
183 
184  // helper methods for cursoe management
185  void SetCursor(int State) override;
186 
187  // widget state
190  {
191  Start = 0,
194  Selected
195  };
196 #if !defined(VTK_LEGACY_REMOVE)
197  VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
199 #endif
200 
201 private:
202  vtkBorderWidget(const vtkBorderWidget&) = delete;
203  void operator=(const vtkBorderWidget&) = delete;
204 };
205 
206 VTK_ABI_NAMESPACE_END
207 #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:38
abstract class defines interface between the widget and widget representation classes
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_DEPRECATED_IN_9_2_0(reason)