VTK  9.0.20200531
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 "vtkBorderWidget.h"
39 #include "vtkInteractionWidgetsModule.h" // For export macro
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  {
63  return reinterpret_cast<vtkScalarBarRepresentation*>(this->GetRepresentation());
64  }
65 
67 
70  virtual void SetScalarBarActor(vtkScalarBarActor* actor);
71  virtual vtkScalarBarActor* GetScalarBarActor();
73 
75 
81  vtkSetMacro(Repositionable, vtkTypeBool);
82  vtkGetMacro(Repositionable, vtkTypeBool);
83  vtkBooleanMacro(Repositionable, vtkTypeBool);
85 
89  void CreateDefaultRepresentation() override;
90 
91 protected:
93  ~vtkScalarBarWidget() override;
94 
96 
97  // Handle the case of Repositionable == 0
98  static void MoveAction(vtkAbstractWidget*);
99 
100  // set the cursor to the correct shape based on State argument
101  void SetCursor(int State) override;
102 
103 private:
104  vtkScalarBarWidget(const vtkScalarBarWidget&) = delete;
105  void operator=(const vtkScalarBarWidget&) = delete;
106 };
107 
108 #endif
vtkScalarBarWidget
2D widget for manipulating a scalar bar
Definition: vtkScalarBarWidget.h:44
vtkAbstractWidget::GetRepresentation
vtkWidgetRepresentation * GetRepresentation()
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkAbstractWidget.h:135
vtkScalarBarWidget::GetScalarBarRepresentation
vtkScalarBarRepresentation * GetScalarBarRepresentation()
Return the representation as a vtkScalarBarRepresentation.
Definition: vtkScalarBarWidget.h:61
vtkBorderWidget
place a border around a 2D rectangular region
Definition: vtkBorderWidget.h:87
vtkBorderWidget::CreateDefaultRepresentation
void CreateDefaultRepresentation() override
Create the default widget representation if one is not set.
vtkScalarBarWidget::Repositionable
vtkTypeBool Repositionable
Definition: vtkScalarBarWidget.h:95
vtkBorderWidget.h
vtkBorderWidget::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAbstractWidget
define the API for widget / widget representation
Definition: vtkAbstractWidget.h:65
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkBorderWidget::New
static vtkBorderWidget * New()
Method to instantiate class.
vtkBorderWidget::SetCursor
void SetCursor(int State) override
vtkBorderWidget::MoveAction
static void MoveAction(vtkAbstractWidget *)
vtkBorderWidget::SetRepresentation
void SetRepresentation(vtkBorderRepresentation *r)
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Definition: vtkBorderWidget.h:131
vtkScalarBarRepresentation
represent scalar bar for vtkScalarBarWidget
Definition: vtkScalarBarRepresentation.h:51
vtkScalarBarActor
Create a scalar bar with labels.
Definition: vtkScalarBarActor.h:77
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69