QwtPlotSpectroCurve.3 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. .TH "QwtPlotSpectroCurve" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPlotSpectroCurve \- Curve that displays 3D points as dots, where the z coordinate is mapped to a color\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_plot_spectrocurve\&.h>\fP
  11. .PP
  12. Inherits \fBQwtPlotSeriesItem\fP, and \fBQwtSeriesStore< QwtPoint3D >\fP\&.
  13. .SS "Public Types"
  14. .in +1c
  15. .ti -1c
  16. .RI "enum \fBPaintAttribute\fP { \fBClipPoints\fP = 1 }"
  17. .br
  18. .RI "Paint attributes\&. "
  19. .ti -1c
  20. .RI "typedef QFlags< \fBPaintAttribute\fP > \fBPaintAttributes\fP"
  21. .br
  22. .RI "Paint attributes\&. "
  23. .in -1c
  24. .SS "Public Member Functions"
  25. .in +1c
  26. .ti -1c
  27. .RI "\fBQwtPlotSpectroCurve\fP (const QString &\fBtitle\fP=QString())"
  28. .br
  29. .ti -1c
  30. .RI "\fBQwtPlotSpectroCurve\fP (const \fBQwtText\fP &\fBtitle\fP)"
  31. .br
  32. .ti -1c
  33. .RI "virtual \fB~QwtPlotSpectroCurve\fP ()"
  34. .br
  35. .RI "Destructor\&. "
  36. .ti -1c
  37. .RI "virtual int \fBrtti\fP () const"
  38. .br
  39. .ti -1c
  40. .RI "void \fBsetPaintAttribute\fP (\fBPaintAttribute\fP, bool on=true)"
  41. .br
  42. .ti -1c
  43. .RI "bool \fBtestPaintAttribute\fP (\fBPaintAttribute\fP) const"
  44. .br
  45. .ti -1c
  46. .RI "void \fBsetSamples\fP (const QVector< \fBQwtPoint3D\fP > &)"
  47. .br
  48. .ti -1c
  49. .RI "void \fBsetSamples\fP (\fBQwtSeriesData\fP< \fBQwtPoint3D\fP > *)"
  50. .br
  51. .ti -1c
  52. .RI "void \fBsetColorMap\fP (\fBQwtColorMap\fP *)"
  53. .br
  54. .ti -1c
  55. .RI "const \fBQwtColorMap\fP * \fBcolorMap\fP () const"
  56. .br
  57. .ti -1c
  58. .RI "void \fBsetColorRange\fP (const \fBQwtInterval\fP &)"
  59. .br
  60. .ti -1c
  61. .RI "\fBQwtInterval\fP & \fBcolorRange\fP () const"
  62. .br
  63. .ti -1c
  64. .RI "virtual void \fBdrawSeries\fP (QPainter *, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRectF &canvasRect, int from, int to) const"
  65. .br
  66. .ti -1c
  67. .RI "void \fBsetPenWidth\fP (double)"
  68. .br
  69. .ti -1c
  70. .RI "double \fBpenWidth\fP () const"
  71. .br
  72. .in -1c
  73. .SS "Protected Member Functions"
  74. .in +1c
  75. .ti -1c
  76. .RI "virtual void \fBdrawDots\fP (QPainter *, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRectF &canvasRect, int from, int to) const"
  77. .br
  78. .in -1c
  79. .SH "Detailed Description"
  80. .PP
  81. Curve that displays 3D points as dots, where the z coordinate is mapped to a color\&.
  82. .SH "Member Enumeration Documentation"
  83. .PP
  84. .SS "enum \fBQwtPlotSpectroCurve::PaintAttribute\fP"
  85. .PP
  86. Paint attributes\&.
  87. .PP
  88. \fBEnumerator\fP
  89. .in +1c
  90. .TP
  91. \fB\fIClipPoints \fP\fP
  92. Clip points outside the canvas rectangle\&.
  93. .SH "Constructor & Destructor Documentation"
  94. .PP
  95. .SS "QwtPlotSpectroCurve::QwtPlotSpectroCurve (const QString & title = \fCQString()\fP)\fC [explicit]\fP"
  96. Constructor
  97. .PP
  98. \fBParameters\fP
  99. .RS 4
  100. \fItitle\fP Title of the curve
  101. .RE
  102. .PP
  103. .SS "QwtPlotSpectroCurve::QwtPlotSpectroCurve (const \fBQwtText\fP & title)\fC [explicit]\fP"
  104. Constructor
  105. .PP
  106. \fBParameters\fP
  107. .RS 4
  108. \fItitle\fP Title of the curve
  109. .RE
  110. .PP
  111. .SH "Member Function Documentation"
  112. .PP
  113. .SS "const \fBQwtColorMap\fP * QwtPlotSpectroCurve::colorMap () const"
  114. .PP
  115. \fBReturns\fP
  116. .RS 4
  117. Color Map used for mapping the intensity values to colors
  118. .RE
  119. .PP
  120. \fBSee also\fP
  121. .RS 4
  122. \fBsetColorMap()\fP, \fBsetColorRange()\fP, \fBQwtColorMap::color()\fP
  123. .RE
  124. .PP
  125. .SS "\fBQwtInterval\fP & QwtPlotSpectroCurve::colorRange () const"
  126. .PP
  127. \fBReturns\fP
  128. .RS 4
  129. Value interval, that corresponds to the color map
  130. .RE
  131. .PP
  132. \fBSee also\fP
  133. .RS 4
  134. \fBsetColorRange()\fP, \fBsetColorMap()\fP, \fBQwtColorMap::color()\fP
  135. .RE
  136. .PP
  137. .SS "void QwtPlotSpectroCurve::drawDots (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRectF & canvasRect, int from, int to) const\fC [protected]\fP, \fC [virtual]\fP"
  138. Draw a subset of the points
  139. .PP
  140. \fBParameters\fP
  141. .RS 4
  142. \fIpainter\fP Painter
  143. .br
  144. \fIxMap\fP Maps x-values into pixel coordinates\&.
  145. .br
  146. \fIyMap\fP Maps y-values into pixel coordinates\&.
  147. .br
  148. \fIcanvasRect\fP Contents rectangle of the canvas
  149. .br
  150. \fIfrom\fP Index of the first sample to be painted
  151. .br
  152. \fIto\fP Index of the last sample to be painted\&. If to < 0 the series will be painted to its last sample\&.
  153. .RE
  154. .PP
  155. \fBSee also\fP
  156. .RS 4
  157. \fBdrawSeries()\fP
  158. .RE
  159. .PP
  160. .SS "void QwtPlotSpectroCurve::drawSeries (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRectF & canvasRect, int from, int to) const\fC [virtual]\fP"
  161. Draw a subset of the points
  162. .PP
  163. \fBParameters\fP
  164. .RS 4
  165. \fIpainter\fP Painter
  166. .br
  167. \fIxMap\fP Maps x-values into pixel coordinates\&.
  168. .br
  169. \fIyMap\fP Maps y-values into pixel coordinates\&.
  170. .br
  171. \fIcanvasRect\fP Contents rectangle of the canvas
  172. .br
  173. \fIfrom\fP Index of the first sample to be painted
  174. .br
  175. \fIto\fP Index of the last sample to be painted\&. If to < 0 the series will be painted to its last sample\&.
  176. .RE
  177. .PP
  178. \fBSee also\fP
  179. .RS 4
  180. \fBdrawDots()\fP
  181. .RE
  182. .PP
  183. .PP
  184. Implements \fBQwtPlotSeriesItem\fP\&.
  185. .SS "double QwtPlotSpectroCurve::penWidth () const"
  186. .PP
  187. \fBReturns\fP
  188. .RS 4
  189. Pen width used to draw a dot
  190. .RE
  191. .PP
  192. \fBSee also\fP
  193. .RS 4
  194. \fBsetPenWidth()\fP
  195. .RE
  196. .PP
  197. .SS "int QwtPlotSpectroCurve::rtti () const\fC [virtual]\fP"
  198. .PP
  199. \fBReturns\fP
  200. .RS 4
  201. \fBQwtPlotItem::Rtti_PlotSpectroCurve\fP
  202. .RE
  203. .PP
  204. .PP
  205. Reimplemented from \fBQwtPlotItem\fP\&.
  206. .SS "void QwtPlotSpectroCurve::setColorMap (\fBQwtColorMap\fP * colorMap)"
  207. Change the color map
  208. .PP
  209. Often it is useful to display the mapping between intensities and colors as an additional plot axis, showing a color bar\&.
  210. .PP
  211. \fBParameters\fP
  212. .RS 4
  213. \fIcolorMap\fP Color Map
  214. .RE
  215. .PP
  216. \fBSee also\fP
  217. .RS 4
  218. \fBcolorMap()\fP, \fBsetColorRange()\fP, \fBQwtColorMap::color()\fP, \fBQwtScaleWidget::setColorBarEnabled()\fP, \fBQwtScaleWidget::setColorMap()\fP
  219. .RE
  220. .PP
  221. .SS "void QwtPlotSpectroCurve::setColorRange (const \fBQwtInterval\fP & interval)"
  222. Set the value interval, that corresponds to the color map
  223. .PP
  224. \fBParameters\fP
  225. .RS 4
  226. \fIinterval\fP interval\&.minValue() corresponds to 0\&.0, interval\&.maxValue() to 1\&.0 on the color map\&.
  227. .RE
  228. .PP
  229. \fBSee also\fP
  230. .RS 4
  231. \fBcolorRange()\fP, \fBsetColorMap()\fP, \fBQwtColorMap::color()\fP
  232. .RE
  233. .PP
  234. .SS "void QwtPlotSpectroCurve::setPaintAttribute (\fBPaintAttribute\fP attribute, bool on = \fCtrue\fP)"
  235. Specify an attribute how to draw the curve
  236. .PP
  237. \fBParameters\fP
  238. .RS 4
  239. \fIattribute\fP Paint attribute
  240. .br
  241. \fIon\fP On/Off /sa PaintAttribute, \fBtestPaintAttribute()\fP
  242. .RE
  243. .PP
  244. .SS "void QwtPlotSpectroCurve::setPenWidth (double penWidth)"
  245. Assign a pen width
  246. .PP
  247. \fBParameters\fP
  248. .RS 4
  249. \fIpenWidth\fP New pen width
  250. .RE
  251. .PP
  252. \fBSee also\fP
  253. .RS 4
  254. \fBpenWidth()\fP
  255. .RE
  256. .PP
  257. .SS "void QwtPlotSpectroCurve::setSamples (const QVector< \fBQwtPoint3D\fP > & samples)"
  258. Initialize data with an array of samples\&.
  259. .PP
  260. \fBParameters\fP
  261. .RS 4
  262. \fIsamples\fP Vector of points
  263. .RE
  264. .PP
  265. .SS "void QwtPlotSpectroCurve::setSamples (\fBQwtSeriesData\fP< \fBQwtPoint3D\fP > * data)"
  266. Assign a series of samples
  267. .PP
  268. \fBsetSamples()\fP is just a wrapper for \fBsetData()\fP without any additional value - beside that it is easier to find for the developer\&.
  269. .PP
  270. \fBParameters\fP
  271. .RS 4
  272. \fIdata\fP Data
  273. .RE
  274. .PP
  275. \fBWarning\fP
  276. .RS 4
  277. The item takes ownership of the data object, deleting it when its not used anymore\&.
  278. .RE
  279. .PP
  280. .SS "bool QwtPlotSpectroCurve::testPaintAttribute (\fBPaintAttribute\fP attribute) const"
  281. .PP
  282. \fBReturns\fP
  283. .RS 4
  284. True, when attribute is enabled
  285. .RE
  286. .PP
  287. \fBSee also\fP
  288. .RS 4
  289. \fBPaintAttribute\fP, \fBsetPaintAttribute()\fP
  290. .RE
  291. .PP
  292. .SH "Author"
  293. .PP
  294. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.