VTK  9.3.0
vtkColorLegend.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 
12 #ifndef vtkColorLegend_h
13 #define vtkColorLegend_h
14 
15 #include "vtkChartLegend.h"
16 #include "vtkChartsCoreModule.h" // For export macro
17 #include "vtkSmartPointer.h" // For SP ivars
18 #include "vtkVector.h" // For vtkRectf
19 
20 VTK_ABI_NAMESPACE_BEGIN
21 class vtkAxis;
23 class vtkImageData;
24 class vtkScalarsToColors;
25 class vtkCallbackCommand;
26 
27 class VTKCHARTSCORE_EXPORT vtkColorLegend : public vtkChartLegend
28 {
29 public:
31  void PrintSelf(ostream& os, vtkIndent indent) override;
32  static vtkColorLegend* New();
33 
37  enum
38  {
39  VERTICAL = 0,
40  HORIZONTAL
41  };
42 
47  virtual void GetBounds(double bounds[4]);
48 
54  void Update() override;
55 
61  bool Paint(vtkContext2D* painter) override;
62 
64 
68  virtual void SetTransferFunction(vtkScalarsToColors* transfer);
71 
75  void SetPoint(float x, float y) override;
76 
80  virtual void SetTextureSize(float w, float h);
81 
88  virtual void SetPosition(const vtkRectf& pos);
89 
94  virtual vtkRectf GetPosition();
95 
103 
105 
109  virtual void SetOrientation(int orientation);
110  vtkGetMacro(Orientation, int);
112 
114 
117  virtual void SetTitle(const vtkStdString& title);
120 
122 
126  vtkSetMacro(DrawBorder, bool);
127  vtkGetMacro(DrawBorder, bool);
128  vtkBooleanMacro(DrawBorder, bool);
130 
134  bool MouseMoveEvent(const vtkContextMouseEvent& mouse) override;
135 
136 protected:
138  ~vtkColorLegend() override;
139 
144  virtual void ComputeTexture();
145 
147 
151  virtual void ScalarsToColorsModified(vtkObject* caller, unsigned long eid, void* calldata);
153  vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
155 
160 
170 
171 private:
172  vtkColorLegend(const vtkColorLegend&) = delete;
173  void operator=(const vtkColorLegend&) = delete;
174 };
175 
176 VTK_ABI_NAMESPACE_END
177 #endif
takes care of drawing 2D axes
Definition: vtkAxis.h:61
supports function callbacks
draw the chart legend
Legend item to display vtkScalarsToColors.
static vtkColorLegend * New()
vtkRectf GetBoundingRect(vtkContext2D *painter) override
Request the space the legend requires to be drawn.
virtual void SetOrientation(int orientation)
Set/get the orientation of the legend.
virtual void GetBounds(double bounds[4])
Bounds of the item, by default (0, 1, 0, 1) but it mainly depends on the range of the vtkScalarsToCol...
virtual vtkRectf GetPosition()
Returns the origin, width, and height of the scalar bar drawn by this legend.
virtual vtkScalarsToColors * GetTransferFunction()
Set/Get the transfer function that is used to draw the scalar bar within this legend.
void SetPoint(float x, float y) override
Set the point this legend is anchored to.
void UpdateAxisPosition()
Moves the axis whenever the position of this legend changes.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSmartPointer< vtkCallbackCommand > Callback
vtkSmartPointer< vtkImageData > ImageData
virtual void ComputeTexture()
Need to be reimplemented by subclasses, ComputeTexture() is called at paint time if the texture is no...
virtual void SetTextureSize(float w, float h)
Set the size of the scalar bar drawn by this legend.
static void OnScalarsToColorsModified(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
Called whenever the ScalarsToColors function(s) is modified.
virtual void SetPosition(const vtkRectf &pos)
Set the origin, width, and height of the scalar bar drawn by this legend.
virtual vtkStdString GetTitle()
Get/set the title text of the legend.
~vtkColorLegend() override
void Update() override
Perform any updates to the item that may be necessary before rendering.
vtkSmartPointer< vtkAxis > Axis
virtual void ScalarsToColorsModified(vtkObject *caller, unsigned long eid, void *calldata)
Called whenever the ScalarsToColors function(s) is modified.
vtkScalarsToColors * TransferFunction
virtual void SetTitle(const vtkStdString &title)
Get/set the title text of the legend.
bool Paint(vtkContext2D *painter) override
Paint the texture into a rectangle defined by the bounds.
virtual void SetTransferFunction(vtkScalarsToColors *transfer)
Set/Get the transfer function that is used to draw the scalar bar within this legend.
bool MouseMoveEvent(const vtkContextMouseEvent &mouse) override
Mouse move event.
Class for drawing 2D primitives to a graphical context.
Definition: vtkContext2D.h:50
data structure to represent mouse events.
topologically and geometrically regular array of data
Definition: vtkImageData.h:43
a simple class to control print indentation
Definition: vtkIndent.h:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
Superclass for mapping scalar values to colors.
Computes the portion of a dataset which is inside a selection.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:29
@ orientation
Definition: vtkX3D.h:262
@ title
Definition: vtkX3D.h:500