Forge
Histogram Class Reference

Bar graph to display data frequencey. More...

#include <histogram.h>

Public Member Functions

FGAPI Histogram (unsigned pNBins, dtype pDataType)
 Creates a Histogram object. More...
 
FGAPI Histogram (const Histogram &other)
 Copy constructor for Histogram. More...
 
FGAPI ~Histogram ()
 Histogram Destructor. More...
 
FGAPI void setBarColor (fg::Color col)
 Set the color of bar in the bar graph(histogram) More...
 
FGAPI void setBarColor (float pRed, float pGreen, float pBlue)
 Set the color of bar in the bar graph(histogram) 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::_Histogram * get () const
 Get the handle to internal implementation of Histogram. More...
 

Detailed Description

Bar graph to display data frequencey.

Constructor & Destructor Documentation

◆ Histogram() [1/2]

FGAPI Histogram ( unsigned  pNBins,
dtype  pDataType 
)

Creates a Histogram object.

Parameters
[in]pNBinsis number of bins the data is sorted out
[in]pDataTypetakes one of the values of dtype that indicates the integral data type of histogram data

◆ Histogram() [2/2]

FGAPI Histogram ( const Histogram other)

Copy constructor for Histogram.

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

◆ ~Histogram()

Histogram Destructor.

Member Function Documentation

◆ get()

FGAPI internal::_Histogram* 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

◆ setBarColor() [1/2]

FGAPI void setBarColor ( fg::Color  col)

Set the color of bar in the bar graph(histogram)

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

◆ setBarColor() [2/2]

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

Set the color of bar in the bar graph(histogram)

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: