← 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/QwtScaleMap.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtScaleMap.3
 
1
.TH "QwtScaleMap" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtScaleMap \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
.SH "Detailed Description"
 
10
.PP 
 
11
A scale map. 
 
12
 
 
13
\fBQwtScaleMap\fP offers transformations from a scale into a paint interval and vice versa. 
 
14
.PP
 
15
Definition at line 55 of file qwt_scale_map.h.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtScaleMap\fP ()"
 
21
.br
 
22
.ti -1c
 
23
.RI "\fBQwtScaleMap\fP (const \fBQwtScaleMap\fP &)"
 
24
.br
 
25
.ti -1c
 
26
.RI "\fB~QwtScaleMap\fP ()"
 
27
.br
 
28
.ti -1c
 
29
.RI "\fBQwtScaleMap\fP & \fBoperator=\fP (const \fBQwtScaleMap\fP &)"
 
30
.br
 
31
.ti -1c
 
32
.RI "void \fBsetTransformation\fP (\fBQwtScaleTransformation\fP *)"
 
33
.br
 
34
.ti -1c
 
35
.RI "const \fBQwtScaleTransformation\fP * \fBtransformation\fP () const"
 
36
.br
 
37
.ti -1c
 
38
.RI "void \fBsetPaintInterval\fP (int p1, int p2)"
 
39
.br
 
40
.ti -1c
 
41
.RI "void \fBsetPaintXInterval\fP (double p1, double p2)"
 
42
.br
 
43
.ti -1c
 
44
.RI "void \fBsetScaleInterval\fP (double s1, double s2)"
 
45
.br
 
46
.ti -1c
 
47
.RI "int \fBtransform\fP (double x) const"
 
48
.br
 
49
.ti -1c
 
50
.RI "double \fBinvTransform\fP (double i) const"
 
51
.br
 
52
.ti -1c
 
53
.RI "double \fBxTransform\fP (double x) const"
 
54
.br
 
55
.ti -1c
 
56
.RI "double \fBp1\fP () const"
 
57
.br
 
58
.ti -1c
 
59
.RI "double \fBp2\fP () const"
 
60
.br
 
61
.ti -1c
 
62
.RI "double \fBs1\fP () const"
 
63
.br
 
64
.ti -1c
 
65
.RI "double \fBs2\fP () const"
 
66
.br
 
67
.ti -1c
 
68
.RI "double \fBpDist\fP () const"
 
69
.br
 
70
.ti -1c
 
71
.RI "double \fBsDist\fP () const"
 
72
.br
 
73
.in -1c
 
74
.SS "Public Attributes"
 
75
 
 
76
.in +1c
 
77
.ti -1c
 
78
.RI "QT_STATIC_CONST double \fBLogMin\fP"
 
79
.br
 
80
.ti -1c
 
81
.RI "QT_STATIC_CONST double \fBLogMax\fP"
 
82
.br
 
83
.in -1c
 
84
.SH "Constructor & Destructor Documentation"
 
85
.PP 
 
86
.SS "QwtScaleMap::QwtScaleMap ()"
 
87
.PP
 
88
Constructor. 
 
89
.PP
 
90
The scale and paint device intervals are both set to [0,1]. 
 
91
.PP
 
92
Definition at line 84 of file qwt_scale_map.cpp.
 
93
.SS "QwtScaleMap::~QwtScaleMap ()"
 
94
.PP
 
95
Destructor 
 
96
.PP
 
97
Definition at line 108 of file qwt_scale_map.cpp.
 
98
.SH "Member Function Documentation"
 
99
.PP 
 
100
.SS "void QwtScaleMap::setTransformation (\fBQwtScaleTransformation\fP * transformation)"
 
101
.PP
 
102
Initialize the map with a transformation 
 
103
.PP
 
104
Definition at line 130 of file qwt_scale_map.cpp.
 
105
.PP
 
106
References setScaleInterval(), and transformation().
 
107
.PP
 
108
Referenced by QwtPlot::canvasMap().
 
109
.SS "const \fBQwtScaleTransformation\fP * QwtScaleMap::transformation () const"
 
110
.PP
 
111
Get the transformation. 
 
112
.PP
 
113
Definition at line 142 of file qwt_scale_map.cpp.
 
114
.PP
 
115
Referenced by QwtPlotScaleItem::draw(), QwtScaleWidget::setScaleDiv(), and setTransformation().
 
116
.SS "void QwtScaleMap::setPaintInterval (int p1, int p2)"
 
117
.PP
 
118
Specify the borders of the paint device interval. 
 
119
.PP
 
120
\fBParameters:\fP
 
121
.RS 4
 
122
\fIp1\fP first border 
 
123
.br
 
124
\fIp2\fP second border 
 
125
.RE
 
126
.PP
 
127
 
 
128
.PP
 
129
Definition at line 180 of file qwt_scale_map.cpp.
 
130
.PP
 
131
References QwtScaleTransformation::type().
 
132
.PP
 
133
Referenced by QwtPlot::canvasMap(), QwtPlotRasterItem::draw(), QwtPainter::drawColorBar(), QwtRoundScaleDraw::QwtRoundScaleDraw(), QwtPlotSpectrogram::renderImage(), QwtRoundScaleDraw::setAngleRange(), and QwtPlotSvgItem::viewBox().
 
134
.SS "void QwtScaleMap::setPaintXInterval (double p1, double p2)"
 
135
.PP
 
136
Specify the borders of the paint device interval. 
 
137
.PP
 
138
\fBParameters:\fP
 
139
.RS 4
 
140
\fIp1\fP first border 
 
141
.br
 
142
\fIp2\fP second border 
 
143
.RE
 
144
.PP
 
145
 
 
146
.PP
 
147
Definition at line 194 of file qwt_scale_map.cpp.
 
148
.PP
 
149
References QwtScaleTransformation::type().
 
150
.PP
 
151
Referenced by QwtPlot::print().
 
152
.SS "void QwtScaleMap::setScaleInterval (double s1, double s2)"
 
153
.PP
 
154
Specify the borders of the scale interval. 
 
155
.PP
 
156
\fBParameters:\fP
 
157
.RS 4
 
158
\fIs1\fP first border 
 
159
.br
 
160
\fIs2\fP second border 
 
161
.RE
 
162
.PP
 
163
\fBWarning:\fP
 
164
.RS 4
 
165
logarithmic scales might be aligned to [LogMin, LogMax] 
 
166
.RE
 
167
.PP
 
168
 
 
169
.PP
 
170
Definition at line 153 of file qwt_scale_map.cpp.
 
171
.PP
 
172
References LogMax, LogMin, and QwtScaleTransformation::type().
 
173
.PP
 
174
Referenced by QwtPlot::canvasMap(), QwtPlot::print(), QwtPlotSpectrogram::renderImage(), setTransformation(), and QwtPlotSvgItem::viewBox().
 
175
.SS "int QwtScaleMap::transform (double s) const\fC [inline]\fP"
 
176
.PP
 
177
Transform a point related to the scale interval into an point related to the interval of the paint device and round it to an integer. (In Qt <= 3.x paint devices are integer based. )
 
178
.PP
 
179
\fBSee also:\fP
 
180
.RS 4
 
181
\fBQwtScaleMap::xTransform\fP 
 
182
.RE
 
183
.PP
 
184
 
 
185
.PP
 
186
Definition at line 175 of file qwt_scale_map.h.
 
187
.PP
 
188
References xTransform().
 
189
.PP
 
190
Referenced by QwtPlotCurve::closePolyline(), QwtPlotScaleItem::draw(), QwtPlotMarker::draw(), QwtPlotSpectrogram::drawContourLines(), QwtPlotCurve::drawDots(), QwtRoundScaleDraw::drawLabel(), QwtPlotCurve::drawLines(), QwtPlotCurve::drawSteps(), QwtPlotCurve::drawSticks(), QwtPlotCurve::drawSymbols(), QwtRoundScaleDraw::drawTick(), QwtRoundScaleDraw::extent(), QwtScaleDraw::labelPosition(), QwtPlotPanner::moveCanvas(), QwtPlotPicker::transform(), and QwtPlotItem::transform().
 
191
.SS "double QwtScaleMap::invTransform (double i) const\fC [inline]\fP"
 
192
.PP
 
193
Transform an paint device value into a value in the interval of the scale. 
 
194
.PP
 
195
Definition at line 163 of file qwt_scale_map.h.
 
196
.PP
 
197
References QwtScaleTransformation::invXForm().
 
198
.PP
 
199
Referenced by QwtPainter::drawColorBar(), QwtPlotPicker::invTransform(), QwtPlotItem::invTransform(), and QwtPlotSpectrogram::renderImage().
 
200
.SS "double QwtScaleMap::xTransform (double s) const\fC [inline]\fP"
 
201
.PP
 
202
Transform a point related to the scale interval into an point related to the interval of the paint device 
 
203
.PP
 
204
Definition at line 146 of file qwt_scale_map.h.
 
205
.PP
 
206
References QwtScaleTransformation::type(), and QwtScaleTransformation::xForm().
 
207
.PP
 
208
Referenced by QwtPlotCurve::closestPoint(), QwtPlotCurve::drawLines(), transform(), and QwtPlotSvgItem::viewBox().
 
209
.SS "double QwtScaleMap::p1 () const\fC [inline]\fP"
 
210
.PP
 
211
\fBReturns:\fP
 
212
.RS 4
 
213
First border of the paint interval 
 
214
.RE
 
215
.PP
 
216
 
 
217
.PP
 
218
Definition at line 119 of file qwt_scale_map.h.
 
219
.PP
 
220
Referenced by QwtPlotItem::paintRect(), and QwtPlotSpectrogram::renderImage().
 
221
.SS "double QwtScaleMap::p2 () const\fC [inline]\fP"
 
222
.PP
 
223
\fBReturns:\fP
 
224
.RS 4
 
225
Second border of the paint interval 
 
226
.RE
 
227
.PP
 
228
 
 
229
.PP
 
230
Definition at line 127 of file qwt_scale_map.h.
 
231
.PP
 
232
Referenced by QwtPlotSpectrogram::renderImage().
 
233
.SS "double QwtScaleMap::s1 () const\fC [inline]\fP"
 
234
.PP
 
235
\fBReturns:\fP
 
236
.RS 4
 
237
First border of the scale interval 
 
238
.RE
 
239
.PP
 
240
 
 
241
.PP
 
242
Definition at line 103 of file qwt_scale_map.h.
 
243
.PP
 
244
Referenced by QwtPlotSpectrogram::renderImage(), and QwtPlotItem::scaleRect().
 
245
.SS "double QwtScaleMap::s2 () const\fC [inline]\fP"
 
246
.PP
 
247
\fBReturns:\fP
 
248
.RS 4
 
249
Second border of the scale interval 
 
250
.RE
 
251
.PP
 
252
 
 
253
.PP
 
254
Definition at line 111 of file qwt_scale_map.h.
 
255
.PP
 
256
Referenced by QwtPlotSpectrogram::renderImage().
 
257
 
 
258
.SH "Author"
 
259
.PP 
 
260
Generated automatically by Doxygen for Qwt User's Guide from the source code.