QwtPolarCurve.3 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588
  1. .TH "QwtPolarCurve" 3 "Fri Sep 19 2014" "Version 1.1.1" "Qwt Polar User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPolarCurve \-
  6. .PP
  7. An item, that represents a series of points\&.
  8. .SH SYNOPSIS
  9. .br
  10. .PP
  11. .PP
  12. \fC#include <qwt_polar_curve\&.h>\fP
  13. .PP
  14. Inherits \fBQwtPolarItem\fP\&.
  15. .SS "Public Types"
  16. .in +1c
  17. .ti -1c
  18. .RI "enum \fBCurveStyle\fP { \fBNoCurve\fP, \fBLines\fP, \fBUserCurve\fP = 100 }"
  19. .br
  20. .ti -1c
  21. .RI "enum \fBLegendAttribute\fP { \fBLegendShowLine\fP = 0x01, \fBLegendShowSymbol\fP = 0x02 }"
  22. .br
  23. .RI "\fIAttributes how to represent the curve on the legend\&. \fP"
  24. .ti -1c
  25. .RI "typedef QFlags< \fBLegendAttribute\fP > \fBLegendAttributes\fP"
  26. .br
  27. .RI "\fILegend attributes\&. \fP"
  28. .in -1c
  29. .SS "Public Member Functions"
  30. .in +1c
  31. .ti -1c
  32. .RI "\fBQwtPolarCurve\fP ()"
  33. .br
  34. .RI "\fIConstructor\&. \fP"
  35. .ti -1c
  36. .RI "\fBQwtPolarCurve\fP (const QwtText &\fBtitle\fP)"
  37. .br
  38. .ti -1c
  39. .RI "\fBQwtPolarCurve\fP (const QString &\fBtitle\fP)"
  40. .br
  41. .ti -1c
  42. .RI "virtual \fB~QwtPolarCurve\fP ()"
  43. .br
  44. .RI "\fIDestructor\&. \fP"
  45. .ti -1c
  46. .RI "virtual int \fBrtti\fP () const "
  47. .br
  48. .ti -1c
  49. .RI "void \fBsetLegendAttribute\fP (\fBLegendAttribute\fP, bool on=true)"
  50. .br
  51. .ti -1c
  52. .RI "bool \fBtestLegendAttribute\fP (\fBLegendAttribute\fP) const "
  53. .br
  54. .RI "\fITest if a lefend attribute is enables\&. \fP"
  55. .ti -1c
  56. .RI "void \fBsetData\fP (QwtSeriesData< QwtPointPolar > *\fBdata\fP)"
  57. .br
  58. .ti -1c
  59. .RI "const QwtSeriesData
  60. .br
  61. < QwtPointPolar > * \fBdata\fP () const "
  62. .br
  63. .ti -1c
  64. .RI "size_t \fBdataSize\fP () const "
  65. .br
  66. .ti -1c
  67. .RI "QwtPointPolar \fBsample\fP (int i) const "
  68. .br
  69. .ti -1c
  70. .RI "void \fBsetPen\fP (const QPen &)"
  71. .br
  72. .RI "\fIAssign a pen\&. \fP"
  73. .ti -1c
  74. .RI "const QPen & \fBpen\fP () const "
  75. .br
  76. .ti -1c
  77. .RI "void \fBsetStyle\fP (\fBCurveStyle\fP \fBstyle\fP)"
  78. .br
  79. .ti -1c
  80. .RI "\fBCurveStyle\fP \fBstyle\fP () const "
  81. .br
  82. .ti -1c
  83. .RI "void \fBsetSymbol\fP (QwtSymbol *)"
  84. .br
  85. .RI "\fIAssign a symbol\&. \fP"
  86. .ti -1c
  87. .RI "const QwtSymbol * \fBsymbol\fP () const "
  88. .br
  89. .ti -1c
  90. .RI "void \fBsetCurveFitter\fP (QwtCurveFitter *)"
  91. .br
  92. .RI "\fIInsert a curve fitter\&. \fP"
  93. .ti -1c
  94. .RI "QwtCurveFitter * \fBcurveFitter\fP () const "
  95. .br
  96. .ti -1c
  97. .RI "virtual void \fBdraw\fP (QPainter *p, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, double radius, const QRectF &canvasRect) const "
  98. .br
  99. .ti -1c
  100. .RI "virtual void \fBdraw\fP (QPainter *p, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, int from, int to) const "
  101. .br
  102. .RI "\fIDraw an interval of the curve\&. \fP"
  103. .ti -1c
  104. .RI "virtual QwtInterval \fBboundingInterval\fP (int scaleId) const "
  105. .br
  106. .ti -1c
  107. .RI "virtual QwtGraphic \fBlegendIcon\fP (int index, const QSizeF &) const "
  108. .br
  109. .in -1c
  110. .SS "Protected Member Functions"
  111. .in +1c
  112. .ti -1c
  113. .RI "void \fBinit\fP ()"
  114. .br
  115. .RI "\fIInitialize data members\&. \fP"
  116. .ti -1c
  117. .RI "virtual void \fBdrawCurve\fP (QPainter *, int \fBstyle\fP, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, int from, int to) const "
  118. .br
  119. .ti -1c
  120. .RI "virtual void \fBdrawSymbols\fP (QPainter *, const QwtSymbol &, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, int from, int to) const "
  121. .br
  122. .ti -1c
  123. .RI "void \fBdrawLines\fP (QPainter *, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, int from, int to) const "
  124. .br
  125. .in -1c
  126. .SH "Detailed Description"
  127. .PP
  128. An item, that represents a series of points\&.
  129. A curve is the representation of a series of points in polar coordinates\&. The points are connected to the curve using the abstract QwtData interface\&.
  130. .PP
  131. \fBSee Also:\fP
  132. .RS 4
  133. \fBQwtPolarPlot\fP, QwtSymbol, QwtScaleMap
  134. .RE
  135. .PP
  136. .SH "Member Enumeration Documentation"
  137. .PP
  138. .SS "enum \fBQwtPolarCurve::CurveStyle\fP"
  139. Curve styles\&.
  140. .PP
  141. \fBSee Also:\fP
  142. .RS 4
  143. \fBsetStyle()\fP, \fBstyle()\fP
  144. .RE
  145. .PP
  146. .PP
  147. \fBEnumerator\fP
  148. .in +1c
  149. .TP
  150. \fB\fINoCurve \fP\fP
  151. Don't draw a curve\&. Note: This doesn't affect the symbols\&.
  152. .TP
  153. \fB\fILines \fP\fP
  154. Connect the points with straight lines\&. The lines might be interpolated depending on the 'Fitted' attribute\&. Curve fitting can be configured using \fBsetCurveFitter()\fP\&.
  155. .TP
  156. \fB\fIUserCurve \fP\fP
  157. Values > 100 are reserved for user specific curve styles\&.
  158. .SS "enum \fBQwtPolarCurve::LegendAttribute\fP"
  159. .PP
  160. Attributes how to represent the curve on the legend\&. If none of the flags is activated QwtPlotCurve tries to find a color representing the curve and paints a rectangle with it\&. In the default setting all attributes are off\&.
  161. .PP
  162. \fBSee Also:\fP
  163. .RS 4
  164. \fBsetLegendAttribute()\fP, \fBtestLegendAttribute()\fP
  165. .RE
  166. .PP
  167. .PP
  168. \fBEnumerator\fP
  169. .in +1c
  170. .TP
  171. \fB\fILegendShowLine \fP\fP
  172. If the curveStyle() is not NoCurve a line is painted with the curvePen()\&.
  173. .TP
  174. \fB\fILegendShowSymbol \fP\fP
  175. If the curve has a valid symbol it is painted\&.
  176. .SH "Constructor & Destructor Documentation"
  177. .PP
  178. .SS "QwtPolarCurve::QwtPolarCurve (const QwtText &title)\fC [explicit]\fP"
  179. Constructor
  180. .PP
  181. \fBParameters:\fP
  182. .RS 4
  183. \fItitle\fP title of the curve
  184. .RE
  185. .PP
  186. .SS "QwtPolarCurve::QwtPolarCurve (const QString &title)\fC [explicit]\fP"
  187. Constructor
  188. .PP
  189. \fBParameters:\fP
  190. .RS 4
  191. \fItitle\fP title of the curve
  192. .RE
  193. .PP
  194. .SH "Member Function Documentation"
  195. .PP
  196. .SS "QwtInterval QwtPolarCurve::boundingInterval (intscaleId) const\fC [virtual]\fP"
  197. Interval, that is necessary to display the item This interval can be useful for operations like clipping or autoscaling
  198. .PP
  199. \fBParameters:\fP
  200. .RS 4
  201. \fIscaleId\fP Scale index
  202. .RE
  203. .PP
  204. \fBReturns:\fP
  205. .RS 4
  206. bounding interval
  207. .RE
  208. .PP
  209. \fBSee Also:\fP
  210. .RS 4
  211. QwtData::boundingRect()
  212. .RE
  213. .PP
  214. .PP
  215. Reimplemented from \fBQwtPolarItem\fP\&.
  216. .SS "QwtCurveFitter * QwtPolarCurve::curveFitter () const"
  217. .PP
  218. \fBReturns:\fP
  219. .RS 4
  220. The curve fitter
  221. .RE
  222. .PP
  223. \fBSee Also:\fP
  224. .RS 4
  225. \fBsetCurveFitter()\fP
  226. .RE
  227. .PP
  228. .SS "const QwtSeriesData< QwtPointPolar > * QwtPolarCurve::data () const\fC [inline]\fP"
  229. .PP
  230. \fBReturns:\fP
  231. .RS 4
  232. the the curve data
  233. .RE
  234. .PP
  235. .SS "size_t QwtPolarCurve::dataSize () const"
  236. .PP
  237. \fBReturns:\fP
  238. .RS 4
  239. Number of points
  240. .RE
  241. .PP
  242. \fBSee Also:\fP
  243. .RS 4
  244. \fBsetData()\fP
  245. .RE
  246. .PP
  247. .SS "void QwtPolarCurve::draw (QPainter *painter, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, doubleradius, const QRectF &canvasRect) const\fC [virtual]\fP"
  248. Draw the curve
  249. .PP
  250. \fBParameters:\fP
  251. .RS 4
  252. \fIpainter\fP Painter
  253. .br
  254. \fIazimuthMap\fP Maps azimuth values to values related to 0\&.0, M_2PI
  255. .br
  256. \fIradialMap\fP Maps radius values into painter coordinates\&.
  257. .br
  258. \fIpole\fP Position of the pole in painter coordinates
  259. .br
  260. \fIradius\fP Radius of the complete plot area in painter coordinates
  261. .br
  262. \fIcanvasRect\fP Contents rect of the canvas in painter coordinates
  263. .RE
  264. .PP
  265. .PP
  266. Implements \fBQwtPolarItem\fP\&.
  267. .SS "void QwtPolarCurve::draw (QPainter *painter, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, intfrom, intto) const\fC [virtual]\fP"
  268. .PP
  269. Draw an interval of the curve\&.
  270. .PP
  271. \fBParameters:\fP
  272. .RS 4
  273. \fIpainter\fP Painter
  274. .br
  275. \fIazimuthMap\fP Maps azimuth values to values related to 0\&.0, M_2PI
  276. .br
  277. \fIradialMap\fP Maps radius values into painter coordinates\&.
  278. .br
  279. \fIpole\fP Position of the pole in painter coordinates
  280. .br
  281. \fIfrom\fP index of the first point to be painted
  282. .br
  283. \fIto\fP index of the last point to be painted\&. If to < 0 the curve will be painted to its last point\&.
  284. .RE
  285. .PP
  286. \fBSee Also:\fP
  287. .RS 4
  288. \fBdrawCurve()\fP, \fBdrawSymbols()\fP,
  289. .RE
  290. .PP
  291. .SS "void QwtPolarCurve::drawCurve (QPainter *painter, intstyle, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, intfrom, intto) const\fC [protected]\fP, \fC [virtual]\fP"
  292. Draw the line part (without symbols) of a curve interval\&.
  293. .PP
  294. \fBParameters:\fP
  295. .RS 4
  296. \fIpainter\fP Painter
  297. .br
  298. \fIstyle\fP Curve style, see \fBQwtPolarCurve::CurveStyle\fP
  299. .br
  300. \fIazimuthMap\fP Maps azimuth values to values related to 0\&.0, M_2PI
  301. .br
  302. \fIradialMap\fP Maps radius values into painter coordinates\&.
  303. .br
  304. \fIpole\fP Position of the pole in painter coordinates
  305. .br
  306. \fIfrom\fP index of the first point to be painted
  307. .br
  308. \fIto\fP index of the last point to be painted\&.
  309. .RE
  310. .PP
  311. \fBSee Also:\fP
  312. .RS 4
  313. \fBdraw()\fP, \fBdrawLines()\fP
  314. .RE
  315. .PP
  316. .SS "void QwtPolarCurve::drawLines (QPainter *painter, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, intfrom, intto) const\fC [protected]\fP"
  317. Draw lines
  318. .PP
  319. \fBParameters:\fP
  320. .RS 4
  321. \fIpainter\fP Painter
  322. .br
  323. \fIazimuthMap\fP Maps azimuth values to values related to 0\&.0, M_2PI
  324. .br
  325. \fIradialMap\fP Maps radius values into painter coordinates\&.
  326. .br
  327. \fIpole\fP Position of the pole in painter coordinates
  328. .br
  329. \fIfrom\fP index of the first point to be painted
  330. .br
  331. \fIto\fP index of the last point to be painted\&.
  332. .RE
  333. .PP
  334. \fBSee Also:\fP
  335. .RS 4
  336. \fBdraw()\fP, \fBdrawLines()\fP, \fBsetCurveFitter()\fP
  337. .RE
  338. .PP
  339. .SS "void QwtPolarCurve::drawSymbols (QPainter *painter, const QwtSymbol &symbol, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, intfrom, intto) const\fC [protected]\fP, \fC [virtual]\fP"
  340. Draw symbols
  341. .PP
  342. \fBParameters:\fP
  343. .RS 4
  344. \fIpainter\fP Painter
  345. .br
  346. \fIsymbol\fP Curve symbol
  347. .br
  348. \fIazimuthMap\fP Maps azimuth values to values related to 0\&.0, M_2PI
  349. .br
  350. \fIradialMap\fP Maps radius values into painter coordinates\&.
  351. .br
  352. \fIpole\fP Position of the pole in painter coordinates
  353. .br
  354. \fIfrom\fP index of the first point to be painted
  355. .br
  356. \fIto\fP index of the last point to be painted\&.
  357. .RE
  358. .PP
  359. \fBSee Also:\fP
  360. .RS 4
  361. \fBsetSymbol()\fP, \fBdraw()\fP, \fBdrawCurve()\fP
  362. .RE
  363. .PP
  364. .SS "QwtGraphic QwtPolarCurve::legendIcon (intindex, const QSizeF &size) const\fC [virtual]\fP"
  365. .PP
  366. \fBReturns:\fP
  367. .RS 4
  368. Icon representing the curve on the legend
  369. .RE
  370. .PP
  371. \fBParameters:\fP
  372. .RS 4
  373. \fIindex\fP Index of the legend entry ( ignored as there is only one )
  374. .br
  375. \fIsize\fP Icon size
  376. .RE
  377. .PP
  378. \fBSee Also:\fP
  379. .RS 4
  380. \fBQwtPolarItem::setLegendIconSize()\fP, \fBQwtPolarItem::legendData()\fP
  381. .RE
  382. .PP
  383. .PP
  384. Reimplemented from \fBQwtPolarItem\fP\&.
  385. .SS "const QPen & QwtPolarCurve::pen () const"
  386. .PP
  387. \fBReturns:\fP
  388. .RS 4
  389. Pen used to draw the lines
  390. .RE
  391. .PP
  392. \fBSee Also:\fP
  393. .RS 4
  394. \fBsetPen()\fP
  395. .RE
  396. .PP
  397. .SS "int QwtPolarCurve::rtti () const\fC [virtual]\fP"
  398. .PP
  399. \fBReturns:\fP
  400. .RS 4
  401. \fBQwtPolarCurve::Rtti_PolarCurve\fP
  402. .RE
  403. .PP
  404. .PP
  405. Reimplemented from \fBQwtPolarItem\fP\&.
  406. .SS "QwtPointPolar QwtPolarCurve::sample (inti) const\fC [inline]\fP"
  407. .PP
  408. \fBParameters:\fP
  409. .RS 4
  410. \fIi\fP index
  411. .RE
  412. .PP
  413. \fBReturns:\fP
  414. .RS 4
  415. point at position i
  416. .RE
  417. .PP
  418. .SS "void QwtPolarCurve::setCurveFitter (QwtCurveFitter *curveFitter)"
  419. .PP
  420. Insert a curve fitter\&.
  421. .PP
  422. \fBParameters:\fP
  423. .RS 4
  424. \fIcurveFitter\fP Curve fitter
  425. .RE
  426. .PP
  427. A curve fitter interpolates the curve points\&. F\&.e \fBQwtPolarFitter\fP adds equidistant points so that the connection gets rounded instead of having straight lines\&. If curveFitter is NULL fitting is disabled\&.
  428. .PP
  429. \fBSee Also:\fP
  430. .RS 4
  431. \fBcurveFitter()\fP
  432. .RE
  433. .PP
  434. .SS "void QwtPolarCurve::setData (QwtSeriesData< QwtPointPolar > *data)"
  435. Initialize data with a pointer to QwtSeriesData<QwtPointPolar>\&.
  436. .PP
  437. The x-values of the data object represent the azimuth, the y-value respresent the radius\&.
  438. .PP
  439. \fBParameters:\fP
  440. .RS 4
  441. \fIdata\fP Data
  442. .RE
  443. .PP
  444. .SS "void QwtPolarCurve::setLegendAttribute (\fBLegendAttribute\fPattribute, boolon = \fCtrue\fP)"
  445. Specify an attribute how to draw the legend identifier
  446. .PP
  447. \fBParameters:\fP
  448. .RS 4
  449. \fIattribute\fP Attribute
  450. .br
  451. \fIon\fP On/Off /sa LegendAttribute, \fBtestLegendAttribute()\fP
  452. .RE
  453. .PP
  454. .SS "void QwtPolarCurve::setPen (const QPen &pen)"
  455. .PP
  456. Assign a pen\&.
  457. .PP
  458. \fBParameters:\fP
  459. .RS 4
  460. \fIpen\fP New pen
  461. .RE
  462. .PP
  463. \fBSee Also:\fP
  464. .RS 4
  465. \fBpen()\fP
  466. .RE
  467. .PP
  468. .SS "void QwtPolarCurve::setStyle (\fBCurveStyle\fPstyle)"
  469. Set the curve's drawing style
  470. .PP
  471. \fBParameters:\fP
  472. .RS 4
  473. \fIstyle\fP Curve style
  474. .RE
  475. .PP
  476. \fBSee Also:\fP
  477. .RS 4
  478. \fBCurveStyle\fP, \fBstyle()\fP
  479. .RE
  480. .PP
  481. .SS "void QwtPolarCurve::setSymbol (QwtSymbol *symbol)"
  482. .PP
  483. Assign a symbol\&.
  484. .PP
  485. \fBParameters:\fP
  486. .RS 4
  487. \fIsymbol\fP Symbol
  488. .RE
  489. .PP
  490. \fBSee Also:\fP
  491. .RS 4
  492. \fBsymbol()\fP
  493. .RE
  494. .PP
  495. .SS "\fBQwtPolarCurve::CurveStyle\fP QwtPolarCurve::style () const"
  496. .PP
  497. \fBReturns:\fP
  498. .RS 4
  499. Current style
  500. .RE
  501. .PP
  502. \fBSee Also:\fP
  503. .RS 4
  504. \fBCurveStyle\fP, \fBsetStyle()\fP
  505. .RE
  506. .PP
  507. .SS "const QwtSymbol * QwtPolarCurve::symbol () const"
  508. .PP
  509. \fBReturns:\fP
  510. .RS 4
  511. The current symbol
  512. .RE
  513. .PP
  514. \fBSee Also:\fP
  515. .RS 4
  516. \fBsetSymbol()\fP
  517. .RE
  518. .PP
  519. .SS "bool QwtPolarCurve::testLegendAttribute (\fBLegendAttribute\fPattribute) const"
  520. .PP
  521. Test if a lefend attribute is enables\&.
  522. .PP
  523. \fBParameters:\fP
  524. .RS 4
  525. \fIattribute\fP Legend attribute
  526. .RE
  527. .PP
  528. \fBReturns:\fP
  529. .RS 4
  530. True if attribute is enabled
  531. .RE
  532. .PP
  533. \fBSee Also:\fP
  534. .RS 4
  535. \fBLegendAttribute\fP, \fBsetLegendAttribute()\fP
  536. .RE
  537. .PP
  538. .SH "Author"
  539. .PP
  540. Generated automatically by Doxygen for Qwt Polar User's Guide from the source code\&.