QwtSimpleCompassRose.3 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. .TH "QwtSimpleCompassRose" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtSimpleCompassRose \- A simple rose for \fBQwtCompass\fP\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_compass_rose\&.h>\fP
  11. .PP
  12. Inherits \fBQwtCompassRose\fP\&.
  13. .SS "Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "\fBQwtSimpleCompassRose\fP (int \fBnumThorns\fP=8, int \fBnumThornLevels\fP=\-1)"
  17. .br
  18. .ti -1c
  19. .RI "virtual \fB~QwtSimpleCompassRose\fP ()"
  20. .br
  21. .RI "Destructor\&. "
  22. .ti -1c
  23. .RI "void \fBsetWidth\fP (double)"
  24. .br
  25. .ti -1c
  26. .RI "double \fBwidth\fP () const"
  27. .br
  28. .ti -1c
  29. .RI "void \fBsetNumThorns\fP (int)"
  30. .br
  31. .ti -1c
  32. .RI "int \fBnumThorns\fP () const"
  33. .br
  34. .ti -1c
  35. .RI "void \fBsetNumThornLevels\fP (int)"
  36. .br
  37. .ti -1c
  38. .RI "int \fBnumThornLevels\fP () const"
  39. .br
  40. .ti -1c
  41. .RI "void \fBsetShrinkFactor\fP (double factor)"
  42. .br
  43. .ti -1c
  44. .RI "double \fBshrinkFactor\fP () const"
  45. .br
  46. .ti -1c
  47. .RI "virtual void \fBdraw\fP (QPainter *, const QPointF &center, double radius, double north, QPalette::ColorGroup=QPalette::Active) const"
  48. .br
  49. .in -1c
  50. .SS "Static Public Member Functions"
  51. .in +1c
  52. .ti -1c
  53. .RI "static void \fBdrawRose\fP (QPainter *, const QPalette &, const QPointF &center, double radius, double north, double \fBwidth\fP, int \fBnumThorns\fP, int \fBnumThornLevels\fP, double \fBshrinkFactor\fP)"
  54. .br
  55. .in -1c
  56. .SH "Detailed Description"
  57. .PP
  58. A simple rose for \fBQwtCompass\fP\&.
  59. .SH "Constructor & Destructor Documentation"
  60. .PP
  61. .SS "QwtSimpleCompassRose::QwtSimpleCompassRose (int numThorns = \fC8\fP, int numThornLevels = \fC\-1\fP)"
  62. Constructor
  63. .PP
  64. \fBParameters\fP
  65. .RS 4
  66. \fInumThorns\fP Number of thorns
  67. .br
  68. \fInumThornLevels\fP Number of thorn levels
  69. .RE
  70. .PP
  71. .SH "Member Function Documentation"
  72. .PP
  73. .SS "void QwtSimpleCompassRose::draw (QPainter * painter, const QPointF & center, double radius, double north, QPalette::ColorGroup cg = \fCQPalette::Active\fP) const\fC [virtual]\fP"
  74. Draw the rose
  75. .PP
  76. \fBParameters\fP
  77. .RS 4
  78. \fIpainter\fP Painter
  79. .br
  80. \fIcenter\fP Center point
  81. .br
  82. \fIradius\fP Radius of the rose
  83. .br
  84. \fInorth\fP Position
  85. .br
  86. \fIcg\fP Color group
  87. .RE
  88. .PP
  89. .PP
  90. Implements \fBQwtCompassRose\fP\&.
  91. .SS "void QwtSimpleCompassRose::drawRose (QPainter * painter, const QPalette & palette, const QPointF & center, double radius, double north, double width, int numThorns, int numThornLevels, double shrinkFactor)\fC [static]\fP"
  92. Draw the rose
  93. .PP
  94. \fBParameters\fP
  95. .RS 4
  96. \fIpainter\fP Painter
  97. .br
  98. \fIpalette\fP Palette
  99. .br
  100. \fIcenter\fP Center of the rose
  101. .br
  102. \fIradius\fP Radius of the rose
  103. .br
  104. \fInorth\fP Position pointing to north
  105. .br
  106. \fIwidth\fP Width of the rose
  107. .br
  108. \fInumThorns\fP Number of thorns
  109. .br
  110. \fInumThornLevels\fP Number of thorn levels
  111. .br
  112. \fIshrinkFactor\fP Factor to shrink the thorns with each level
  113. .RE
  114. .PP
  115. .SS "int QwtSimpleCompassRose::numThornLevels () const"
  116. .PP
  117. \fBReturns\fP
  118. .RS 4
  119. Number of thorn levels
  120. .RE
  121. .PP
  122. \fBSee also\fP
  123. .RS 4
  124. \fBsetNumThorns()\fP, \fBsetNumThornLevels()\fP
  125. .RE
  126. .PP
  127. .SS "int QwtSimpleCompassRose::numThorns () const"
  128. .PP
  129. \fBReturns\fP
  130. .RS 4
  131. Number of thorns
  132. .RE
  133. .PP
  134. \fBSee also\fP
  135. .RS 4
  136. \fBsetNumThorns()\fP, \fBsetNumThornLevels()\fP
  137. .RE
  138. .PP
  139. .SS "void QwtSimpleCompassRose::setNumThornLevels (int numThornLevels)"
  140. Set the of thorns levels
  141. .PP
  142. \fBParameters\fP
  143. .RS 4
  144. \fInumThornLevels\fP Number of thorns levels
  145. .RE
  146. .PP
  147. \fBSee also\fP
  148. .RS 4
  149. \fBsetNumThorns()\fP, \fBnumThornLevels()\fP
  150. .RE
  151. .PP
  152. .SS "void QwtSimpleCompassRose::setNumThorns (int numThorns)"
  153. Set the number of thorns on one level The number is aligned to a multiple of 4, with a minimum of 4
  154. .PP
  155. \fBParameters\fP
  156. .RS 4
  157. \fInumThorns\fP Number of thorns
  158. .RE
  159. .PP
  160. \fBSee also\fP
  161. .RS 4
  162. \fBnumThorns()\fP, \fBsetNumThornLevels()\fP
  163. .RE
  164. .PP
  165. .SS "void QwtSimpleCompassRose::setShrinkFactor (double factor)"
  166. Set the Factor how to shrink the thorns with each level The default value is 0\&.9\&.
  167. .PP
  168. \fBParameters\fP
  169. .RS 4
  170. \fIfactor\fP Shrink factor
  171. .RE
  172. .PP
  173. \fBSee also\fP
  174. .RS 4
  175. \fBshrinkFactor()\fP
  176. .RE
  177. .PP
  178. .SS "void QwtSimpleCompassRose::setWidth (double width)"
  179. Set the width of the rose heads\&. Lower value make thinner heads\&. The range is limited from 0\&.03 to 0\&.4\&.
  180. .PP
  181. \fBParameters\fP
  182. .RS 4
  183. \fIwidth\fP Width
  184. .RE
  185. .PP
  186. .SS "double QwtSimpleCompassRose::shrinkFactor () const"
  187. .PP
  188. \fBReturns\fP
  189. .RS 4
  190. Factor how to shrink the thorns with each level
  191. .RE
  192. .PP
  193. \fBSee also\fP
  194. .RS 4
  195. \fBsetShrinkFactor()\fP
  196. .RE
  197. .PP
  198. .SS "double QwtSimpleCompassRose::width () const"
  199. .PP
  200. \fBReturns\fP
  201. .RS 4
  202. Width of the rose
  203. .RE
  204. .PP
  205. \fBSee also\fP
  206. .RS 4
  207. \fBsetWidth()\fP
  208. .RE
  209. .PP
  210. .SH "Author"
  211. .PP
  212. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.