VTK
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 =========================================================================*/
38 #ifndef vtkScalarBarWidget_h
39 #define vtkScalarBarWidget_h
40 
41 #include "vtkInteractionWidgetsModule.h" // For export macro
42 #include "vtkBorderWidget.h"
43 
44 class vtkScalarBarActor;
46 
47 class VTKINTERACTIONWIDGETS_EXPORT vtkScalarBarWidget : public vtkBorderWidget
48 {
49 public:
50  static vtkScalarBarWidget *New();
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
60 
65  { return reinterpret_cast<vtkScalarBarRepresentation *>(this->GetRepresentation()); }
66 
68 
71  virtual void SetScalarBarActor(vtkScalarBarActor *actor);
72  virtual vtkScalarBarActor *GetScalarBarActor();
74 
76 
82  vtkSetMacro(Repositionable, vtkTypeBool);
83  vtkGetMacro(Repositionable, vtkTypeBool);
84  vtkBooleanMacro(Repositionable, vtkTypeBool);
86 
90  void CreateDefaultRepresentation() override;
91 
92 protected:
94  ~vtkScalarBarWidget() override;
95 
97 
98  // Handle the case of Repositionable == 0
99  static void MoveAction(vtkAbstractWidget*);
100 
101  // set the cursor to the correct shape based on State argument
102  void SetCursor(int State) override;
103 
104 private:
105  vtkScalarBarWidget(const vtkScalarBarWidget&) = delete;
106  void operator=(const vtkScalarBarWidget&) = delete;
107 };
108 
109 #endif
vtkTypeBool Repositionable
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
place a border around a 2D rectangular region
static void MoveAction(vtkAbstractWidget *)
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for class.
static vtkBorderWidget * New()
Method to instantiate class.
Create a scalar bar with labels.
int vtkTypeBool
Definition: vtkABI.h:69
a simple class to control print indentation
Definition: vtkIndent.h:39
represent scalar bar for vtkScalarBarWidget
define the API for widget / widget representation
void SetCursor(int State) override
void SetRepresentation(vtkBorderRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene...
vtkWidgetRepresentation * GetRepresentation()
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene...
vtkScalarBarRepresentation * GetScalarBarRepresentation()
Return the representation as a vtkScalarBarRepresentation.
2D widget for manipulating a scalar bar