QwtLinearScaleEngine.3 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. .TH "QwtLinearScaleEngine" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtLinearScaleEngine \- A scale engine for linear scales\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_scale_engine\&.h>\fP
  11. .PP
  12. Inherits \fBQwtScaleEngine\fP\&.
  13. .PP
  14. Inherited by \fBQwtDateScaleEngine\fP\&.
  15. .SS "Public Member Functions"
  16. .in +1c
  17. .ti -1c
  18. .RI "\fBQwtLinearScaleEngine\fP (uint \fBbase\fP=10)"
  19. .br
  20. .ti -1c
  21. .RI "virtual \fB~QwtLinearScaleEngine\fP ()"
  22. .br
  23. .RI "Destructor\&. "
  24. .ti -1c
  25. .RI "virtual void \fBautoScale\fP (int maxNumSteps, double &x1, double &x2, double &stepSize) const"
  26. .br
  27. .ti -1c
  28. .RI "virtual \fBQwtScaleDiv\fP \fBdivideScale\fP (double x1, double x2, int maxMajorSteps, int maxMinorSteps, double stepSize=0\&.0) const"
  29. .br
  30. .RI "Calculate a scale division for an interval\&. "
  31. .in -1c
  32. .SS "Protected Member Functions"
  33. .in +1c
  34. .ti -1c
  35. .RI "\fBQwtInterval\fP \fBalign\fP (const \fBQwtInterval\fP &, double stepSize) const"
  36. .br
  37. .RI "Align an interval to a step size\&. "
  38. .ti -1c
  39. .RI "void \fBbuildTicks\fP (const \fBQwtInterval\fP &, double stepSize, int maxMinorSteps, QList< double > ticks[\fBQwtScaleDiv::NTickTypes\fP]) const"
  40. .br
  41. .RI "Calculate ticks for an interval\&. "
  42. .ti -1c
  43. .RI "QList< double > \fBbuildMajorTicks\fP (const \fBQwtInterval\fP &interval, double stepSize) const"
  44. .br
  45. .RI "Calculate major ticks for an interval\&. "
  46. .ti -1c
  47. .RI "void \fBbuildMinorTicks\fP (const QList< double > &majorTicks, int maxMinorSteps, double stepSize, QList< double > &minorTicks, QList< double > &mediumTicks) const"
  48. .br
  49. .RI "Calculate minor/medium ticks for major ticks\&. "
  50. .in -1c
  51. .SS "Additional Inherited Members"
  52. .SH "Detailed Description"
  53. .PP
  54. A scale engine for linear scales\&.
  55. The step size will fit into the pattern $\left\{ 1,2,5\right\} \cdot 10^{n}$, where n is an integer\&.
  56. .SH "Constructor & Destructor Documentation"
  57. .PP
  58. .SS "QwtLinearScaleEngine::QwtLinearScaleEngine (uint base = \fC10\fP)"
  59. Constructor
  60. .PP
  61. \fBParameters\fP
  62. .RS 4
  63. \fIbase\fP Base of the scale engine
  64. .RE
  65. .PP
  66. \fBSee also\fP
  67. .RS 4
  68. \fBsetBase()\fP
  69. .RE
  70. .PP
  71. .SH "Member Function Documentation"
  72. .PP
  73. .SS "\fBQwtInterval\fP QwtLinearScaleEngine::align (const \fBQwtInterval\fP & interval, double stepSize) const\fC [protected]\fP"
  74. .PP
  75. Align an interval to a step size\&. The limits of an interval are aligned that both are integer multiples of the step size\&.
  76. .PP
  77. \fBParameters\fP
  78. .RS 4
  79. \fIinterval\fP Interval
  80. .br
  81. \fIstepSize\fP Step size
  82. .RE
  83. .PP
  84. \fBReturns\fP
  85. .RS 4
  86. Aligned interval
  87. .RE
  88. .PP
  89. .SS "void QwtLinearScaleEngine::autoScale (int maxNumSteps, double & x1, double & x2, double & stepSize) const\fC [virtual]\fP"
  90. Align and divide an interval
  91. .PP
  92. \fBParameters\fP
  93. .RS 4
  94. \fImaxNumSteps\fP Max\&. number of steps
  95. .br
  96. \fIx1\fP First limit of the interval (In/Out)
  97. .br
  98. \fIx2\fP Second limit of the interval (In/Out)
  99. .br
  100. \fIstepSize\fP Step size (Out)
  101. .RE
  102. .PP
  103. \fBSee also\fP
  104. .RS 4
  105. \fBsetAttribute()\fP
  106. .RE
  107. .PP
  108. .PP
  109. Implements \fBQwtScaleEngine\fP\&.
  110. .PP
  111. Reimplemented in \fBQwtDateScaleEngine\fP\&.
  112. .SS "QList< double > QwtLinearScaleEngine::buildMajorTicks (const \fBQwtInterval\fP & interval, double stepSize) const\fC [protected]\fP"
  113. .PP
  114. Calculate major ticks for an interval\&.
  115. .PP
  116. \fBParameters\fP
  117. .RS 4
  118. \fIinterval\fP Interval
  119. .br
  120. \fIstepSize\fP Step size
  121. .RE
  122. .PP
  123. \fBReturns\fP
  124. .RS 4
  125. Calculated ticks
  126. .RE
  127. .PP
  128. .SS "void QwtLinearScaleEngine::buildMinorTicks (const QList< double > & majorTicks, int maxMinorSteps, double stepSize, QList< double > & minorTicks, QList< double > & mediumTicks) const\fC [protected]\fP"
  129. .PP
  130. Calculate minor/medium ticks for major ticks\&.
  131. .PP
  132. \fBParameters\fP
  133. .RS 4
  134. \fImajorTicks\fP Major ticks
  135. .br
  136. \fImaxMinorSteps\fP Maximum number of minor steps
  137. .br
  138. \fIstepSize\fP Step size
  139. .br
  140. \fIminorTicks\fP Array to be filled with the calculated minor ticks
  141. .br
  142. \fImediumTicks\fP Array to be filled with the calculated medium ticks
  143. .RE
  144. .PP
  145. .SS "void QwtLinearScaleEngine::buildTicks (const \fBQwtInterval\fP & interval, double stepSize, int maxMinorSteps, QList< double > ticks[QwtScaleDiv::NTickTypes]) const\fC [protected]\fP"
  146. .PP
  147. Calculate ticks for an interval\&.
  148. .PP
  149. \fBParameters\fP
  150. .RS 4
  151. \fIinterval\fP Interval
  152. .br
  153. \fIstepSize\fP Step size
  154. .br
  155. \fImaxMinorSteps\fP Maximum number of minor steps
  156. .br
  157. \fIticks\fP Arrays to be filled with the calculated ticks
  158. .RE
  159. .PP
  160. \fBSee also\fP
  161. .RS 4
  162. \fBbuildMajorTicks()\fP, \fBbuildMinorTicks\fP
  163. .RE
  164. .PP
  165. .SS "\fBQwtScaleDiv\fP QwtLinearScaleEngine::divideScale (double x1, double x2, int maxMajorSteps, int maxMinorSteps, double stepSize = \fC0\&.0\fP) const\fC [virtual]\fP"
  166. .PP
  167. Calculate a scale division for an interval\&.
  168. .PP
  169. \fBParameters\fP
  170. .RS 4
  171. \fIx1\fP First interval limit
  172. .br
  173. \fIx2\fP Second interval limit
  174. .br
  175. \fImaxMajorSteps\fP Maximum for the number of major steps
  176. .br
  177. \fImaxMinorSteps\fP Maximum number of minor steps
  178. .br
  179. \fIstepSize\fP Step size\&. If stepSize == 0, the engine calculates one\&.
  180. .RE
  181. .PP
  182. \fBReturns\fP
  183. .RS 4
  184. Calculated scale division
  185. .RE
  186. .PP
  187. .PP
  188. Implements \fBQwtScaleEngine\fP\&.
  189. .PP
  190. Reimplemented in \fBQwtDateScaleEngine\fP\&.
  191. .SH "Author"
  192. .PP
  193. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.