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 =========================================================================*/
35 #ifndef vtkScalarBarWidget_h
36 #define vtkScalarBarWidget_h
37 
38 #include "vtkInteractionWidgetsModule.h" // For export macro
39 #include "vtkBorderWidget.h"
40 
41 class vtkScalarBarActor;
43 
44 class VTKINTERACTIONWIDGETS_EXPORT vtkScalarBarWidget : public vtkBorderWidget
45 {
46 public:
47  static vtkScalarBarWidget *New();
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
57 
62  { return reinterpret_cast<vtkScalarBarRepresentation *>(this->GetRepresentation()); }
63 
65 
68  virtual void SetScalarBarActor(vtkScalarBarActor *actor);
69  virtual vtkScalarBarActor *GetScalarBarActor();
71 
73 
79  vtkSetMacro(Repositionable, vtkTypeBool);
80  vtkGetMacro(Repositionable, vtkTypeBool);
81  vtkBooleanMacro(Repositionable, vtkTypeBool);
83 
87  void CreateDefaultRepresentation() override;
88 
89 protected:
91  ~vtkScalarBarWidget() override;
92 
94 
95  // Handle the case of Repositionable == 0
96  static void MoveAction(vtkAbstractWidget*);
97 
98  // set the cursor to the correct shape based on State argument
99  void SetCursor(int State) override;
100 
101 private:
102  vtkScalarBarWidget(const vtkScalarBarWidget&) = delete;
103  void operator=(const vtkScalarBarWidget&) = delete;
104 };
105 
106 #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:33
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