QwtPolarPlot.3 24 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097
  1. .TH "QwtPolarPlot" 3 "Fri Sep 19 2014" "Version 1.1.1" "Qwt Polar User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPolarPlot \-
  6. .PP
  7. A plotting widget, displaying a polar coordinate system\&.
  8. .SH SYNOPSIS
  9. .br
  10. .PP
  11. .PP
  12. \fC#include <qwt_polar_plot\&.h>\fP
  13. .PP
  14. Inherits QFrame, and \fBQwtPolarItemDict\fP\&.
  15. .SS "Public Types"
  16. .in +1c
  17. .ti -1c
  18. .RI "enum \fBLegendPosition\fP { \fBLeftLegend\fP, \fBRightLegend\fP, \fBBottomLegend\fP, \fBTopLegend\fP, \fBExternalLegend\fP }"
  19. .br
  20. .in -1c
  21. .SS "Public Slots"
  22. .in +1c
  23. .ti -1c
  24. .RI "virtual void \fBreplot\fP ()"
  25. .br
  26. .RI "\fIRedraw the plot\&. \fP"
  27. .ti -1c
  28. .RI "void \fBautoRefresh\fP ()"
  29. .br
  30. .RI "\fIReplots the plot if QwtPlot::autoReplot() is \fCtrue\fP\&. \fP"
  31. .ti -1c
  32. .RI "void \fBsetAzimuthOrigin\fP (double)"
  33. .br
  34. .RI "\fIChange the origin of the azimuth scale\&. \fP"
  35. .in -1c
  36. .SS "Signals"
  37. .in +1c
  38. .ti -1c
  39. .RI "void \fBitemAttached\fP (\fBQwtPolarItem\fP *plotItem, bool on)"
  40. .br
  41. .ti -1c
  42. .RI "void \fBlegendDataChanged\fP (const QVariant &itemInfo, const QList< QwtLegendData > &data)"
  43. .br
  44. .ti -1c
  45. .RI "void \fBlayoutChanged\fP ()"
  46. .br
  47. .in -1c
  48. .SS "Public Member Functions"
  49. .in +1c
  50. .ti -1c
  51. .RI "\fBQwtPolarPlot\fP (QWidget *parent=NULL)"
  52. .br
  53. .ti -1c
  54. .RI "\fBQwtPolarPlot\fP (const QwtText &\fBtitle\fP, QWidget *parent=NULL)"
  55. .br
  56. .ti -1c
  57. .RI "virtual \fB~QwtPolarPlot\fP ()"
  58. .br
  59. .RI "\fIDestructor\&. \fP"
  60. .ti -1c
  61. .RI "void \fBsetTitle\fP (const QString &)"
  62. .br
  63. .ti -1c
  64. .RI "void \fBsetTitle\fP (const QwtText &)"
  65. .br
  66. .ti -1c
  67. .RI "QwtText \fBtitle\fP () const "
  68. .br
  69. .ti -1c
  70. .RI "QwtTextLabel * \fBtitleLabel\fP ()"
  71. .br
  72. .ti -1c
  73. .RI "const QwtTextLabel * \fBtitleLabel\fP () const "
  74. .br
  75. .ti -1c
  76. .RI "void \fBsetAutoReplot\fP (bool tf=true)"
  77. .br
  78. .RI "\fISet or reset the autoReplot option\&. \fP"
  79. .ti -1c
  80. .RI "bool \fBautoReplot\fP () const "
  81. .br
  82. .ti -1c
  83. .RI "void \fBsetAutoScale\fP (int scaleId)"
  84. .br
  85. .RI "\fIEnable autoscaling\&. \fP"
  86. .ti -1c
  87. .RI "bool \fBhasAutoScale\fP (int scaleId) const "
  88. .br
  89. .ti -1c
  90. .RI "void \fBsetScaleMaxMinor\fP (int scaleId, int maxMinor)"
  91. .br
  92. .ti -1c
  93. .RI "int \fBscaleMaxMinor\fP (int scaleId) const "
  94. .br
  95. .ti -1c
  96. .RI "int \fBscaleMaxMajor\fP (int scaleId) const "
  97. .br
  98. .ti -1c
  99. .RI "void \fBsetScaleMaxMajor\fP (int scaleId, int maxMajor)"
  100. .br
  101. .ti -1c
  102. .RI "QwtScaleEngine * \fBscaleEngine\fP (int scaleId)"
  103. .br
  104. .ti -1c
  105. .RI "const QwtScaleEngine * \fBscaleEngine\fP (int scaleId) const "
  106. .br
  107. .ti -1c
  108. .RI "void \fBsetScaleEngine\fP (int scaleId, QwtScaleEngine *)"
  109. .br
  110. .ti -1c
  111. .RI "void \fBsetScale\fP (int scaleId, double min, double max, double step=0)"
  112. .br
  113. .RI "\fIDisable autoscaling and specify a fixed scale for a selected scale\&. \fP"
  114. .ti -1c
  115. .RI "void \fBsetScaleDiv\fP (int scaleId, const QwtScaleDiv &)"
  116. .br
  117. .RI "\fIDisable autoscaling and specify a fixed scale for a selected scale\&. \fP"
  118. .ti -1c
  119. .RI "const QwtScaleDiv * \fBscaleDiv\fP (int scaleId) const "
  120. .br
  121. .RI "\fIReturn the scale division of a specified scale\&. \fP"
  122. .ti -1c
  123. .RI "QwtScaleDiv * \fBscaleDiv\fP (int scaleId)"
  124. .br
  125. .RI "\fIReturn the scale division of a specified scale\&. \fP"
  126. .ti -1c
  127. .RI "QwtScaleMap \fBscaleMap\fP (int scaleId, double radius) const "
  128. .br
  129. .ti -1c
  130. .RI "QwtScaleMap \fBscaleMap\fP (int scaleId) const "
  131. .br
  132. .ti -1c
  133. .RI "void \fBupdateScale\fP (int scaleId)"
  134. .br
  135. .ti -1c
  136. .RI "double \fBazimuthOrigin\fP () const "
  137. .br
  138. .ti -1c
  139. .RI "void \fBzoom\fP (const QwtPointPolar &, double factor)"
  140. .br
  141. .RI "\fITranslate and in/decrease the zoom factor\&. \fP"
  142. .ti -1c
  143. .RI "void \fBunzoom\fP ()"
  144. .br
  145. .ti -1c
  146. .RI "QwtPointPolar \fBzoomPos\fP () const "
  147. .br
  148. .ti -1c
  149. .RI "double \fBzoomFactor\fP () const "
  150. .br
  151. .ti -1c
  152. .RI "\fBQwtPolarCanvas\fP * \fBcanvas\fP ()"
  153. .br
  154. .ti -1c
  155. .RI "const \fBQwtPolarCanvas\fP * \fBcanvas\fP () const "
  156. .br
  157. .ti -1c
  158. .RI "void \fBsetPlotBackground\fP (const QBrush &c)"
  159. .br
  160. .RI "\fISet the background of the plot area\&. \fP"
  161. .ti -1c
  162. .RI "const QBrush & \fBplotBackground\fP () const "
  163. .br
  164. .ti -1c
  165. .RI "virtual void \fBdrawCanvas\fP (QPainter *, const QRectF &) const "
  166. .br
  167. .ti -1c
  168. .RI "void \fBinsertLegend\fP (QwtAbstractLegend *, \fBLegendPosition\fP=\fBRightLegend\fP, double ratio=-1\&.0)"
  169. .br
  170. .RI "\fIInsert a legend\&. \fP"
  171. .ti -1c
  172. .RI "QwtAbstractLegend * \fBlegend\fP ()"
  173. .br
  174. .ti -1c
  175. .RI "const QwtAbstractLegend * \fBlegend\fP () const "
  176. .br
  177. .ti -1c
  178. .RI "void \fBupdateLegend\fP ()"
  179. .br
  180. .ti -1c
  181. .RI "void \fBupdateLegend\fP (const \fBQwtPolarItem\fP *)"
  182. .br
  183. .ti -1c
  184. .RI "\fBQwtPolarLayout\fP * \fBplotLayout\fP ()"
  185. .br
  186. .ti -1c
  187. .RI "const \fBQwtPolarLayout\fP * \fBplotLayout\fP () const "
  188. .br
  189. .ti -1c
  190. .RI "QwtInterval \fBvisibleInterval\fP () const "
  191. .br
  192. .ti -1c
  193. .RI "QRectF \fBplotRect\fP () const "
  194. .br
  195. .ti -1c
  196. .RI "QRectF \fBplotRect\fP (const QRectF &) const "
  197. .br
  198. .RI "\fICalculate the bounding rect of the plot area\&. \fP"
  199. .ti -1c
  200. .RI "int \fBplotMarginHint\fP () const "
  201. .br
  202. .ti -1c
  203. .RI "virtual QVariant \fBitemToInfo\fP (\fBQwtPolarItem\fP *) const "
  204. .br
  205. .RI "\fIBuild an information, that can be used to identify a plot item on the legend\&. \fP"
  206. .ti -1c
  207. .RI "virtual \fBQwtPolarItem\fP * \fBinfoToItem\fP (const QVariant &) const "
  208. .br
  209. .RI "\fIIdentify the plot item according to an item info object, that has bee generated from \fBitemToInfo()\fP\&. \fP"
  210. .in -1c
  211. .SS "Protected Member Functions"
  212. .in +1c
  213. .ti -1c
  214. .RI "virtual bool \fBevent\fP (QEvent *)"
  215. .br
  216. .RI "\fIQt event handler\&. \fP"
  217. .ti -1c
  218. .RI "virtual void \fBresizeEvent\fP (QResizeEvent *)"
  219. .br
  220. .RI "\fIResize and update internal layout\&. \fP"
  221. .ti -1c
  222. .RI "virtual void \fBupdateLayout\fP ()"
  223. .br
  224. .RI "\fIRebuild the layout\&. \fP"
  225. .ti -1c
  226. .RI "virtual void \fBdrawItems\fP (QPainter *painter, const QwtScaleMap &radialMap, const QwtScaleMap &azimuthMap, const QPointF &pole, double radius, const QRectF &canvasRect) const "
  227. .br
  228. .in -1c
  229. .SS "Friends"
  230. .in +1c
  231. .ti -1c
  232. .RI "class \fBQwtPolarItem\fP"
  233. .br
  234. .in -1c
  235. .SH "Detailed Description"
  236. .PP
  237. A plotting widget, displaying a polar coordinate system\&.
  238. An unlimited number of plot items can be displayed on its canvas\&. Plot items might be curves (\fBQwtPolarCurve\fP), markers (\fBQwtPolarMarker\fP), the grid (\fBQwtPolarGrid\fP), or anything else derived from \fBQwtPolarItem\fP\&.
  239. .PP
  240. The coordinate system is defined by a radial and a azimuth scale\&. The scales at the axes can be explicitely set (QwtScaleDiv), or are calculated from the plot items, using algorithms (QwtScaleEngine) which can be configured separately for each axis\&. Autoscaling is supported for the radial scale\&.
  241. .PP
  242. In opposite to QwtPlot the scales might be different from the view, that is displayed on the canvas\&. The view can be changed by zooming - f\&.e\&. by using \fBQwtPolarPanner\fP or QwtPolarMaginfier\&.
  243. .SH "Member Enumeration Documentation"
  244. .PP
  245. .SS "enum \fBQwtPolarPlot::LegendPosition\fP"
  246. Position of the legend, relative to the canvas\&.
  247. .PP
  248. \fBSee Also:\fP
  249. .RS 4
  250. \fBinsertLegend()\fP
  251. .RE
  252. .PP
  253. .PP
  254. \fBEnumerator\fP
  255. .in +1c
  256. .TP
  257. \fB\fILeftLegend \fP\fP
  258. The legend will be left from the canvas\&.
  259. .TP
  260. \fB\fIRightLegend \fP\fP
  261. The legend will be right from the canvas\&.
  262. .TP
  263. \fB\fIBottomLegend \fP\fP
  264. The legend will be below the canvas\&.
  265. .TP
  266. \fB\fITopLegend \fP\fP
  267. The legend will be between canvas and title\&.
  268. .TP
  269. \fB\fIExternalLegend \fP\fP
  270. External means that only the content of the legend will be handled by QwtPlot, but not its geometry\&. This might be interesting if an application wants to have a legend in an external window ( or on the canvas )\&.
  271. .PP
  272. \fBNote:\fP
  273. .RS 4
  274. The legend is not painted by \fBQwtPolarRenderer\fP
  275. .RE
  276. .PP
  277. .SH "Constructor & Destructor Documentation"
  278. .PP
  279. .SS "QwtPolarPlot::QwtPolarPlot (QWidget *parent = \fCNULL\fP)\fC [explicit]\fP"
  280. Constructor
  281. .PP
  282. \fBParameters:\fP
  283. .RS 4
  284. \fIparent\fP Parent widget
  285. .RE
  286. .PP
  287. .SS "QwtPolarPlot::QwtPolarPlot (const QwtText &title, QWidget *parent = \fCNULL\fP)"
  288. Constructor
  289. .PP
  290. \fBParameters:\fP
  291. .RS 4
  292. \fItitle\fP Title text
  293. .br
  294. \fIparent\fP Parent widget
  295. .RE
  296. .PP
  297. .SH "Member Function Documentation"
  298. .PP
  299. .SS "bool QwtPolarPlot::autoReplot () const"
  300. .PP
  301. \fBReturns:\fP
  302. .RS 4
  303. true if the autoReplot option is set\&.
  304. .RE
  305. .PP
  306. .SS "double QwtPolarPlot::azimuthOrigin () const"
  307. The azimuth origin is the angle where the azimuth scale shows the value 0\&.0\&.
  308. .PP
  309. \fBReturns:\fP
  310. .RS 4
  311. Origin of the azimuth scale
  312. .RE
  313. .PP
  314. \fBSee Also:\fP
  315. .RS 4
  316. \fBsetAzimuthOrigin()\fP
  317. .RE
  318. .PP
  319. .SS "\fBQwtPolarCanvas\fP * QwtPolarPlot::canvas ()"
  320. .PP
  321. \fBReturns:\fP
  322. .RS 4
  323. the plot's canvas
  324. .RE
  325. .PP
  326. .SS "const \fBQwtPolarCanvas\fP * QwtPolarPlot::canvas () const"
  327. .PP
  328. \fBReturns:\fP
  329. .RS 4
  330. the plot's canvas
  331. .RE
  332. .PP
  333. .SS "void QwtPolarPlot::drawCanvas (QPainter *painter, const QRectF &canvasRect) const\fC [virtual]\fP"
  334. Redraw the canvas\&.
  335. .PP
  336. \fBParameters:\fP
  337. .RS 4
  338. \fIpainter\fP Painter used for drawing
  339. .br
  340. \fIcanvasRect\fP Contents rect of the canvas
  341. .RE
  342. .PP
  343. .SS "void QwtPolarPlot::drawItems (QPainter *painter, const QwtScaleMap &azimuthMap, const QwtScaleMap &radialMap, const QPointF &pole, doubleradius, const QRectF &canvasRect) const\fC [protected]\fP, \fC [virtual]\fP"
  344. Redraw the canvas items\&.
  345. .PP
  346. \fBParameters:\fP
  347. .RS 4
  348. \fIpainter\fP Painter used for drawing
  349. .br
  350. \fIazimuthMap\fP Maps azimuth values to values related to 0\&.0, M_2PI
  351. .br
  352. \fIradialMap\fP Maps radius values into painter coordinates\&.
  353. .br
  354. \fIpole\fP Position of the pole in painter coordinates
  355. .br
  356. \fIradius\fP Radius of the complete plot area in painter coordinates
  357. .br
  358. \fIcanvasRect\fP Contents rect of the canvas in painter coordinates
  359. .RE
  360. .PP
  361. .SS "bool QwtPolarPlot::event (QEvent *e)\fC [protected]\fP, \fC [virtual]\fP"
  362. .PP
  363. Qt event handler\&. Handles QEvent::LayoutRequest and QEvent::PolishRequest
  364. .PP
  365. \fBParameters:\fP
  366. .RS 4
  367. \fIe\fP Qt Event
  368. .RE
  369. .PP
  370. \fBReturns:\fP
  371. .RS 4
  372. True, when the event was processed
  373. .RE
  374. .PP
  375. .SS "bool QwtPolarPlot::hasAutoScale (intscaleId) const"
  376. .PP
  377. \fBReturns:\fP
  378. .RS 4
  379. \fCtrue\fP if autoscaling is enabled
  380. .RE
  381. .PP
  382. \fBParameters:\fP
  383. .RS 4
  384. \fIscaleId\fP Scale index
  385. .RE
  386. .PP
  387. \fBSee Also:\fP
  388. .RS 4
  389. \fBsetAutoScale()\fP
  390. .RE
  391. .PP
  392. .SS "\fBQwtPolarItem\fP * QwtPolarPlot::infoToItem (const QVariant &itemInfo) const\fC [virtual]\fP"
  393. .PP
  394. Identify the plot item according to an item info object, that has bee generated from \fBitemToInfo()\fP\&. The default implementation simply tries to unwrap a QwtPlotItem pointer:
  395. .PP
  396. .PP
  397. .nf
  398. if ( itemInfo\&.canConvert<QwtPlotItem *>() )
  399. return qvariant_cast<QwtPlotItem *>( itemInfo );
  400. .fi
  401. .PP
  402. .PP
  403. \fBParameters:\fP
  404. .RS 4
  405. \fIitemInfo\fP Plot item
  406. .RE
  407. .PP
  408. \fBReturns:\fP
  409. .RS 4
  410. A plot item, when successful, otherwise a NULL pointer\&.
  411. .RE
  412. .PP
  413. \fBSee Also:\fP
  414. .RS 4
  415. \fBitemToInfo()\fP
  416. .RE
  417. .PP
  418. .SS "void QwtPolarPlot::insertLegend (QwtAbstractLegend *legend, \fBQwtPolarPlot::LegendPosition\fPpos = \fC\fBRightLegend\fP\fP, doubleratio = \fC-1\&.0\fP)"
  419. .PP
  420. Insert a legend\&. If the position legend is \fC\fBQwtPolarPlot::LeftLegend\fP\fP or \fC\fBQwtPolarPlot::RightLegend\fP\fP the legend will be organized in one column from top to down\&. Otherwise the legend items will be placed in a table with a best fit number of columns from left to right\&.
  421. .PP
  422. If pos != \fBQwtPolarPlot::ExternalLegend\fP the plot widget will become parent of the legend\&. It will be deleted when the plot is deleted, or another legend is set with \fBinsertLegend()\fP\&.
  423. .PP
  424. \fBParameters:\fP
  425. .RS 4
  426. \fIlegend\fP Legend
  427. .br
  428. \fIpos\fP The legend's position\&. For top/left position the number of colums will be limited to 1, otherwise it will be set to unlimited\&.
  429. .br
  430. \fIratio\fP Ratio between legend and the bounding rect of title, canvas and axes\&. The legend will be shrinked if it would need more space than the given ratio\&. The ratio is limited to ]0\&.0 \&.\&. 1\&.0]\&. In case of <= 0\&.0 it will be reset to the default ratio\&. The default vertical/horizontal ratio is 0\&.33/0\&.5\&.
  431. .RE
  432. .PP
  433. \fBSee Also:\fP
  434. .RS 4
  435. \fBlegend()\fP, \fBQwtPolarLayout::legendPosition()\fP, \fBQwtPolarLayout::setLegendPosition()\fP
  436. .RE
  437. .PP
  438. .SS "void QwtPolarPlot::itemAttached (\fBQwtPolarItem\fP *plotItem, boolon)\fC [signal]\fP"
  439. A signal indicating, that an item has been attached/detached
  440. .PP
  441. \fBParameters:\fP
  442. .RS 4
  443. \fIplotItem\fP Plot item
  444. .br
  445. \fIon\fP Attached/Detached
  446. .RE
  447. .PP
  448. .SS "QVariant QwtPolarPlot::itemToInfo (\fBQwtPolarItem\fP *plotItem) const\fC [virtual]\fP"
  449. .PP
  450. Build an information, that can be used to identify a plot item on the legend\&. The default implementation simply wraps the plot item into a QVariant object\&. When overloading \fBitemToInfo()\fP usually \fBinfoToItem()\fP needs to reimplemeted too\&.
  451. .PP
  452. .PP
  453. .nf
  454. QVariant itemInfo;
  455. qVariantSetValue( itemInfo, plotItem );
  456. .fi
  457. .PP
  458. .PP
  459. \fBParameters:\fP
  460. .RS 4
  461. \fIplotItem\fP Plot item
  462. .RE
  463. .PP
  464. \fBSee Also:\fP
  465. .RS 4
  466. \fBinfoToItem()\fP
  467. .RE
  468. .PP
  469. .SS "void QwtPolarPlot::layoutChanged ()\fC [signal]\fP"
  470. A signal that is emitted, whenever the layout of the plot has been recalculated\&.
  471. .SS "QwtAbstractLegend * QwtPolarPlot::legend ()"
  472. .PP
  473. \fBReturns:\fP
  474. .RS 4
  475. the plot's legend
  476. .RE
  477. .PP
  478. \fBSee Also:\fP
  479. .RS 4
  480. \fBinsertLegend()\fP
  481. .RE
  482. .PP
  483. .SS "const QwtAbstractLegend * QwtPolarPlot::legend () const"
  484. .PP
  485. \fBReturns:\fP
  486. .RS 4
  487. the plot's legend
  488. .RE
  489. .PP
  490. \fBSee Also:\fP
  491. .RS 4
  492. \fBinsertLegend()\fP
  493. .RE
  494. .PP
  495. .SS "void QwtPolarPlot::legendDataChanged (const QVariant &itemInfo, const QList< QwtLegendData > &data)\fC [signal]\fP"
  496. A signal with the attributes how to update the legend entries for a plot item\&.
  497. .PP
  498. \fBParameters:\fP
  499. .RS 4
  500. \fIitemInfo\fP Info about a plot, build from \fBitemToInfo()\fP
  501. .RE
  502. .PP
  503. \fBSee Also:\fP
  504. .RS 4
  505. \fBitemToInfo()\fP, \fBinfoToItem()\fP, QwtAbstractLegend::updateLegend()
  506. .RE
  507. .PP
  508. .SS "const QBrush & QwtPolarPlot::plotBackground () const"
  509. .PP
  510. \fBReturns:\fP
  511. .RS 4
  512. plot background brush
  513. .RE
  514. .PP
  515. \fBSee Also:\fP
  516. .RS 4
  517. \fBplotBackground()\fP, plotArea()
  518. .RE
  519. .PP
  520. .SS "\fBQwtPolarLayout\fP * QwtPolarPlot::plotLayout ()"
  521. .PP
  522. \fBReturns:\fP
  523. .RS 4
  524. Layout, responsible for the geometry of the plot components
  525. .RE
  526. .PP
  527. .SS "const \fBQwtPolarLayout\fP * QwtPolarPlot::plotLayout () const"
  528. .PP
  529. \fBReturns:\fP
  530. .RS 4
  531. Layout, responsible for the geometry of the plot components
  532. .RE
  533. .PP
  534. .SS "int QwtPolarPlot::plotMarginHint () const"
  535. .PP
  536. \fBReturns:\fP
  537. .RS 4
  538. Maximum of all item margin hints\&.
  539. .RE
  540. .PP
  541. \fBSee Also:\fP
  542. .RS 4
  543. \fBQwtPolarItem::marginHint()\fP
  544. .RE
  545. .PP
  546. .SS "QRectF QwtPolarPlot::plotRect () const"
  547. The plot area depends on the size of the canvas and the zoom parameters\&.
  548. .PP
  549. \fBReturns:\fP
  550. .RS 4
  551. Bounding rect of the plot area
  552. .RE
  553. .PP
  554. .SS "QRectF QwtPolarPlot::plotRect (const QRectF &canvasRect) const"
  555. .PP
  556. Calculate the bounding rect of the plot area\&. The plot area depends on the zoom parameters\&.
  557. .PP
  558. \fBParameters:\fP
  559. .RS 4
  560. \fIcanvasRect\fP Rectangle of the canvas
  561. .RE
  562. .PP
  563. \fBReturns:\fP
  564. .RS 4
  565. Rectangle for displaying 100% of the plot
  566. .RE
  567. .PP
  568. .SS "void QwtPolarPlot::replot ()\fC [virtual]\fP, \fC [slot]\fP"
  569. .PP
  570. Redraw the plot\&. If the autoReplot option is not set (which is the default) or if any curves are attached to raw data, the plot has to be refreshed explicitly in order to make changes visible\&.
  571. .PP
  572. \fBSee Also:\fP
  573. .RS 4
  574. \fBsetAutoReplot()\fP
  575. .RE
  576. .PP
  577. \fBWarning:\fP
  578. .RS 4
  579. Calls \fBcanvas()\fP->repaint, take care of infinite recursions
  580. .RE
  581. .PP
  582. .SS "const QwtScaleDiv * QwtPolarPlot::scaleDiv (intscaleId) const"
  583. .PP
  584. Return the scale division of a specified scale\&. scaleDiv(scaleId)->lBound(), scaleDiv(scaleId)->hBound() are the current limits of the scale\&.
  585. .PP
  586. \fBParameters:\fP
  587. .RS 4
  588. \fIscaleId\fP Scale index
  589. .RE
  590. .PP
  591. \fBReturns:\fP
  592. .RS 4
  593. Scale division
  594. .RE
  595. .PP
  596. \fBSee Also:\fP
  597. .RS 4
  598. QwtScaleDiv, \fBsetScaleDiv()\fP, \fBsetScale()\fP
  599. .RE
  600. .PP
  601. .SS "QwtScaleDiv * QwtPolarPlot::scaleDiv (intscaleId)"
  602. .PP
  603. Return the scale division of a specified scale\&. scaleDiv(scaleId)->lBound(), scaleDiv(scaleId)->hBound() are the current limits of the scale\&.
  604. .PP
  605. \fBParameters:\fP
  606. .RS 4
  607. \fIscaleId\fP Scale index
  608. .RE
  609. .PP
  610. \fBReturns:\fP
  611. .RS 4
  612. Scale division
  613. .RE
  614. .PP
  615. \fBSee Also:\fP
  616. .RS 4
  617. QwtScaleDiv, \fBsetScaleDiv()\fP, \fBsetScale()\fP
  618. .RE
  619. .PP
  620. .SS "QwtScaleEngine * QwtPolarPlot::scaleEngine (intscaleId)"
  621. .PP
  622. \fBReturns:\fP
  623. .RS 4
  624. Scale engine for a specific scale
  625. .RE
  626. .PP
  627. \fBParameters:\fP
  628. .RS 4
  629. \fIscaleId\fP Scale index
  630. .RE
  631. .PP
  632. \fBSee Also:\fP
  633. .RS 4
  634. \fBsetScaleEngine()\fP
  635. .RE
  636. .PP
  637. .SS "const QwtScaleEngine * QwtPolarPlot::scaleEngine (intscaleId) const"
  638. .PP
  639. \fBReturns:\fP
  640. .RS 4
  641. Scale engine for a specific scale
  642. .RE
  643. .PP
  644. \fBParameters:\fP
  645. .RS 4
  646. \fIscaleId\fP Scale index
  647. .RE
  648. .PP
  649. \fBSee Also:\fP
  650. .RS 4
  651. \fBsetScaleEngine()\fP
  652. .RE
  653. .PP
  654. .SS "QwtScaleMap QwtPolarPlot::scaleMap (intscaleId, doubleradius) const"
  655. Build a scale map
  656. .PP
  657. The azimuth map translates between the scale values and angles from [0\&.0, 2 * PI[\&. The radial map translates scale values into the distance from the pole\&.
  658. .PP
  659. \fBParameters:\fP
  660. .RS 4
  661. \fIscaleId\fP Scale index
  662. .br
  663. \fIradius\fP Radius of the plot are in pixels
  664. .RE
  665. .PP
  666. \fBReturns:\fP
  667. .RS 4
  668. Map for the scale on the canvas\&. With this map pixel coordinates can translated to plot coordinates and vice versa\&.
  669. .RE
  670. .PP
  671. \fBSee Also:\fP
  672. .RS 4
  673. QwtScaleMap, transform(), invTransform()
  674. .RE
  675. .PP
  676. .SS "QwtScaleMap QwtPolarPlot::scaleMap (intscaleId) const"
  677. Build a scale map
  678. .PP
  679. The azimuth map translates between the scale values and angles from [0\&.0, 2 * PI[\&. The radial map translates scale values into the distance from the pole\&. The radial map is calculated from the current geometry of the canvas\&.
  680. .PP
  681. \fBParameters:\fP
  682. .RS 4
  683. \fIscaleId\fP Scale index
  684. .RE
  685. .PP
  686. \fBReturns:\fP
  687. .RS 4
  688. Map for the scale on the canvas\&. With this map pixel coordinates can translated to plot coordinates and vice versa\&.
  689. .RE
  690. .PP
  691. \fBSee Also:\fP
  692. .RS 4
  693. QwtScaleMap, transform(), invTransform()
  694. .RE
  695. .PP
  696. .SS "int QwtPolarPlot::scaleMaxMajor (intscaleId) const"
  697. .PP
  698. \fBReturns:\fP
  699. .RS 4
  700. the maximum number of major ticks for a specified axis
  701. .RE
  702. .PP
  703. \fBParameters:\fP
  704. .RS 4
  705. \fIscaleId\fP Scale index
  706. .RE
  707. .PP
  708. \fBSee Also:\fP
  709. .RS 4
  710. \fBsetScaleMaxMajor()\fP
  711. .RE
  712. .PP
  713. .SS "int QwtPolarPlot::scaleMaxMinor (intscaleId) const"
  714. .PP
  715. \fBReturns:\fP
  716. .RS 4
  717. the maximum number of minor ticks for a specified axis
  718. .RE
  719. .PP
  720. \fBParameters:\fP
  721. .RS 4
  722. \fIscaleId\fP Scale index
  723. .RE
  724. .PP
  725. \fBSee Also:\fP
  726. .RS 4
  727. \fBsetScaleMaxMinor()\fP
  728. .RE
  729. .PP
  730. .SS "void QwtPolarPlot::setAutoReplot (boolenable = \fCtrue\fP)"
  731. .PP
  732. Set or reset the autoReplot option\&. If the autoReplot option is set, the plot will be updated implicitly by manipulating member functions\&. Since this may be time-consuming, it is recommended to leave this option switched off and call \fBreplot()\fP explicitly if necessary\&.
  733. .PP
  734. The autoReplot option is set to false by default, which means that the user has to call \fBreplot()\fP in order to make changes visible\&.
  735. .PP
  736. \fBParameters:\fP
  737. .RS 4
  738. \fIenable\fP \fCtrue\fP or \fCfalse\fP\&. Defaults to \fCtrue\fP\&.
  739. .RE
  740. .PP
  741. \fBSee Also:\fP
  742. .RS 4
  743. \fBreplot()\fP
  744. .RE
  745. .PP
  746. .SS "void QwtPolarPlot::setAutoScale (intscaleId)"
  747. .PP
  748. Enable autoscaling\&. This member function is used to switch back to autoscaling mode after a fixed scale has been set\&. Autoscaling calculates a useful scale division from the bounding interval of all plot items with the \fBQwtPolarItem::AutoScale\fP attribute\&.
  749. .PP
  750. Autoscaling is only supported for the radial scale and enabled as default\&.
  751. .PP
  752. \fBParameters:\fP
  753. .RS 4
  754. \fIscaleId\fP Scale index
  755. .RE
  756. .PP
  757. \fBSee Also:\fP
  758. .RS 4
  759. \fBhasAutoScale()\fP, \fBsetScale()\fP, \fBsetScaleDiv()\fP, \fBQwtPolarItem::boundingInterval()\fP
  760. .RE
  761. .PP
  762. .SS "void QwtPolarPlot::setAzimuthOrigin (doubleorigin)\fC [slot]\fP"
  763. .PP
  764. Change the origin of the azimuth scale\&. The azimuth origin is the angle where the azimuth scale shows the value 0\&.0\&. The default origin is 0\&.0\&.
  765. .PP
  766. \fBParameters:\fP
  767. .RS 4
  768. \fIorigin\fP New origin
  769. .RE
  770. .PP
  771. \fBSee Also:\fP
  772. .RS 4
  773. \fBazimuthOrigin()\fP
  774. .RE
  775. .PP
  776. .SS "void QwtPolarPlot::setPlotBackground (const QBrush &brush)"
  777. .PP
  778. Set the background of the plot area\&. The plot area is the circle around the pole\&. It's radius is defined by the radial scale\&.
  779. .PP
  780. \fBParameters:\fP
  781. .RS 4
  782. \fIbrush\fP Background Brush
  783. .RE
  784. .PP
  785. \fBSee Also:\fP
  786. .RS 4
  787. \fBplotBackground()\fP, plotArea()
  788. .RE
  789. .PP
  790. .SS "void QwtPolarPlot::setScale (intscaleId, doublemin, doublemax, doublestepSize = \fC0\fP)"
  791. .PP
  792. Disable autoscaling and specify a fixed scale for a selected scale\&.
  793. .PP
  794. \fBParameters:\fP
  795. .RS 4
  796. \fIscaleId\fP Scale index
  797. .br
  798. \fImin\fP
  799. .br
  800. \fImax\fP minimum and maximum of the scale
  801. .br
  802. \fIstepSize\fP Major step size\&. If \fCstep == 0\fP, the step size is calculated automatically using the maxMajor setting\&.
  803. .RE
  804. .PP
  805. \fBSee Also:\fP
  806. .RS 4
  807. \fBsetScaleMaxMajor()\fP, \fBsetAutoScale()\fP
  808. .RE
  809. .PP
  810. .SS "void QwtPolarPlot::setScaleDiv (intscaleId, const QwtScaleDiv &scaleDiv)"
  811. .PP
  812. Disable autoscaling and specify a fixed scale for a selected scale\&.
  813. .PP
  814. \fBParameters:\fP
  815. .RS 4
  816. \fIscaleId\fP Scale index
  817. .br
  818. \fIscaleDiv\fP Scale division
  819. .RE
  820. .PP
  821. \fBSee Also:\fP
  822. .RS 4
  823. \fBsetScale()\fP, \fBsetAutoScale()\fP
  824. .RE
  825. .PP
  826. .SS "void QwtPolarPlot::setScaleEngine (intscaleId, QwtScaleEngine *scaleEngine)"
  827. Change the scale engine for an axis
  828. .PP
  829. \fBParameters:\fP
  830. .RS 4
  831. \fIscaleId\fP Scale index
  832. .br
  833. \fIscaleEngine\fP Scale engine
  834. .RE
  835. .PP
  836. \fBSee Also:\fP
  837. .RS 4
  838. axisScaleEngine()
  839. .RE
  840. .PP
  841. .SS "void QwtPolarPlot::setScaleMaxMajor (intscaleId, intmaxMajor)"
  842. Set the maximum number of major scale intervals for a specified scale
  843. .PP
  844. \fBParameters:\fP
  845. .RS 4
  846. \fIscaleId\fP Scale index
  847. .br
  848. \fImaxMajor\fP maximum number of major steps
  849. .RE
  850. .PP
  851. \fBSee Also:\fP
  852. .RS 4
  853. \fBscaleMaxMajor()\fP
  854. .RE
  855. .PP
  856. .SS "void QwtPolarPlot::setScaleMaxMinor (intscaleId, intmaxMinor)"
  857. Set the maximum number of major scale intervals for a specified scale
  858. .PP
  859. \fBParameters:\fP
  860. .RS 4
  861. \fIscaleId\fP Scale index
  862. .br
  863. \fImaxMinor\fP maximum number of minor steps
  864. .RE
  865. .PP
  866. \fBSee Also:\fP
  867. .RS 4
  868. \fBscaleMaxMajor()\fP
  869. .RE
  870. .PP
  871. .SS "void QwtPolarPlot::setTitle (const QString &title)"
  872. Change the plot's title
  873. .PP
  874. \fBParameters:\fP
  875. .RS 4
  876. \fItitle\fP New title
  877. .RE
  878. .PP
  879. .SS "void QwtPolarPlot::setTitle (const QwtText &title)"
  880. Change the plot's title
  881. .PP
  882. \fBParameters:\fP
  883. .RS 4
  884. \fItitle\fP New title
  885. .RE
  886. .PP
  887. .SS "QwtText QwtPolarPlot::title () const"
  888. .PP
  889. \fBReturns:\fP
  890. .RS 4
  891. the plot's title
  892. .RE
  893. .PP
  894. .SS "QwtTextLabel * QwtPolarPlot::titleLabel ()"
  895. .PP
  896. \fBReturns:\fP
  897. .RS 4
  898. the plot's title
  899. .RE
  900. .PP
  901. .SS "const QwtTextLabel * QwtPolarPlot::titleLabel () const"
  902. .PP
  903. \fBReturns:\fP
  904. .RS 4
  905. the plot's titel label\&.
  906. .RE
  907. .PP
  908. .SS "void QwtPolarPlot::unzoom ()"
  909. Unzoom the plot
  910. .PP
  911. \fBSee Also:\fP
  912. .RS 4
  913. \fBzoom()\fP
  914. .RE
  915. .PP
  916. .SS "void QwtPolarPlot::updateLegend ()"
  917. Emit \fBlegendDataChanged()\fP for all plot item
  918. .PP
  919. \fBSee Also:\fP
  920. .RS 4
  921. QwtPlotItem::legendData(), \fBlegendDataChanged()\fP
  922. .RE
  923. .PP
  924. .SS "void QwtPolarPlot::updateLegend (const \fBQwtPolarItem\fP *plotItem)"
  925. Emit \fBlegendDataChanged()\fP for a plot item
  926. .PP
  927. \fBParameters:\fP
  928. .RS 4
  929. \fIplotItem\fP Plot item
  930. .RE
  931. .PP
  932. \fBSee Also:\fP
  933. .RS 4
  934. QwtPlotItem::legendData(), \fBlegendDataChanged()\fP
  935. .RE
  936. .PP
  937. .SS "void QwtPolarPlot::updateScale (intscaleId)"
  938. Rebuild the scale
  939. .PP
  940. \fBParameters:\fP
  941. .RS 4
  942. \fIscaleId\fP Scale index
  943. .RE
  944. .PP
  945. .SS "QwtInterval QwtPolarPlot::visibleInterval () const"
  946. .PP
  947. \fBReturns:\fP
  948. .RS 4
  949. Bounding interval of the radial scale that is visible on the canvas\&.
  950. .RE
  951. .PP
  952. .SS "void QwtPolarPlot::zoom (const QwtPointPolar &zoomPos, doublezoomFactor)"
  953. .PP
  954. Translate and in/decrease the zoom factor\&. In zoom mode the zoom position is in the center of the canvas\&. The radius of the circle depends on the size of the plot canvas, that is devided by the zoom factor\&. Thus a factor < 1\&.0 zoom in\&.
  955. .PP
  956. Setting an invalid zoom position disables zooming\&.
  957. .PP
  958. \fBParameters:\fP
  959. .RS 4
  960. \fIzoomPos\fP Center of the translation
  961. .br
  962. \fIzoomFactor\fP Zoom factor
  963. .RE
  964. .PP
  965. \fBSee Also:\fP
  966. .RS 4
  967. \fBunzoom()\fP, \fBzoomPos()\fP, \fBzoomFactor()\fP
  968. .RE
  969. .PP
  970. .SS "double QwtPolarPlot::zoomFactor () const"
  971. .PP
  972. \fBReturns:\fP
  973. .RS 4
  974. Zoom factor
  975. .RE
  976. .PP
  977. \fBSee Also:\fP
  978. .RS 4
  979. \fBzoom()\fP, \fBzoomPos()\fP
  980. .RE
  981. .PP
  982. .SS "QwtPointPolar QwtPolarPlot::zoomPos () const"
  983. .PP
  984. \fBReturns:\fP
  985. .RS 4
  986. Zoom position
  987. .RE
  988. .PP
  989. \fBSee Also:\fP
  990. .RS 4
  991. \fBzoom()\fP, \fBzoomFactor()\fP
  992. .RE
  993. .PP
  994. .SH "Author"
  995. .PP
  996. Generated automatically by Doxygen for Qwt Polar User's Guide from the source code\&.