VTK  9.0.1
vtkColorLegend.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkColorLegend.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 =========================================================================*/
15 
24 #ifndef vtkColorLegend_h
25 #define vtkColorLegend_h
26 
27 #include "vtkChartLegend.h"
28 #include "vtkChartsCoreModule.h" // For export macro
29 #include "vtkSmartPointer.h" // For SP ivars
30 #include "vtkVector.h" // For vtkRectf
31 
32 class vtkAxis;
34 class vtkImageData;
35 class vtkScalarsToColors;
36 class vtkCallbackCommand;
37 
38 class VTKCHARTSCORE_EXPORT vtkColorLegend : public vtkChartLegend
39 {
40 public:
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43  static vtkColorLegend* New();
44 
48  enum
49  {
50  VERTICAL = 0,
51  HORIZONTAL
52  };
53 
58  virtual void GetBounds(double bounds[4]);
59 
65  void Update() override;
66 
72  bool Paint(vtkContext2D* painter) override;
73 
75 
79  virtual void SetTransferFunction(vtkScalarsToColors* transfer);
80  virtual vtkScalarsToColors* GetTransferFunction();
82 
86  void SetPoint(float x, float y) override;
87 
91  virtual void SetTextureSize(float w, float h);
92 
99  virtual void SetPosition(const vtkRectf& pos);
100 
105  virtual vtkRectf GetPosition();
106 
113  vtkRectf GetBoundingRect(vtkContext2D* painter) override;
114 
116 
120  virtual void SetOrientation(int orientation);
121  vtkGetMacro(Orientation, int);
123 
125 
128  virtual void SetTitle(const vtkStdString& title);
129  virtual vtkStdString GetTitle();
131 
133 
137  vtkSetMacro(DrawBorder, bool);
138  vtkGetMacro(DrawBorder, bool);
139  vtkBooleanMacro(DrawBorder, bool);
141 
145  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
146 
147 protected:
148  vtkColorLegend();
149  ~vtkColorLegend() override;
150 
155  virtual void ComputeTexture();
156 
158 
162  virtual void ScalarsToColorsModified(vtkObject* caller, unsigned long eid, void* calldata);
163  static void OnScalarsToColorsModified(
164  vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
166 
170  void UpdateAxisPosition();
171 
181 
182 private:
183  vtkColorLegend(const vtkColorLegend&) = delete;
184  void operator=(const vtkColorLegend&) = delete;
185 };
186 
187 #endif
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:62
virtual vtkRectf GetBoundingRect(vtkContext2D *painter)
Request the space the legend requires to be drawn.
void Update() override
Update the geometry of the axis.
Legend item to display vtkScalarsToColors.
vtkSmartPointer< vtkCallbackCommand > Callback
Superclass for mapping scalar values to colors.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:52
supports function callbacks
takes care of drawing 2D axes
Definition: vtkAxis.h:68
data structure to represent mouse events.
a simple class to control print indentation
Definition: vtkIndent.h:33
static vtkChartLegend * New()
Creates a 2D Chart object.
topologically and geometrically regular array of data
Definition: vtkImageData.h:41
virtual void SetPoint(float, float)
Set point the legend box is anchored to.
vtkScalarsToColors * TransferFunction
bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override
Mouse move event.
vtkSmartPointer< vtkImageData > ImageData
draw the chart legend
bool Paint(vtkContext2D *painter) override
Paint event for the axis, called whenever the axis needs to be drawn.
vtkSmartPointer< vtkAxis > Axis