Forge
plot.h
Go to the documentation of this file.
1 /*******************************************************
2  * Copyright (c) 2015-2019, ArrayFire
3  * All rights reserved.
4  *
5  * This file is distributed under 3-clause BSD license.
6  * The complete license agreement can be obtained at:
7  * http://arrayfire.com/licenses/BSD-3-Clause
8  ********************************************************/
9 
10 #pragma once
11 
12 #include <fg/defines.h>
13 
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
39  const unsigned pNPoints, const fg_dtype pType,
40  const fg_chart_type pChartType,
41  const fg_plot_type pPlotType,
42  const fg_marker_type pMarkerType);
43 
53 
62 
75  const float pRed, const float pGreen,
76  const float pBlue, const float pAlpha);
77 
86 FGAPI fg_err fg_set_plot_legend(fg_plot pPlot, const char* pLegend);
87 
99 FGAPI fg_err fg_set_plot_marker_size(fg_plot pPlot, const float pMarkerSize);
100 
109 FGAPI fg_err fg_get_plot_vertex_buffer(unsigned* pOut, const fg_plot pPlot);
110 
119 FGAPI fg_err fg_get_plot_color_buffer(unsigned* pOut, const fg_plot pPlot);
120 
129 FGAPI fg_err fg_get_plot_alpha_buffer(unsigned* pOut, const fg_plot pPlot);
130 
139 FGAPI fg_err fg_get_plot_radii_buffer(unsigned* pOut, const fg_plot pPlot);
140 
149 FGAPI fg_err fg_get_plot_vertex_buffer_size(unsigned* pOut, const fg_plot pPlot);
150 
159 FGAPI fg_err fg_get_plot_color_buffer_size(unsigned* pOut, const fg_plot pPlot);
160 
169 FGAPI fg_err fg_get_plot_alpha_buffer_size(unsigned* pOut, const fg_plot pPlot);
170 
179 FGAPI fg_err fg_get_plot_radii_buffer_size(unsigned* pOut, const fg_plot pPlot);
180 
183 #ifdef __cplusplus
184 }
185 #endif
186 
187 
188 #ifdef __cplusplus
189 
190 namespace forge
191 {
192 
198 class Plot {
199  private:
200  fg_plot mValue;
201 
202  public:
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 
223  FGAPI Plot(const Plot& pOther);
224 
233  FGAPI explicit Plot(const fg_plot pHandle);
234 
238  FGAPI ~Plot();
239 
245  FGAPI void setColor(const forge::Color pColor);
246 
255  FGAPI void setColor(const float pRed, const float pGreen,
256  const float pBlue, const float pAlpha);
257 
263  FGAPI void setLegend(const char* pLegend);
264 
273  FGAPI void setMarkerSize(const float pMarkerSize);
274 
280  FGAPI unsigned vertices() const;
281 
287  FGAPI unsigned colors() const;
288 
294  FGAPI unsigned alphas() const;
295 
301  FGAPI unsigned radii() const;
302 
308  FGAPI unsigned verticesSize() const;
309 
315  FGAPI unsigned colorsSize() const;
316 
322  FGAPI unsigned alphasSize() const;
323 
329  FGAPI unsigned radiiSize() const;
330 
334  FGAPI fg_plot get() const;
335 };
336 
337 }
338 
339 #endif
forge::Plot::~Plot
FGAPI ~Plot()
Plot Destructor.
fg_get_plot_alpha_buffer_size
FGAPI fg_err fg_get_plot_alpha_buffer_size(unsigned *pOut, const fg_plot pPlot)
Get the alpha values buffer size in bytes.
fg_release_plot
FGAPI fg_err fg_release_plot(fg_plot pPlot)
Destroy plot object.
forge::Plot
Plot is a line graph to display two dimensional data.
Definition: plot.h:198
FG_MARKER_NONE
@ FG_MARKER_NONE
No marker.
Definition: defines.h:167
fg_plot
void * fg_plot
Definition: defines.h:45
forge::dtype
dtype
Definition: defines.h:188
fg_err
fg_err
Definition: defines.h:49
fg_get_plot_alpha_buffer
FGAPI fg_err fg_get_plot_alpha_buffer(unsigned *pOut, const fg_plot pPlot)
Get the resource identifier for alpha values buffer.
fg_get_plot_radii_buffer_size
FGAPI fg_err fg_get_plot_radii_buffer_size(unsigned *pOut, const fg_plot pPlot)
Get the markers buffer size in bytes.
forge::Plot::setLegend
FGAPI void setLegend(const char *pLegend)
Set plot legend.
fg_get_plot_color_buffer_size
FGAPI fg_err fg_get_plot_color_buffer_size(unsigned *pOut, const fg_plot pPlot)
Get the colors buffer size in bytes.
forge::Plot::vertices
FGAPI unsigned vertices() const
Get the buffer identifier for vertices.
fg_get_plot_color_buffer
FGAPI fg_err fg_get_plot_color_buffer(unsigned *pOut, const fg_plot pPlot)
Get the resource identifier for colors buffer.
forge::Plot::setColor
FGAPI void setColor(const forge::Color pColor)
Set the color of line graph(plot)
forge::Plot::colors
FGAPI unsigned colors() const
Get the buffer identifier for color values per vertex.
FG_PLOT_LINE
@ FG_PLOT_LINE
Line plot.
Definition: defines.h:161
forge::Plot::radiiSize
FGAPI unsigned radiiSize() const
Get the marker sizes buffer size in bytes.
fg_dtype
fg_dtype
Definition: defines.h:150
forge
Definition: chart.h:304
forge::Plot::verticesSize
FGAPI unsigned verticesSize() const
Get the vertex buffer size in bytes.
forge::Plot::setMarkerSize
FGAPI void setMarkerSize(const float pMarkerSize)
Set global marker size.
forge::Plot::colorsSize
FGAPI unsigned colorsSize() const
Get the colors buffer size in bytes.
fg_marker_type
fg_marker_type
Definition: defines.h:166
fg_retain_plot
FGAPI fg_err fg_retain_plot(fg_plot *pOut, fg_plot pIn)
Increase reference count of the resource.
fg_color
fg_color
Definition: defines.h:139
forge::Plot::alphasSize
FGAPI unsigned alphasSize() const
Get the alpha values buffer size in bytes.
fg_get_plot_vertex_buffer_size
FGAPI fg_err fg_get_plot_vertex_buffer_size(unsigned *pOut, const fg_plot pPlot)
Get the vertices buffer size in bytes.
forge::Plot::get
FGAPI fg_plot get() const
Get the handle to internal implementation of plot.
forge::Plot::Plot
FGAPI Plot(const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType, const PlotType pPlotType=FG_PLOT_LINE, const MarkerType pMarkerType=FG_MARKER_NONE)
Creates a Plot object.
forge::Plot::alphas
FGAPI unsigned alphas() const
Get the buffer identifier for alpha values per vertex.
fg_set_plot_color
FGAPI fg_err fg_set_plot_color(fg_plot pPlot, const float pRed, const float pGreen, const float pBlue, const float pAlpha)
Set the color of line graph(plot)
fg_get_plot_vertex_buffer
FGAPI fg_err fg_get_plot_vertex_buffer(unsigned *pOut, const fg_plot pPlot)
Get the resource identifier for vertices buffer.
fg_get_plot_radii_buffer
FGAPI fg_err fg_get_plot_radii_buffer(unsigned *pOut, const fg_plot pPlot)
Get the resource identifier for markers radii buffer.
fg_set_plot_marker_size
FGAPI fg_err fg_set_plot_marker_size(fg_plot pPlot, const float pMarkerSize)
Set global marker size.
fg_plot_type
fg_plot_type
Definition: defines.h:160
fg_set_plot_legend
FGAPI fg_err fg_set_plot_legend(fg_plot pPlot, const char *pLegend)
Set plot legend.
fg_chart_type
fg_chart_type
Definition: defines.h:117
forge::Plot::radii
FGAPI unsigned radii() const
Get the buffer identifier for per vertex marker sizes.
fg_create_plot
FGAPI fg_err fg_create_plot(fg_plot *pPlot, const unsigned pNPoints, const fg_dtype pType, const fg_chart_type pChartType, const fg_plot_type pPlotType, const fg_marker_type pMarkerType)
Create a Plot object.
defines.h
FGAPI
#define FGAPI
Definition: defines.h:28