Forge
|
VectorField is a line graph to display two dimensional data. More...
#include <vector_field.h>
Public Member Functions | |
FGAPI | VectorField (const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType) |
Creates a VectorField object. More... | |
FGAPI | VectorField (const VectorField &pOther) |
Copy constructor for VectorField. More... | |
FGAPI | VectorField (const fg_vector_field pHandle) |
Construct VectorField ojbect from fg_vector_field resource handle. More... | |
FGAPI | ~VectorField () |
VectorField Destructor. More... | |
FGAPI void | setColor (const forge::Color pColor) |
Set global color for the field lines. More... | |
FGAPI void | setColor (const float pRed, const float pGreen, const float pBlue, const float pAlpha) |
Set global color for the field lines. More... | |
FGAPI void | setLegend (const char *pLegend) |
Set VectorField legend. More... | |
FGAPI unsigned | vertices () const |
Get the buffer identifier for vertices. More... | |
FGAPI unsigned | colors () const |
Get the buffer identifier for color values per vertex. More... | |
FGAPI unsigned | alphas () const |
Get the buffer identifier for alpha values per vertex. More... | |
FGAPI unsigned | directions () const |
Get the buffer identifier for field direction per vertex values. More... | |
FGAPI unsigned | verticesSize () const |
Get the vertex buffer size in bytes. More... | |
FGAPI unsigned | colorsSize () const |
Get the colors buffer size in bytes. More... | |
FGAPI unsigned | alphasSize () const |
Get the alpha values buffer size in bytes. More... | |
FGAPI unsigned | directionsSize () const |
Get the directions buffer size. More... | |
FGAPI fg_vector_field | get () const |
Get the handle to internal implementation of VectorField. More... | |
VectorField is a line graph to display two dimensional data.
FGAPI VectorField | ( | const unsigned | pNumPoints, |
const dtype | pDataType, | ||
const ChartType | pChartType | ||
) |
Creates a VectorField object.
[in] | pNumPoints | is number of data points to display |
[in] | pDataType | takes one of the values of dtype that indicates the integral data type of VectorField data |
[in] | pChartType | dictates the dimensionality of the chart |
FGAPI VectorField | ( | const VectorField & | pOther | ) |
Copy constructor for VectorField.
[in] | pOther | is the VectorField of which we make a copy of. |
|
explicit |
Construct VectorField ojbect from fg_vector_field resource handle.
[in] | pHandle | is the input fg_vector_field resource handle |
FGAPI ~VectorField | ( | ) |
VectorField Destructor.
FGAPI unsigned alphas | ( | ) | const |
Get the buffer identifier for alpha values per vertex.
FGAPI unsigned alphasSize | ( | ) | const |
Get the alpha values buffer size in bytes.
FGAPI unsigned colors | ( | ) | const |
Get the buffer identifier for color values per vertex.
FGAPI unsigned colorsSize | ( | ) | const |
Get the colors buffer size in bytes.
FGAPI unsigned directions | ( | ) | const |
Get the buffer identifier for field direction per vertex values.
FGAPI unsigned directionsSize | ( | ) | const |
Get the directions buffer size.
FGAPI fg_vector_field get | ( | ) | const |
Get the handle to internal implementation of VectorField.
FGAPI void setColor | ( | const float | pRed, |
const float | pGreen, | ||
const float | pBlue, | ||
const float | pAlpha | ||
) |
Set global color for the field lines.
[in] | pRed | is Red component in range [0, 1] |
[in] | pGreen | is Green component in range [0, 1] |
[in] | pBlue | is Blue component in range [0, 1] |
[in] | pAlpha | is Blue component in range [0, 1] |
FGAPI void setColor | ( | const forge::Color | pColor | ) |
Set global color for the field lines.
[in] | pColor | takes values of forge::Color to define VectorField color |
FGAPI void setLegend | ( | const char * | pLegend | ) |
Set VectorField legend.
[in] | pLegend |
FGAPI unsigned vertices | ( | ) | const |
Get the buffer identifier for vertices.
FGAPI unsigned verticesSize | ( | ) | const |
Get the vertex buffer size in bytes.