VTK  9.1.20211115
vtkScalarBarWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkScalarBarWidget.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 =========================================================================*/
54 #ifndef vtkScalarBarWidget_h
55 #define vtkScalarBarWidget_h
56 
57 #include "vtkBorderWidget.h"
58 #include "vtkInteractionWidgetsModule.h" // For export macro
59 
60 class vtkScalarBarActor;
62 
63 class VTKINTERACTIONWIDGETS_EXPORT vtkScalarBarWidget : public vtkBorderWidget
64 {
65 public:
68  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
76 
81  {
82  return reinterpret_cast<vtkScalarBarRepresentation*>(this->GetRepresentation());
83  }
84 
86 
89  virtual void SetScalarBarActor(vtkScalarBarActor* actor);
92 
94 
100  vtkSetMacro(Repositionable, vtkTypeBool);
101  vtkGetMacro(Repositionable, vtkTypeBool);
102  vtkBooleanMacro(Repositionable, vtkTypeBool);
104 
109 
110 protected:
113 
115 
116  // Handle the case of Repositionable == 0
118 
119  // set the cursor to the correct shape based on State argument
120  void SetCursor(int State) override;
121 
122 private:
123  vtkScalarBarWidget(const vtkScalarBarWidget&) = delete;
124  void operator=(const vtkScalarBarWidget&) = delete;
125 };
126 
127 #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:113
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.
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:69