\class Plot \brief Plot is a line graph to display two dimensional data. */
| 196 | \brief Plot is a line graph to display two dimensional data. |
| 197 | */ |
| 198 | class Plot { |
| 199 | private: |
| 200 | fg_plot mValue; |
| 201 | |
| 202 | public: |
| 203 | /** |
| 204 | Creates a Plot object |
| 205 | |
| 206 | \param[in] pNumPoints is number of data points to display |
| 207 | \param[in] pDataType takes one of the values of \ref dtype that indicates |
| 208 | the integral data type of plot data |
| 209 | \param[in] pChartType dictates the dimensionality of the chart |
| 210 | \param[in] pPlotType dictates the type of plot/graph, |
| 211 | it can take one of the values of \ref PlotType |
| 212 | \param[in] pMarkerType indicates which symbol is rendered as marker. It can take one of |
| 213 | the values of \ref MarkerType. |
| 214 | */ |
| 215 | FGAPI Plot(const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType, |
| 216 | const PlotType pPlotType=FG_PLOT_LINE, const MarkerType pMarkerType=FG_MARKER_NONE); |
| 217 | |
| 218 | /** |
| 219 | Copy constructor for Plot |
| 220 | |
| 221 | \param[in] pOther is the Plot of which we make a copy of. |
| 222 | */ |
| 223 | FGAPI Plot(const Plot& pOther); |
| 224 | |
| 225 | /** |
| 226 | Construct Plot ojbect from fg_plot resource handle |
| 227 | |
| 228 | \param[in] pHandle is the input fg_plot resource handle |
| 229 | |
| 230 | \note This kind of construction assumes ownership of the resource handle |
| 231 | is released during the Plot object's destruction. |
| 232 | */ |
| 233 | FGAPI explicit Plot(const fg_plot pHandle); |
| 234 | |
| 235 | /** |
| 236 | Plot Destructor |
| 237 | */ |
| 238 | FGAPI ~Plot(); |
| 239 | |
| 240 | /** |
| 241 | Set the color of line graph(plot) |
| 242 | |
| 243 | \param[in] pColor takes values of forge::Color to define plot color |
| 244 | */ |
| 245 | FGAPI void setColor(const forge::Color pColor); |
| 246 | |
| 247 | /** |
| 248 | Set the color of line graph(plot) |
| 249 | |
| 250 | \param[in] pRed is Red component in range [0, 1] |
| 251 | \param[in] pGreen is Green component in range [0, 1] |
| 252 | \param[in] pBlue is Blue component in range [0, 1] |
| 253 | \param[in] pAlpha is Blue component in range [0, 1] |
| 254 | */ |
| 255 | FGAPI void setColor(const float pRed, const float pGreen, |
nothing calls this directly
no outgoing calls
no test coverage detected