← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtLinearColorMap.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-07-01 16:08:21 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20090701160821-gog44m4w7x2f4u6o
Tags: 5.2.0-1
* New upstream release.
* Add branch pull patch from svn r544.
* Bump Standards-Version to 3.8.2. No changes needed.
* Update installed manpages.
* Use qwt as base name for directory (drop version).
* Add missing warnings patch.
* Rewrite debian/rules: use dh.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtLinearColorMap.3
1
 
.TH "QwtLinearColorMap" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtLinearColorMap \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtColorMap\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
\fBQwtLinearColorMap\fP builds a color map from color stops. 
14
 
 
15
 
A color stop is a color at a specific position. The valid range for the positions is [0.0, 1.0]. When mapping a value into a color it is translated into this interval. If \fBmode()\fP == FixedColors the color is calculated from the next lower color stop. If \fBmode()\fP == ScaledColors the color is calculated by interpolating the colors of the adjacent stops. 
16
 
.PP
17
 
Definition at line 111 of file qwt_color_map.h.
18
 
.SS "Public Types"
19
 
 
20
 
.in +1c
21
 
.ti -1c
22
 
.RI "enum \fBMode\fP { \fBFixedColors\fP, \fBScaledColors\fP, \fBRotateNeedle\fP, \fBRotateScale\fP }"
23
 
.br
24
 
.in -1c
25
 
.SS "Public Member Functions"
26
 
 
27
 
.in +1c
28
 
.ti -1c
29
 
.RI "\fBQwtLinearColorMap\fP (\fBQwtColorMap::Format\fP=QwtColorMap::RGB)"
30
 
.br
31
 
.ti -1c
32
 
.RI "\fBQwtLinearColorMap\fP (const QColor &from, const QColor &to, \fBQwtColorMap::Format\fP=QwtColorMap::RGB)"
33
 
.br
34
 
.ti -1c
35
 
.RI "\fBQwtLinearColorMap\fP (const \fBQwtLinearColorMap\fP &)"
36
 
.br
37
 
.ti -1c
38
 
.RI "virtual \fB~QwtLinearColorMap\fP ()"
39
 
.br
40
 
.ti -1c
41
 
.RI "\fBQwtLinearColorMap\fP & \fBoperator=\fP (const \fBQwtLinearColorMap\fP &)"
42
 
.br
43
 
.ti -1c
44
 
.RI "virtual \fBQwtColorMap\fP * \fBcopy\fP () const"
45
 
.br
46
 
.ti -1c
47
 
.RI "void \fBsetMode\fP (\fBMode\fP)"
48
 
.br
49
 
.ti -1c
50
 
.RI "\fBMode\fP \fBmode\fP () const"
51
 
.br
52
 
.ti -1c
53
 
.RI "void \fBsetColorInterval\fP (const QColor &color1, const QColor &color2)"
54
 
.br
55
 
.ti -1c
56
 
.RI "void \fBaddColorStop\fP (double value, const QColor &)"
57
 
.br
58
 
.ti -1c
59
 
.RI "QwtArray< double > \fBcolorStops\fP () const"
60
 
.br
61
 
.ti -1c
62
 
.RI "QColor \fBcolor1\fP () const"
63
 
.br
64
 
.ti -1c
65
 
.RI "QColor \fBcolor2\fP () const"
66
 
.br
67
 
.ti -1c
68
 
.RI "virtual QRgb \fBrgb\fP (const \fBQwtDoubleInterval\fP &, double value) const"
69
 
.br
70
 
.ti -1c
71
 
.RI "virtual unsigned char \fBcolorIndex\fP (const \fBQwtDoubleInterval\fP &, double value) const"
72
 
.br
73
 
.in -1c
74
 
.SH "Member Enumeration Documentation"
75
 
.PP 
76
 
.SS "enum \fBQwtLinearColorMap::Mode\fP"
77
 
.PP
78
 
Mode of color map 
79
 
.PP
80
 
\fBSee also:\fP
81
 
.RS 4
82
 
\fBsetMode()\fP, \fBmode()\fP 
83
 
.RE
84
 
.PP
85
 
 
86
 
.PP
87
 
Definition at line 118 of file qwt_color_map.h.
88
 
.SH "Constructor & Destructor Documentation"
89
 
.PP 
90
 
.SS "QwtLinearColorMap::QwtLinearColorMap (\fBQwtColorMap::Format\fP format = \fCQwtColorMap::RGB\fP)"
91
 
.PP
92
 
Build a color map with two stops at 0.0 and 1.0. The color at 0.0 is Qt::blue, at 1.0 it is Qt::yellow.
93
 
.PP
94
 
\fBParameters:\fP
95
 
.RS 4
96
 
\fIformat\fP Preferred format of the color map 
97
 
.RE
98
 
.PP
99
 
 
100
 
.PP
101
 
Definition at line 211 of file qwt_color_map.cpp.
102
 
.PP
103
 
References setColorInterval().
104
 
.PP
105
 
Referenced by copy().
106
 
.SS "QwtLinearColorMap::QwtLinearColorMap (const QColor & color1, const QColor & color2, \fBQwtColorMap::Format\fP format = \fCQwtColorMap::RGB\fP)"
107
 
.PP
108
 
Build a color map with two stops at 0.0 and 1.0.
109
 
.PP
110
 
\fBParameters:\fP
111
 
.RS 4
112
 
\fIcolor1\fP Color used for the minimum value of the value interval 
113
 
.br
114
 
\fIcolor2\fP Color used for the maximum value of the value interval 
115
 
.br
116
 
\fIformat\fP Preferred format of the coor map 
117
 
.RE
118
 
.PP
119
 
 
120
 
.PP
121
 
Definition at line 235 of file qwt_color_map.cpp.
122
 
.PP
123
 
References setColorInterval().
124
 
.SS "QwtLinearColorMap::QwtLinearColorMap (const \fBQwtLinearColorMap\fP &)"
125
 
.PP
126
 
Copy constructor. 
127
 
.PP
128
 
Definition at line 221 of file qwt_color_map.cpp.
129
 
.SS "QwtLinearColorMap::~QwtLinearColorMap ()\fC [virtual]\fP"
130
 
.PP
131
 
Destructor. 
132
 
.PP
133
 
Definition at line 245 of file qwt_color_map.cpp.
134
 
.SH "Member Function Documentation"
135
 
.PP 
136
 
.SS "\fBQwtLinearColorMap\fP & QwtLinearColorMap::operator= (const \fBQwtLinearColorMap\fP &)"
137
 
.PP
138
 
Assignment operator. 
139
 
.PP
140
 
Definition at line 251 of file qwt_color_map.cpp.
141
 
.PP
142
 
References d_data.
143
 
.SS "\fBQwtColorMap\fP * QwtLinearColorMap::copy () const\fC [virtual]\fP"
144
 
.PP
145
 
Clone the color map. 
146
 
.PP
147
 
Implements \fBQwtColorMap\fP.
148
 
.PP
149
 
Definition at line 260 of file qwt_color_map.cpp.
150
 
.PP
151
 
References QwtLinearColorMap().
152
 
.SS "void QwtLinearColorMap::setMode (\fBMode\fP mode)"
153
 
.PP
154
 
Set the mode of the color map. 
155
 
.PP
156
 
FixedColors means the color is calculated from the next lower color stop. ScaledColors means the color is calculated by interpolating the colors of the adjacent stops.
157
 
.PP
158
 
\fBSee also:\fP
159
 
.RS 4
160
 
\fBmode()\fP 
161
 
.RE
162
 
.PP
163
 
 
164
 
.PP
165
 
Definition at line 277 of file qwt_color_map.cpp.
166
 
.SS "\fBQwtLinearColorMap::Mode\fP QwtLinearColorMap::mode () const"
167
 
.PP
168
 
\fBReturns:\fP
169
 
.RS 4
170
 
Mode of the color map 
171
 
.RE
172
 
.PP
173
 
\fBSee also:\fP
174
 
.RS 4
175
 
\fBsetMode()\fP 
176
 
.RE
177
 
.PP
178
 
 
179
 
.PP
180
 
Definition at line 286 of file qwt_color_map.cpp.
181
 
.SS "void QwtLinearColorMap::setColorInterval (const QColor & color1, const QColor & color2)"
182
 
.PP
183
 
Set the color range
184
 
.PP
185
 
Add stops at 0.0 and 1.0.
186
 
.PP
187
 
\fBParameters:\fP
188
 
.RS 4
189
 
\fIcolor1\fP Color used for the minimum value of the value interval 
190
 
.br
191
 
\fIcolor2\fP Color used for the maximum value of the value interval
192
 
.RE
193
 
.PP
194
 
\fBSee also:\fP
195
 
.RS 4
196
 
\fBcolor1()\fP, \fBcolor2()\fP 
197
 
.RE
198
 
.PP
199
 
 
200
 
.PP
201
 
Definition at line 301 of file qwt_color_map.cpp.
202
 
.PP
203
 
Referenced by QwtLinearColorMap().
204
 
.SS "void QwtLinearColorMap::addColorStop (double value, const QColor & color)"
205
 
.PP
206
 
Add a color stop
207
 
.PP
208
 
The value has to be in the range [0.0, 1.0]. F.e. a stop at position 17.0 for a range [10.0,20.0] must be passed as: (17.0 - 10.0) / (20.0 - 10.0)
209
 
.PP
210
 
\fBParameters:\fP
211
 
.RS 4
212
 
\fIvalue\fP Value between [0.0, 1.0] 
213
 
.br
214
 
\fIcolor\fP Color stop 
215
 
.RE
216
 
.PP
217
 
 
218
 
.PP
219
 
Definition at line 319 of file qwt_color_map.cpp.
220
 
.SS "QwtArray< double > QwtLinearColorMap::colorStops () const"
221
 
.PP
222
 
Return all positions of color stops in increasing order 
223
 
.PP
224
 
Definition at line 328 of file qwt_color_map.cpp.
225
 
.SS "QColor QwtLinearColorMap::color1 () const"
226
 
.PP
227
 
\fBReturns:\fP
228
 
.RS 4
229
 
the first color of the color range 
230
 
.RE
231
 
.PP
232
 
\fBSee also:\fP
233
 
.RS 4
234
 
\fBsetColorInterval()\fP 
235
 
.RE
236
 
.PP
237
 
 
238
 
.PP
239
 
Definition at line 337 of file qwt_color_map.cpp.
240
 
.SS "QColor QwtLinearColorMap::color2 () const"
241
 
.PP
242
 
\fBReturns:\fP
243
 
.RS 4
244
 
the second color of the color range 
245
 
.RE
246
 
.PP
247
 
\fBSee also:\fP
248
 
.RS 4
249
 
\fBsetColorInterval()\fP 
250
 
.RE
251
 
.PP
252
 
 
253
 
.PP
254
 
Definition at line 346 of file qwt_color_map.cpp.
255
 
.SS "QRgb QwtLinearColorMap::rgb (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [virtual]\fP"
256
 
.PP
257
 
Map a value of a given interval into a rgb value
258
 
.PP
259
 
\fBParameters:\fP
260
 
.RS 4
261
 
\fIinterval\fP Range for all values 
262
 
.br
263
 
\fIvalue\fP Value to map into a rgb value 
264
 
.RE
265
 
.PP
266
 
 
267
 
.PP
268
 
Implements \fBQwtColorMap\fP.
269
 
.PP
270
 
Definition at line 357 of file qwt_color_map.cpp.
271
 
.PP
272
 
References QwtDoubleInterval::minValue(), and QwtDoubleInterval::width().
273
 
.SS "unsigned char QwtLinearColorMap::colorIndex (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [virtual]\fP"
274
 
.PP
275
 
Map a value of a given interval into a color index, between 0 and 255
276
 
.PP
277
 
\fBParameters:\fP
278
 
.RS 4
279
 
\fIinterval\fP Range for all values 
280
 
.br
281
 
\fIvalue\fP Value to map into a color index 
282
 
.RE
283
 
.PP
284
 
 
285
 
.PP
286
 
Implements \fBQwtColorMap\fP.
287
 
.PP
288
 
Definition at line 375 of file qwt_color_map.cpp.
289
 
.PP
290
 
References QwtDoubleInterval::maxValue(), QwtDoubleInterval::minValue(), and QwtDoubleInterval::width().
291
 
 
292
 
.SH "Author"
293
 
.PP 
294
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.