\class Surface \brief Surface is a graph to display three dimensional data. */
| 161 | \brief Surface is a graph to display three dimensional data. |
| 162 | */ |
| 163 | class Surface { |
| 164 | private: |
| 165 | fg_surface mValue; |
| 166 | |
| 167 | public: |
| 168 | /** |
| 169 | Creates a Surface object |
| 170 | |
| 171 | \param[in] pNumXPoints is number of data points along X dimension |
| 172 | \param[in] pNumYPoints is number of data points along Y dimension |
| 173 | \param[in] pDataType takes one of the values of \ref dtype that indicates |
| 174 | the integral data type of surface data |
| 175 | \param[in] pPlotType is the render type which can be one of \ref PlotType (valid choices |
| 176 | are FG_PLOT_SURFACE and FG_PLOT_SCATTER) |
| 177 | \param[in] pMarkerType is the type of \ref MarkerType to draw for \ref FG_PLOT_SCATTER plot type |
| 178 | */ |
| 179 | FGAPI Surface(const unsigned pNumXPoints, const unsigned pNumYPoints, const dtype pDataType, |
| 180 | const PlotType pPlotType=FG_PLOT_SURFACE, const MarkerType pMarkerType=FG_MARKER_NONE); |
| 181 | |
| 182 | /** |
| 183 | Copy constructor for surface |
| 184 | |
| 185 | \param[in] pOther is the surface of which we make a copy of. |
| 186 | */ |
| 187 | FGAPI Surface(const Surface& pOther); |
| 188 | |
| 189 | /** |
| 190 | Construct Surface ojbect from fg_surface resource handle |
| 191 | |
| 192 | \param[in] pHandle is the input fg_surface resource handle |
| 193 | |
| 194 | \note This kind of construction assumes ownership of the resource handle |
| 195 | is released during the Surface object's destruction. |
| 196 | */ |
| 197 | FGAPI explicit Surface(const fg_surface pHandle); |
| 198 | |
| 199 | /** |
| 200 | surface Destructor |
| 201 | */ |
| 202 | FGAPI ~Surface(); |
| 203 | |
| 204 | /** |
| 205 | Set the color of line graph(surface) |
| 206 | |
| 207 | \param[in] pColor takes values of forge::Color to define surface color |
| 208 | */ |
| 209 | FGAPI void setColor(const forge::Color pColor); |
| 210 | |
| 211 | /** |
| 212 | Set the color of line graph(surface) |
| 213 | |
| 214 | \param[in] pRed is Red component in range [0, 1] |
| 215 | \param[in] pGreen is Green component in range [0, 1] |
| 216 | \param[in] pBlue is Blue component in range [0, 1] |
| 217 | \param[in] pAlpha is Blue component in range [0, 1] |
| 218 | */ |
| 219 | FGAPI void setColor(const float pRed, const float pGreen, |
| 220 | const float pBlue, const float pAlpha); |
nothing calls this directly
no outgoing calls
no test coverage detected