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
73#ifndef vtkBorderWidget_h
74#define vtkBorderWidget_h
75
76#include "vtkAbstractWidget.h"
77#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
78#include "vtkInteractionWidgetsModule.h" // For export macro
79#include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
80
81VTK_ABI_NAMESPACE_BEGIN
83
84class VTKINTERACTIONWIDGETS_EXPORT vtkBorderWidget : public vtkAbstractWidget
85{
86public:
91
93
97 void PrintSelf(ostream& os, vtkIndent indent) override;
99
101
107 vtkSetMacro(Selectable, vtkTypeBool);
108 vtkGetMacro(Selectable, vtkTypeBool);
109 vtkBooleanMacro(Selectable, vtkTypeBool);
111
113
118 vtkSetMacro(Resizable, vtkTypeBool);
119 vtkGetMacro(Resizable, vtkTypeBool);
120 vtkBooleanMacro(Resizable, vtkTypeBool);
122
129 {
130 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
131 }
132
137 {
138 return reinterpret_cast<vtkBorderRepresentation*>(this->WidgetRep);
139 }
140
145
151
152protected:
155
161 virtual void SelectRegion(double eventPos[2]);
162
163 // enable the selection of the region interior to the widget
166
167 // processes the registered events
173
174 // Special internal methods to support subclasses handling events.
175 // If a non-zero value is returned, the subclass is handling the event.
176 virtual int SubclassSelectAction() { return 0; }
177 virtual int SubclassTranslateAction() { return 0; }
178 virtual int SubclassEndSelectAction() { return 0; }
179 virtual int SubclassMoveAction() { return 0; }
180
181 // helper methods for cursoe management
182 void SetCursor(int State) override;
183
184 // widget state
187 {
188 Start = 0,
191 Selected
192 };
193#if !defined(VTK_LEGACY_REMOVE)
194 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
196#endif
197
198private:
199 vtkBorderWidget(const vtkBorderWidget&) = delete;
200 void operator=(const vtkBorderWidget&) = delete;
201};
202
203VTK_ABI_NAMESPACE_END
204#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
represent a vtkBorderWidget
place a border around a 2D rectangular region
static vtkBorderWidget * New()
Method to instantiate class.
vtkTypeBool Resizable
static void SelectAction(vtkAbstractWidget *)
static void TranslateAction(vtkAbstractWidget *)
virtual void SelectRegion(double eventPos[2])
Subclasses generally implement this method.
~vtkBorderWidget() override
void SetCursor(int State) override
vtkTypeBool Selectable
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.
vtkBorderRepresentation * GetBorderRepresentation()
Return the representation as a vtkBorderRepresentation.
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)