]>
Commit | Line | Data |
---|---|---|
a796957a RR |
1 | % |
2 | % automatically generated by HelpGen from | |
3 | % plot.h at 11/Feb/00 18:00:57 | |
4 | % | |
5 | ||
6 | \section{\class{wxPlotCurve}}\label{wxplotcurve} | |
7 | ||
8 | The wxPlotCurve class represents a curve displayed in a \helpref{wxPlotWindow}{wxplotwindow}. It | |
9 | is a virtual curve, i.e. is acts only as an interface, leaving it to the programmer to care for | |
10 | how the values pairs are matched. wxPlotWindow and wxPlotCurve are designed to display large | |
11 | amounts of data, i.e. most typically data measured by some sort of machine. | |
12 | ||
13 | This class is abstract, i.e. you have to derive your own class and implement the pure | |
14 | virtual functions (\helpref{GetStartX()}{wxplotcurvegetstartx}, \helpref{GetEndX()}{wxplotcurvegetendx} | |
15 | and \helpref{GetY()}{wxplotcurvegety}). | |
16 | ||
17 | \wxheading{Derived from} | |
18 | ||
19 | \helpref{wxObject}{wxobject} | |
20 | ||
21 | \latexignore{\rtfignore{\wxheading{Members}}} | |
22 | ||
23 | \membersection{wxPlotCurve::wxPlotCurve}\label{wxplotcurvewxplotcurve} | |
24 | ||
25 | \func{}{wxPlotCurve}{\param{int }{offsetY}, \param{double }{startY}, \param{double }{endY}} | |
26 | ||
27 | Constructor assigning start values. See below for interpretation. | |
28 | ||
29 | \membersection{wxPlotCurve::GetStartX}\label{wxplotcurvegetstartx} | |
30 | ||
31 | \func{wxInt32}{GetStartX}{\void} | |
32 | ||
33 | Must be overridden. This function should return the index of the first value | |
34 | of this curve, typically zero. | |
35 | ||
36 | \membersection{wxPlotCurve::GetEndX}\label{wxplotcurvegetendx} | |
37 | ||
38 | \func{wxInt32}{GetEndX}{\void} | |
39 | ||
40 | Must be overridden. This function should return the index of the last value | |
41 | of this curve, typically 99 if 100 values have been measured. | |
42 | ||
43 | \membersection{wxPlotCurve::GetY}\label{wxplotcurvegety} | |
44 | ||
45 | \func{double}{GetY}{\param{wxInt32 }{x}} | |
46 | ||
47 | Must be overridden. This function will return the actual Y value corresponding | |
48 | to the given X value. The x value is of an integer type because it is considered | |
49 | to be an index in row of measured values. | |
50 | ||
51 | \membersection{wxPlotCurve::SetStartY}\label{wxplotcurvesetstarty} | |
52 | ||
53 | \func{void}{SetStartY}{\param{double }{startY}} | |
54 | ||
55 | The value returned by this function tells the plot window what the lowest values | |
56 | in the curve will be os that a suitable scale can be found for the display. If | |
57 | the Y values in this curve are in the range of -1.5 to 0.5, this function should | |
58 | return -1.5 or maybe -2.0 for nicer optics. | |
59 | ||
60 | \membersection{wxPlotCurve::GetStartY}\label{wxplotcurvegetstarty} | |
61 | ||
62 | \func{double}{GetStartY}{\void} | |
63 | ||
64 | See \helpref{SetStartY}{wxplotcurvesetstarty}. | |
65 | ||
66 | \membersection{wxPlotCurve::SetEndY}\label{wxplotcurvesetendy} | |
67 | ||
68 | \func{void}{SetEndY}{\param{double }{endY}} | |
69 | ||
70 | The value returned by this function tells the plot window what the highest values | |
71 | in the curve will be os that a suitable scale can be found for the display. If | |
72 | the Y values in this curve are in the range of -1.5 to 0.5, this function should | |
73 | return 0.5 or maybe 1.0 for nicer optics. | |
74 | ||
75 | \membersection{wxPlotCurve::GetEndY}\label{wxplotcurvegetendy} | |
76 | ||
77 | \func{double}{GetEndY}{\void} | |
78 | ||
79 | See \helpref{SetStartY}{wxplotcurvesetendy}. | |
80 | ||
81 | \membersection{wxPlotCurve::SetOffsetY}\label{wxplotcurvesetoffsety} | |
82 | ||
83 | \func{void}{SetOffsetY}{\param{int }{offsetY}} | |
84 | ||
85 | When displaying several curves in one window, it is often useful to assign | |
86 | different offsets to the curves. You should call \helpref{wxPlotWindow::Move}{wxplotwindowmove} | |
87 | to set this value after you have added the curve to the window. | |
88 | ||
89 | \membersection{wxPlotCurve::GetOffsetY}\label{wxplotcurvegetoffsety} | |
90 | ||
91 | \func{int}{GetOffsetY}{\void} | |
92 | ||
93 | Returns the vertical offset. |