Forge
Surface Class Reference

3d graph to display plots. More...

#include <surface.h>

Public Member Functions

FGAPI Surface (unsigned pNumXPoints, unsigned pNumYPoints, dtype pDataType, PlotType pPlotType=fg::FG_SURFACE, MarkerType pMarkerType=fg::FG_NONE)
 Creates a Surface object. More...
 
FGAPI Surface (const Surface &other)
 Copy constructor for Plot. More...
 
FGAPI ~Surface ()
 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, float pZmax, float pZmin)
 Set the chart axes limits. More...
 
FGAPI void setAxesTitles (const char *pXTitle, const char *pYTitle, const char *pZTitle)
 Set axes titles. 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 float zmax () const
 Get Z-Axis maximum value. More...
 
FGAPI float zmin () const
 Get Z-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::_Surface * get () const
 Get the handle to internal implementation of _Surface. More...
 

Detailed Description

3d graph to display plots.

Constructor & Destructor Documentation

◆ Surface() [1/2]

FGAPI Surface ( unsigned  pNumXPoints,
unsigned  pNumYPoints,
dtype  pDataType,
PlotType  pPlotType = fg::FG_SURFACE,
MarkerType  pMarkerType = fg::FG_NONE 
)

Creates a Surface object.

Parameters
[in]pNumXPointsis number of data points along X dimension
[in]pNumYPointsis number of data points along Y dimension
[in]pDataTypetakes one of the values of dtype that indicates the integral data type of plot data
[in]pPlotTypeis the render type which can be one of PlotType (valid choices are FG_SURFACE and FG_SCATTER)
[in]pMarkerTypeis the type of MarkerType to draw for FG_SCATTER plot type

◆ Surface() [2/2]

FGAPI Surface ( const Surface other)

Copy constructor for Plot.

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

◆ ~Surface()

FGAPI ~Surface ( )

Plot Destructor.

Member Function Documentation

◆ get()

FGAPI internal::_Surface* get ( ) const

Get the handle to internal implementation of _Surface.

◆ setAxesLimits()

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

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
[in]pZmaxis Z-Axis maximum value
[in]pZminis Z-Axis minimum value

◆ setAxesTitles()

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

Set axes titles.

Parameters
[in]pXTitleis X-Axis title
[in]pYTitleis Y-Axis title
[in]pZTitleis Z-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

◆ zmax()

FGAPI float zmax ( ) const

Get Z-Axis maximum value.

Returns
Maximum value along Z-Axis

◆ zmin()

FGAPI float zmin ( ) const

Get Z-Axis minimum value.

Returns
Minimum value along Z-Axis

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