1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkColorLegend.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkColorLegend
* @brief Legend item to display vtkScalarsToColors.
*
* vtkColorLegend is an item that will display the vtkScalarsToColors
* using a 1D texture, and a vtkAxis to show both the color and numerical range.
*/
#ifndef vtkColorLegend_h
#define vtkColorLegend_h
#include "vtkChartsCoreModule.h" // For export macro
#include "vtkChartLegend.h"
#include "vtkSmartPointer.h" // For SP ivars
#include "vtkVector.h" // For vtkRectf
class vtkAxis;
class vtkContextMouseEvent;
class vtkImageData;
class vtkScalarsToColors;
class vtkCallbackCommand;
class VTKCHARTSCORE_EXPORT vtkColorLegend: public vtkChartLegend
{
public:
vtkTypeMacro(vtkColorLegend, vtkChartLegend);
virtual void PrintSelf(ostream &os, vtkIndent indent);
static vtkColorLegend* New();
/**
* Enum of legend orientation types
*/
enum {
VERTICAL = 0,
HORIZONTAL
};
/**
* Bounds of the item, by default (0, 1, 0, 1) but it mainly depends on the
* range of the vtkScalarsToColors function.
*/
virtual void GetBounds(double bounds[4]);
/**
* Perform any updates to the item that may be necessary before rendering.
* The scene should take care of calling this on all items before their
* Paint function is invoked.
*/
virtual void Update();
/**
* Paint the texture into a rectangle defined by the bounds. If
* MaskAboveCurve is true and a shape has been provided by a subclass, it
* draws the texture into the shape
*/
virtual bool Paint(vtkContext2D *painter);
//@{
/**
* Set/Get the transfer function that is used to draw the scalar bar
* within this legend.
*/
virtual void SetTransferFunction(vtkScalarsToColors* transfer);
virtual vtkScalarsToColors * GetTransferFunction();
//@}
/**
* Set the point this legend is anchored to.
*/
virtual void SetPoint(float x, float y);
/**
* Set the size of the scalar bar drawn by this legend.
*/
virtual void SetTextureSize(float w, float h);
/**
* Set the origin, width, and height of the scalar bar drawn by this legend.
* This method overrides the anchor point, as well as any horizontal and
* vertical alignment that has been set for this legend. If this is a
* problem for you, use SetPoint() and SetTextureSize() instead.
*/
virtual void SetPosition(const vtkRectf& pos);
/**
* Returns the origin, width, and height of the scalar bar drawn by this
* legend.
*/
virtual vtkRectf GetPosition();
/**
* Request the space the legend requires to be drawn. This is returned as a
* vtkRect4f, with the corner being the offset from Point, and the width/
* height being the total width/height required by the axis. In order to
* ensure the numbers are correct, Update() should be called first.
*/
vtkRectf GetBoundingRect(vtkContext2D* painter);
//@{
/**
* Set/get the orientation of the legend.
* Valid orientations are VERTICAL (default) and HORIZONTAL.
*/
virtual void SetOrientation(int orientation);
vtkGetMacro(Orientation, int);
//@}
//@{
/**
* Get/set the title text of the legend.
*/
virtual void SetTitle(const vtkStdString &title);
virtual vtkStdString GetTitle();
//@}
//@{
/**
* Toggle whether or not a border should be drawn around this legend.
* The default behavior is to not draw a border.
*/
vtkSetMacro(DrawBorder, bool);
vtkGetMacro(DrawBorder, bool);
vtkBooleanMacro(DrawBorder, bool);
//@}
/**
* Mouse move event.
*/
virtual bool MouseMoveEvent(const vtkContextMouseEvent &mouse);
protected:
vtkColorLegend();
virtual ~vtkColorLegend();
/**
* Need to be reimplemented by subclasses, ComputeTexture() is called at
* paint time if the texture is not up to date compared to vtkColorLegend
*/
virtual void ComputeTexture();
//@{
/**
* Called whenever the ScalarsToColors function(s) is modified. It internally
* calls Modified(). Can be reimplemented by subclasses.
*/
virtual void ScalarsToColorsModified(vtkObject* caller, unsigned long eid,
void* calldata);
static void OnScalarsToColorsModified(vtkObject* caller, unsigned long eid,
void *clientdata, void* calldata);
//@}
/**
* Moves the axis whenever the position of this legend changes.
*/
void UpdateAxisPosition();
vtkScalarsToColors* TransferFunction;
vtkSmartPointer<vtkImageData> ImageData;
vtkSmartPointer<vtkAxis> Axis;
vtkSmartPointer<vtkCallbackCommand> Callback;
bool Interpolate;
bool CustomPositionSet;
bool DrawBorder;
vtkRectf Position;
int Orientation;
private:
vtkColorLegend(const vtkColorLegend &) VTK_DELETE_FUNCTION;
void operator=(const vtkColorLegend &) VTK_DELETE_FUNCTION;
};
#endif
|
