VTK  9.3.0
vtkMagnifierWidget.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
36#ifndef vtkMagnifierWidget_h
37#define vtkMagnifierWidget_h
38
39#include "vtkAbstractWidget.h"
40#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
41#include "vtkInteractionWidgetsModule.h" // For export macro
42#include "vtkLegacy.h" // for VTK_LEGACY_REMOVE
43
44VTK_ABI_NAMESPACE_BEGIN
46
47class VTKINTERACTIONWIDGETS_EXPORT vtkMagnifierWidget : public vtkAbstractWidget
48{
49public:
54
56
60 void PrintSelf(ostream& os, vtkIndent indent) override;
62
69 {
70 this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));
71 }
72
80
85
90 void SetEnabled(int enabling) override;
91
93
99 vtkSetMacro(KeyPressIncreaseValue, char);
100 vtkGetMacro(KeyPressIncreaseValue, char);
101 vtkSetMacro(KeyPressDecreaseValue, char);
102 vtkGetMacro(KeyPressDecreaseValue, char);
104
105protected:
108
109 // Keypresses to change value
112
113 // process the registered events
116
119 {
120 Invisible = 0,
121 Visible
122 };
123#if !defined(VTK_LEGACY_REMOVE)
124 VTK_DEPRECATED_IN_9_2_0("because leading underscore is reserved")
126#endif
127
128private:
129 vtkMagnifierWidget(const vtkMagnifierWidget&) = delete;
130 void operator=(const vtkMagnifierWidget&) = delete;
131};
132
133VTK_ABI_NAMESPACE_END
134#endif
define the API for widget / widget representation
vtkWidgetRepresentation * WidgetRep
a simple class to control print indentation
Definition vtkIndent.h:29
represent a vtkBorderWidget
create a moving, magnifying renderer that can inspect the contents of an encapsulating renderer.
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
static void CharAction(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for class.
void SetEnabled(int enabling) override
Override superclasses' SetEnabled() method because the this widget must activate the representation.
~vtkMagnifierWidget() override
static void MoveAction(vtkAbstractWidget *)
void SetRepresentation(vtkMagnifierRepresentation *r)
Specify an instance of vtkMagnifierRepresentation used to represent this widget in the scene.
vtkMagnifierRepresentation * GetMagnifierRepresentation()
Return the representation as a vtkBorderRepresentation.
static vtkMagnifierWidget * New()
Method to instantiate class.
abstract class defines interface between the widget and widget representation classes
#define VTK_DEPRECATED_IN_9_2_0(reason)