← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.1/doc/man/man3/QwtPlotRasterItem.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.1/doc/man/man3/QwtPlotRasterItem.3
 
1
.TH "QwtPlotRasterItem" 3 "24 May 2008" "Version 5.1.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 \fBQwtDoubleRect\fP &) 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 \fBQwtDoubleRect\fP &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 "void QwtPlotRasterItem::setAlpha (int alpha)"
 
120
.PP
 
121
Set an alpha value for the raster data. 
 
122
.PP
 
123
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.
 
124
.PP
 
125
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.
 
126
.PP
 
127
\fBParameters:\fP
 
128
.RS 4
 
129
\fIalpha\fP Alpha value
 
130
.RE
 
131
.PP
 
132
.IP "\(bu" 2
 
133
alpha >= 0
 
134
.br
 
135
 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).
 
136
.IP "\(bu" 2
 
137
alpha < 0 The alpha values returned by \fBrenderImage()\fP are not changed.
 
138
.PP
 
139
.PP
 
140
The default alpha value is -1.
 
141
.PP
 
142
\fBSee also:\fP
 
143
.RS 4
 
144
\fBalpha()\fP 
 
145
.RE
 
146
.PP
 
147
 
 
148
.PP
 
149
Definition at line 143 of file qwt_plot_rasteritem.cpp.
 
150
.PP
 
151
References QwtPlotItem::itemChanged().
 
152
.SS "int QwtPlotRasterItem::alpha () const"
 
153
.PP
 
154
\fBReturns:\fP
 
155
.RS 4
 
156
Alpha value of the raster item 
 
157
.RE
 
158
.PP
 
159
\fBSee also:\fP
 
160
.RS 4
 
161
\fBsetAlpha()\fP 
 
162
.RE
 
163
.PP
 
164
 
 
165
.PP
 
166
Definition at line 163 of file qwt_plot_rasteritem.cpp.
 
167
.SS "void QwtPlotRasterItem::setCachePolicy (\fBQwtPlotRasterItem::CachePolicy\fP policy)"
 
168
.PP
 
169
Change the cache policy
 
170
.PP
 
171
The default policy is NoCache
 
172
.PP
 
173
\fBParameters:\fP
 
174
.RS 4
 
175
\fIpolicy\fP Cache policy 
 
176
.RE
 
177
.PP
 
178
\fBSee also:\fP
 
179
.RS 4
 
180
\fBCachePolicy\fP, \fBcachePolicy()\fP 
 
181
.RE
 
182
.PP
 
183
 
 
184
.PP
 
185
Definition at line 176 of file qwt_plot_rasteritem.cpp.
 
186
.PP
 
187
References invalidateCache(), and QwtPlotItem::itemChanged().
 
188
.SS "\fBQwtPlotRasterItem::CachePolicy\fP QwtPlotRasterItem::cachePolicy () const"
 
189
.PP
 
190
\fBReturns:\fP
 
191
.RS 4
 
192
Cache policy 
 
193
.RE
 
194
.PP
 
195
\fBSee also:\fP
 
196
.RS 4
 
197
\fBCachePolicy\fP, \fBsetCachePolicy()\fP 
 
198
.RE
 
199
.PP
 
200
 
 
201
.PP
 
202
Definition at line 192 of file qwt_plot_rasteritem.cpp.
 
203
.SS "void QwtPlotRasterItem::invalidateCache ()"
 
204
.PP
 
205
Invalidate the paint cache 
 
206
.PP
 
207
\fBSee also:\fP
 
208
.RS 4
 
209
\fBsetCachePolicy\fP 
 
210
.RE
 
211
.PP
 
212
 
 
213
.PP
 
214
Definition at line 201 of file qwt_plot_rasteritem.cpp.
 
215
.PP
 
216
Referenced by setCachePolicy(), QwtPlotSpectrogram::setColorMap(), and QwtPlotSpectrogram::setData().
 
217
.SS "void QwtPlotRasterItem::draw (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRect & canvasRect) const\fC [virtual]\fP"
 
218
.PP
 
219
Draw the raster data. 
 
220
.PP
 
221
\fBParameters:\fP
 
222
.RS 4
 
223
\fIpainter\fP Painter 
 
224
.br
 
225
\fIxMap\fP X-Scale Map 
 
226
.br
 
227
\fIyMap\fP Y-Scale Map 
 
228
.br
 
229
\fIcanvasRect\fP Contents rect of the plot canvas 
 
230
.RE
 
231
.PP
 
232
 
 
233
.PP
 
234
Implements \fBQwtPlotItem\fP.
 
235
.PP
 
236
Reimplemented in \fBQwtPlotSpectrogram\fP.
 
237
.PP
 
238
Definition at line 229 of file qwt_plot_rasteritem.cpp.
 
239
.PP
 
240
References QwtPlotItem::boundingRect(), QwtPlotItem::invTransform(), QwtPlotItem::paintRect(), renderImage(), QwtScaleMap::setPaintInterval(), and QwtPlotItem::transform().
 
241
.PP
 
242
Referenced by QwtPlotSpectrogram::draw().
 
243
.SS "QSize QwtPlotRasterItem::rasterHint (const \fBQwtDoubleRect\fP &) const\fC [virtual]\fP"
 
244
.PP
 
245
Returns the recommended raster for a given rect. 
 
246
.PP
 
247
F.e the raster hint can be used to limit the resolution of the image that is rendered.
 
248
.PP
 
249
The default implementation returns an invalid size (QSize()), what means: no hint. 
 
250
.PP
 
251
Reimplemented in \fBQwtPlotSpectrogram\fP.
 
252
.PP
 
253
Definition at line 217 of file qwt_plot_rasteritem.cpp.
 
254
.SS "virtual QImage QwtPlotRasterItem::renderImage (const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const \fBQwtDoubleRect\fP & area) const\fC [protected, pure virtual]\fP"
 
255
.PP
 
256
Renders an image for an area
 
257
.PP
 
258
The format of the image must be QImage::Format_Indexed8, QImage::Format_RGB32 or QImage::Format_ARGB32
 
259
.PP
 
260
\fBParameters:\fP
 
261
.RS 4
 
262
\fIxMap\fP Maps x-values into pixel coordinates. 
 
263
.br
 
264
\fIyMap\fP Maps y-values into pixel coordinates. 
 
265
.br
 
266
\fIarea\fP Requested area for the image in scale coordinates 
 
267
.RE
 
268
.PP
 
269
 
 
270
.PP
 
271
Implemented in \fBQwtPlotSpectrogram\fP.
 
272
.PP
 
273
Referenced by draw().
 
274
 
 
275
.SH "Author"
 
276
.PP 
 
277
Generated automatically by Doxygen for Qwt User's Guide from the source code.