Forge
Plot Class Reference

Line graph to display plots. More...

#include <plot.h>

Public Member Functions

FGAPI Plot (unsigned pNumPoints, dtype pDataType, fg::PlotType=fg::FG_LINE, fg::MarkerType=fg::FG_NONE)
 Creates a Plot object. More...
 
FGAPI Plot (const Plot &other)
 Copy constructor for Plot. More...
 
FGAPI ~Plot ()
 Plot Destructor. More...
 
FGAPI void setColor (fg::Color col)
 Set the color of line graph(plot) More...
 
FGAPI void setColor (float pRed, float pGreen, float pBlue)
 Set the color of line graph(plot) More...
 
FGAPI void setAxesLimits (float pXmax, float pXmin, float pYmax, float pYmin)
 Set the chart axes limits. More...
 
FGAPI void setAxesTitles (const char *pXTitle, const char *pYTitle)
 Set axes titles in histogram(bar chart) More...
 
FGAPI float xmax () const
 Get X-Axis maximum value. More...
 
FGAPI float xmin () const
 Get X-Axis minimum value. More...
 
FGAPI float ymax () const
 Get Y-Axis maximum value. More...
 
FGAPI float ymin () const
 Get Y-Axis minimum value. More...
 
FGAPI unsigned vbo () const
 Get the OpenGL Vertex Buffer Object identifier. More...
 
FGAPI unsigned size () const
 Get the OpenGL Vertex Buffer Object resource size. More...
 
FGAPI internal::_Plot * get () const
 Get the handle to internal implementation of Histogram. More...
 

Detailed Description

Line graph to display plots.

Constructor & Destructor Documentation

◆ Plot() [1/2]

FGAPI Plot ( unsigned  pNumPoints,
dtype  pDataType,
fg::PlotType  = fg::FG_LINE,
fg::MarkerType  = fg::FG_NONE 
)

Creates a Plot object.

Parameters
[in]pNumPointsis number of data points to display
[in]pDataTypetakes one of the values of dtype that indicates the integral data type of plot data

◆ Plot() [2/2]

FGAPI Plot ( const Plot other)

Copy constructor for Plot.

Parameters
[in]otheris the Plot of which we make a copy of.

◆ ~Plot()

FGAPI ~Plot ( )

Plot Destructor.

Member Function Documentation

◆ get()

FGAPI internal::_Plot* get ( ) const

Get the handle to internal implementation of Histogram.

◆ setAxesLimits()

FGAPI void setAxesLimits ( float  pXmax,
float  pXmin,
float  pYmax,
float  pYmin 
)

Set the chart axes limits.

Parameters
[in]pXmaxis X-Axis maximum value
[in]pXminis X-Axis minimum value
[in]pYmaxis Y-Axis maximum value
[in]pYminis Y-Axis minimum value

◆ setAxesTitles()

FGAPI void setAxesTitles ( const char *  pXTitle,
const char *  pYTitle 
)

Set axes titles in histogram(bar chart)

Parameters
[in]pXTitleis X-Axis title
[in]pYTitleis Y-Axis title

◆ setColor() [1/2]

FGAPI void setColor ( fg::Color  col)

Set the color of line graph(plot)

Parameters
[in]coltakes values of fg::Color to define plot color

◆ setColor() [2/2]

FGAPI void setColor ( float  pRed,
float  pGreen,
float  pBlue 
)

Set the color of line graph(plot)

Parameters
[in]pRedis Red component in range [0, 1]
[in]pGreenis Green component in range [0, 1]
[in]pBlueis Blue component in range [0, 1]

◆ size()

FGAPI unsigned size ( ) const

Get the OpenGL Vertex Buffer Object resource size.

Returns
OpenGL VBO resource size.

◆ vbo()

FGAPI unsigned vbo ( ) const

Get the OpenGL Vertex Buffer Object identifier.

Returns
OpenGL VBO resource id.

◆ xmax()

FGAPI float xmax ( ) const

Get X-Axis maximum value.

Returns
Maximum value along X-Axis

◆ xmin()

FGAPI float xmin ( ) const

Get X-Axis minimum value.

Returns
Minimum value along X-Axis

◆ ymax()

FGAPI float ymax ( ) const

Get Y-Axis maximum value.

Returns
Maximum value along Y-Axis

◆ ymin()

FGAPI float ymin ( ) const

Get Y-Axis minimum value.

Returns
Minimum value along Y-Axis

The documentation for this class was generated from the following file: