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=========================================================================*/
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
88class VTKINTERACTIONWIDGETS_EXPORT vtkBorderWidget : public vtkAbstractWidget
89{
90public:
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
149
155
156protected:
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
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
202private:
203 vtkBorderWidget(const vtkBorderWidget&) = delete;
204 void operator=(const vtkBorderWidget&) = delete;
205};
206
207#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:40
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)