VTK  9.3.20240328
vtkScalarBarWidget.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
45 #ifndef vtkScalarBarWidget_h
46 #define vtkScalarBarWidget_h
47 
48 #include "vtkBorderWidget.h"
49 #include "vtkInteractionWidgetsModule.h" // For export macro
50 
51 VTK_ABI_NAMESPACE_BEGIN
52 class vtkScalarBarActor;
54 
55 class VTKINTERACTIONWIDGETS_EXPORT vtkScalarBarWidget : public vtkBorderWidget
56 {
57 public:
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
68 
73  {
74  return reinterpret_cast<vtkScalarBarRepresentation*>(this->GetRepresentation());
75  }
76 
78 
81  virtual void SetScalarBarActor(vtkScalarBarActor* actor);
84 
86 
92  vtkSetMacro(Repositionable, vtkTypeBool);
93  vtkGetMacro(Repositionable, vtkTypeBool);
94  vtkBooleanMacro(Repositionable, vtkTypeBool);
96 
101 
107 
108 protected:
111 
113 
114  // Handle the case of Repositionable == 0
116 
117  // set the cursor to the correct shape based on State argument
118  void SetCursor(int State) override;
119 
120 private:
121  vtkScalarBarWidget(const vtkScalarBarWidget&) = delete;
122  void operator=(const vtkScalarBarWidget&) = delete;
123 };
124 
125 VTK_ABI_NAMESPACE_END
126 #endif
define the API for widget / widget representation
vtkWidgetRepresentation * GetRepresentation()
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
place a border around a 2D rectangular region
a simple class to control print indentation
Definition: vtkIndent.h:108
Create a scalar bar with labels.
represent scalar bar for vtkScalarBarWidget
2D widget for manipulating a scalar bar
vtkScalarBarRepresentation * GetScalarBarRepresentation()
Return the representation as a vtkScalarBarRepresentation.
static void MoveAction(vtkAbstractWidget *)
virtual void SetRepresentation(vtkScalarBarRepresentation *rep)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
vtkTypeBool GetProcessEvents() override
Reimplement ProcessEvents to use vtkAbstractWidget instead of vtkBorderWidget, for interaction with t...
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
~vtkScalarBarWidget() override
void SetCursor(int State) override
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for class.
static vtkScalarBarWidget * New()
virtual void SetScalarBarActor(vtkScalarBarActor *actor)
Get the ScalarBar used by this Widget.
virtual vtkScalarBarActor * GetScalarBarActor()
Get the ScalarBar used by this Widget.
int vtkTypeBool
Definition: vtkABI.h:64