← Back to branch summary

~l3on/ubuntu/oneiric/qwt/fix-921430

« back to all changes in this revision

Viewing changes to qwt-5.0.1/doc/man/man3/QwtPlotRasterItem.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/QwtPlotRasterItem.3
1
 
.TH "QwtPlotRasterItem" 3 "26 Feb 2007" "Version 5.0.1" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtPlotRasterItem \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtPlotItem\fP.
10
 
.PP
11
 
Inherited by \fBQwtPlotSpectrogram\fP.
12
 
.PP
13
 
.SH "Detailed Description"
14
 
.PP 
15
 
A class, which displays raster data. 
16
 
 
17
 
Raster data is a grid of pixel values, that can be represented as a QImage. It is used for many types of information like spectrograms, cartograms, geographical maps ...
18
 
.PP
19
 
Often a plot has several types of raster data organized in layers. ( f.e a geographical map, with weather statistics ). Using \fBsetAlpha()\fP raster items can be stacked easily.
20
 
.PP
21
 
\fBQwtPlotRasterItem\fP is only implemented for images of the following formats: QImage::Format_Indexed8, QImage::Format_ARGB32.
22
 
.PP
23
 
\fBSee also:\fP
24
 
.RS 4
25
 
\fBQwtPlotSpectrogram\fP 
26
 
.RE
27
 
.PP
28
 
 
29
 
.PP
30
 
Definition at line 36 of file qwt_plot_rasteritem.h.
31
 
.SS "Public Types"
32
 
 
33
 
.in +1c
34
 
.ti -1c
35
 
.RI "enum \fBCachePolicy\fP { \fBNoCache\fP, \fBPaintCache\fP, \fBScreenCache\fP }"
36
 
.br
37
 
.in -1c
38
 
.SS "Public Member Functions"
39
 
 
40
 
.in +1c
41
 
.ti -1c
42
 
.RI "\fBQwtPlotRasterItem\fP (const QString &title=QString::null)"
43
 
.br
44
 
.ti -1c
45
 
.RI "\fBQwtPlotRasterItem\fP (const \fBQwtText\fP &title)"
46
 
.br
47
 
.ti -1c
48
 
.RI "virtual \fB~QwtPlotRasterItem\fP ()"
49
 
.br
50
 
.ti -1c
51
 
.RI "void \fBsetAlpha\fP (int alpha)"
52
 
.br
53
 
.ti -1c
54
 
.RI "int \fBalpha\fP () const "
55
 
.br
56
 
.ti -1c
57
 
.RI "void \fBsetCachePolicy\fP (\fBCachePolicy\fP)"
58
 
.br
59
 
.ti -1c
60
 
.RI "\fBCachePolicy\fP \fBcachePolicy\fP () const "
61
 
.br
62
 
.ti -1c
63
 
.RI "void \fBinvalidateCache\fP ()"
64
 
.br
65
 
.ti -1c
66
 
.RI "virtual void \fBdraw\fP (QPainter *p, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRect &rect) const "
67
 
.br
68
 
.ti -1c
69
 
.RI "virtual QSize \fBrasterHint\fP (const QwtDoubleRect &) const "
70
 
.br
71
 
.in -1c
72
 
.SS "Protected Member Functions"
73
 
 
74
 
.in +1c
75
 
.ti -1c
76
 
.RI "virtual QImage \fBrenderImage\fP (const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QwtDoubleRect &area) const =0"
77
 
.br
78
 
.in -1c
79
 
.SH "Member Enumeration Documentation"
80
 
.PP 
81
 
.SS "enum \fBQwtPlotRasterItem::CachePolicy\fP"
82
 
.PP
83
 
.IP "\(bu" 2
84
 
NoCache
85
 
.br
86
 
 \fBrenderImage()\fP is called, whenever the item has to be repainted
87
 
.IP "\(bu" 2
88
 
PaintCache
89
 
.br
90
 
 \fBrenderImage()\fP is called, whenever the image cache is not valid, or the scales, or the size of the canvas has changed. This type of cache is only useful for improving the performance of hide/show operations. All other situations are already handled by the plot canvas cache.
91
 
.IP "\(bu" 2
92
 
ScreenCache
93
 
.br
94
 
 The screen cache is an image in size of the screen. As long as the scales don't change the target image is scaled from the cache. This might improve the performance when resizing the plot widget, but suffers from scaling effects.
95
 
.PP
96
 
.PP
97
 
The default policy is NoCache 
98
 
.PP
99
 
Definition at line 56 of file qwt_plot_rasteritem.h.
100
 
.SH "Constructor & Destructor Documentation"
101
 
.PP 
102
 
.SS "QwtPlotRasterItem::QwtPlotRasterItem (const QString & title = \fCQString::null\fP)\fC [explicit]\fP"
103
 
.PP
104
 
Constructor. 
105
 
.PP
106
 
Definition at line 91 of file qwt_plot_rasteritem.cpp.
107
 
.SS "QwtPlotRasterItem::QwtPlotRasterItem (const \fBQwtText\fP & title)\fC [explicit]\fP"
108
 
.PP
109
 
Constructor. 
110
 
.PP
111
 
Definition at line 98 of file qwt_plot_rasteritem.cpp.
112
 
.SS "QwtPlotRasterItem::~QwtPlotRasterItem ()\fC [virtual]\fP"
113
 
.PP
114
 
Destructor. 
115
 
.PP
116
 
Definition at line 105 of file qwt_plot_rasteritem.cpp.
117
 
.SH "Member Function Documentation"
118
 
.PP 
119
 
.SS "int QwtPlotRasterItem::alpha () const"
120
 
.PP
121
 
\fBReturns:\fP
122
 
.RS 4
123
 
Alpha value of the raster item 
124
 
.RE
125
 
.PP
126
 
\fBSee also:\fP
127
 
.RS 4
128
 
\fBsetAlpha()\fP 
129
 
.RE
130
 
.PP
131
 
 
132
 
.PP
133
 
Definition at line 163 of file qwt_plot_rasteritem.cpp.
134
 
.SS "\fBQwtPlotRasterItem::CachePolicy\fP QwtPlotRasterItem::cachePolicy () const"
135
 
.PP
136
 
\fBReturns:\fP
137
 
.RS 4
138
 
Cache policy 
139
 
.RE
140
 
.PP
141
 
\fBSee also:\fP
142
 
.RS 4
143
 
\fBCachePolicy\fP, \fBsetCachePolicy()\fP 
144
 
.RE
145
 
.PP
146
 
 
147
 
.PP
148
 
Definition at line 192 of file qwt_plot_rasteritem.cpp.
149
 
.SS "void QwtPlotRasterItem::draw (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRect & canvasRect) const\fC [virtual]\fP"
150
 
.PP
151
 
Draw the raster data. 
152
 
.PP
153
 
\fBParameters:\fP
154
 
.RS 4
155
 
\fIpainter\fP Painter 
156
 
.br
157
 
\fIxMap\fP X-Scale Map 
158
 
.br
159
 
\fIyMap\fP Y-Scale Map 
160
 
.br
161
 
\fIcanvasRect\fP Contents rect of the plot canvas 
162
 
.RE
163
 
.PP
164
 
 
165
 
.PP
166
 
Implements \fBQwtPlotItem\fP.
167
 
.PP
168
 
Reimplemented in \fBQwtPlotSpectrogram\fP.
169
 
.PP
170
 
Definition at line 229 of file qwt_plot_rasteritem.cpp.
171
 
.PP
172
 
References QwtPlotItem::boundingRect(), QwtPlotItem::invTransform(), QwtPlotItem::paintRect(), and QwtPlotItem::transform().
173
 
.PP
174
 
Referenced by QwtPlotSpectrogram::draw().
175
 
.SS "void QwtPlotRasterItem::invalidateCache ()"
176
 
.PP
177
 
Invalidate the paint cache 
178
 
.PP
179
 
\fBSee also:\fP
180
 
.RS 4
181
 
\fBsetCachePolicy\fP 
182
 
.RE
183
 
.PP
184
 
 
185
 
.PP
186
 
Definition at line 201 of file qwt_plot_rasteritem.cpp.
187
 
.PP
188
 
Referenced by setCachePolicy(), QwtPlotSpectrogram::setColorMap(), and QwtPlotSpectrogram::setData().
189
 
.SS "QSize QwtPlotRasterItem::rasterHint (const QwtDoubleRect &) const\fC [virtual]\fP"
190
 
.PP
191
 
Returns the recommended raster for a given rect. 
192
 
.PP
193
 
F.e the raster hint can be used to limit the resolution of the image that is rendered.
194
 
.PP
195
 
The default implementation returns an invalid size (QSize()), what means: no hint. 
196
 
.PP
197
 
Reimplemented in \fBQwtPlotSpectrogram\fP.
198
 
.PP
199
 
Definition at line 217 of file qwt_plot_rasteritem.cpp.
200
 
.SS "virtual QImage QwtPlotRasterItem::renderImage (const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QwtDoubleRect & area) const\fC [protected, pure virtual]\fP"
201
 
.PP
202
 
Renders an image for an area
203
 
.PP
204
 
The format of the image must be QImage::Format_Indexed8, QImage::Format_RGB32 or QImage::Format_ARGB32
205
 
.PP
206
 
\fBParameters:\fP
207
 
.RS 4
208
 
\fIxMap\fP Maps x-values into pixel coordinates. 
209
 
.br
210
 
\fIyMap\fP Maps y-values into pixel coordinates. 
211
 
.br
212
 
\fIarea\fP Requested area for the image in scale coordinates 
213
 
.RE
214
 
.PP
215
 
 
216
 
.PP
217
 
Implemented in \fBQwtPlotSpectrogram\fP.
218
 
.SS "void QwtPlotRasterItem::setAlpha (int alpha)"
219
 
.PP
220
 
Set an alpha value for the raster data. 
221
 
.PP
222
 
Often a plot has several types of raster data organized in layers. ( f.e a geographical map, with weather statistics ). Using \fBsetAlpha()\fP raster items can be stacked easily.
223
 
.PP
224
 
The alpha value is a value [0, 255] to control the transparency of the image. 0 represents a fully transparent color, while 255 represents a fully opaque color.
225
 
.PP
226
 
\fBParameters:\fP
227
 
.RS 4
228
 
\fIalpha\fP Alpha value
229
 
.RE
230
 
.PP
231
 
.IP "\(bu" 2
232
 
alpha >= 0
233
 
.br
234
 
 All alpha values of the pixels returned by \fBrenderImage()\fP will be set to alpha, beside those with an alpha value of 0 (invalid pixels).
235
 
.IP "\(bu" 2
236
 
alpha < 0 The alpha values returned by \fBrenderImage()\fP are not changed.
237
 
.PP
238
 
.PP
239
 
The default alpha value is -1.
240
 
.PP
241
 
\fBSee also:\fP
242
 
.RS 4
243
 
\fBalpha()\fP 
244
 
.RE
245
 
.PP
246
 
 
247
 
.PP
248
 
Definition at line 143 of file qwt_plot_rasteritem.cpp.
249
 
.PP
250
 
References QwtPlotItem::itemChanged().
251
 
.SS "void QwtPlotRasterItem::setCachePolicy (\fBQwtPlotRasterItem::CachePolicy\fP policy)"
252
 
.PP
253
 
Change the cache policy
254
 
.PP
255
 
The default policy is NoCache
256
 
.PP
257
 
\fBParameters:\fP
258
 
.RS 4
259
 
\fIpolicy\fP Cache policy 
260
 
.RE
261
 
.PP
262
 
\fBSee also:\fP
263
 
.RS 4
264
 
\fBCachePolicy\fP, \fBcachePolicy()\fP 
265
 
.RE
266
 
.PP
267
 
 
268
 
.PP
269
 
Definition at line 176 of file qwt_plot_rasteritem.cpp.
270
 
.PP
271
 
References invalidateCache(), and QwtPlotItem::itemChanged().
272
 
 
273
 
.SH "Author"
274
 
.PP 
275
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.