← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2007-10-05 15:20:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071005152041-qmybqh4fj9jejyo2
Tags: 5.0.2-2
http://bugs.debian.org/437877
http://bugs.debian.org/443110
* Handle nostrip build option. (Closes: #437877)
* Build libqwt5-doc package in binary-indep target. (Closes: #443110)

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.0.1/doc/man/man3/QwtLinearColorMap.3
1
 
.TH "QwtLinearColorMap" 3 "26 Feb 2007" "Version 5.0.1" "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 }"
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 "void QwtLinearColorMap::addColorStop (double value, const QColor & color)"
137
 
.PP
138
 
Add a color stop
139
 
.PP
140
 
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)
141
 
.PP
142
 
\fBParameters:\fP
143
 
.RS 4
144
 
\fIvalue\fP Value between [0.0, 1.0] 
145
 
.br
146
 
\fIcolor\fP Color stop 
147
 
.RE
148
 
.PP
149
 
 
150
 
.PP
151
 
Definition at line 319 of file qwt_color_map.cpp.
152
 
.SS "QColor QwtLinearColorMap::color1 () const"
153
 
.PP
154
 
\fBReturns:\fP
155
 
.RS 4
156
 
the first color of the color range 
157
 
.RE
158
 
.PP
159
 
\fBSee also:\fP
160
 
.RS 4
161
 
\fBsetColorInterval()\fP 
162
 
.RE
163
 
.PP
164
 
 
165
 
.PP
166
 
Definition at line 337 of file qwt_color_map.cpp.
167
 
.SS "QColor QwtLinearColorMap::color2 () const"
168
 
.PP
169
 
\fBReturns:\fP
170
 
.RS 4
171
 
the second color of the color range 
172
 
.RE
173
 
.PP
174
 
\fBSee also:\fP
175
 
.RS 4
176
 
\fBsetColorInterval()\fP 
177
 
.RE
178
 
.PP
179
 
 
180
 
.PP
181
 
Definition at line 346 of file qwt_color_map.cpp.
182
 
.SS "unsigned char QwtLinearColorMap::colorIndex (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [virtual]\fP"
183
 
.PP
184
 
Map a value of a given interval into a color index, between 0 and 255
185
 
.PP
186
 
\fBParameters:\fP
187
 
.RS 4
188
 
\fIinterval\fP Range for all values 
189
 
.br
190
 
\fIvalue\fP Value to map into a color index 
191
 
.RE
192
 
.PP
193
 
 
194
 
.PP
195
 
Implements \fBQwtColorMap\fP.
196
 
.PP
197
 
Definition at line 370 of file qwt_color_map.cpp.
198
 
.PP
199
 
References QwtDoubleInterval::isValid(), QwtDoubleInterval::maxValue(), QwtDoubleInterval::minValue(), and QwtDoubleInterval::width().
200
 
.SS "QwtArray< double > QwtLinearColorMap::colorStops () const"
201
 
.PP
202
 
Return all positions of color stops in increasing order 
203
 
.PP
204
 
Definition at line 328 of file qwt_color_map.cpp.
205
 
.SS "\fBQwtColorMap\fP * QwtLinearColorMap::copy () const\fC [virtual]\fP"
206
 
.PP
207
 
Clone the color map. 
208
 
.PP
209
 
Implements \fBQwtColorMap\fP.
210
 
.PP
211
 
Definition at line 260 of file qwt_color_map.cpp.
212
 
.PP
213
 
References QwtLinearColorMap().
214
 
.SS "\fBQwtLinearColorMap::Mode\fP QwtLinearColorMap::mode () const"
215
 
.PP
216
 
\fBReturns:\fP
217
 
.RS 4
218
 
Mode of the color map 
219
 
.RE
220
 
.PP
221
 
\fBSee also:\fP
222
 
.RS 4
223
 
\fBsetMode()\fP 
224
 
.RE
225
 
.PP
226
 
 
227
 
.PP
228
 
Definition at line 286 of file qwt_color_map.cpp.
229
 
.SS "\fBQwtLinearColorMap\fP & QwtLinearColorMap::operator= (const \fBQwtLinearColorMap\fP &)"
230
 
.PP
231
 
Assignment operator. 
232
 
.PP
233
 
Definition at line 251 of file qwt_color_map.cpp.
234
 
.PP
235
 
References d_data.
236
 
.SS "QRgb QwtLinearColorMap::rgb (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [virtual]\fP"
237
 
.PP
238
 
Map a value of a given interval into a rgb value
239
 
.PP
240
 
\fBParameters:\fP
241
 
.RS 4
242
 
\fIinterval\fP Range for all values 
243
 
.br
244
 
\fIvalue\fP Value to map into a rgb value 
245
 
.RE
246
 
.PP
247
 
 
248
 
.PP
249
 
Implements \fBQwtColorMap\fP.
250
 
.PP
251
 
Definition at line 357 of file qwt_color_map.cpp.
252
 
.PP
253
 
References QwtDoubleInterval::minValue(), and QwtDoubleInterval::width().
254
 
.SS "void QwtLinearColorMap::setColorInterval (const QColor & color1, const QColor & color2)"
255
 
.PP
256
 
Set the color range
257
 
.PP
258
 
Add stops at 0.0 and 1.0.
259
 
.PP
260
 
\fBParameters:\fP
261
 
.RS 4
262
 
\fIcolor1\fP Color used for the minimum value of the value interval 
263
 
.br
264
 
\fIcolor2\fP Color used for the maximum value of the value interval
265
 
.RE
266
 
.PP
267
 
\fBSee also:\fP
268
 
.RS 4
269
 
\fBcolor1()\fP, \fBcolor2()\fP 
270
 
.RE
271
 
.PP
272
 
 
273
 
.PP
274
 
Definition at line 301 of file qwt_color_map.cpp.
275
 
.PP
276
 
Referenced by QwtLinearColorMap().
277
 
.SS "void QwtLinearColorMap::setMode (\fBMode\fP mode)"
278
 
.PP
279
 
Set the mode of the color map. 
280
 
.PP
281
 
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.
282
 
.PP
283
 
\fBSee also:\fP
284
 
.RS 4
285
 
\fBmode()\fP 
286
 
.RE
287
 
.PP
288
 
 
289
 
.PP
290
 
Definition at line 277 of file qwt_color_map.cpp.
291
 
 
292
 
.SH "Author"
293
 
.PP 
294
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.