Forge
vector_field.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
16extern "C" {
17#endif
18
35 const unsigned pNPoints,
36 const fg_dtype pType,
37 const fg_chart_type pChartType);
38
48
57
70 const float pRed, const float pGreen,
71 const float pBlue, const float pAlpha);
72
82
92
102
112
122
132
142
152
162
165#ifdef __cplusplus
166}
167#endif
168
169
170#ifdef __cplusplus
171
172namespace forge
173{
174
181 private:
182 fg_vector_field mValue;
183
184 public:
193 FGAPI VectorField(const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType);
194
201
210 FGAPI explicit VectorField(const fg_vector_field pHandle);
211
216
222 FGAPI void setColor(const forge::Color pColor);
223
232 FGAPI void setColor(const float pRed, const float pGreen,
233 const float pBlue, const float pAlpha);
234
240 FGAPI void setLegend(const char* pLegend);
241
247 FGAPI unsigned vertices() const;
248
254 FGAPI unsigned colors() const;
255
261 FGAPI unsigned alphas() const;
262
268 FGAPI unsigned directions() const;
269
275 FGAPI unsigned verticesSize() const;
276
282 FGAPI unsigned colorsSize() const;
283
289 FGAPI unsigned alphasSize() const;
290
296 FGAPI unsigned directionsSize() const;
297
302};
303
304}
305
306#endif
VectorField is a line graph to display two dimensional data.
Definition vector_field.h:180
FGAPI unsigned vertices() const
Get the buffer identifier for vertices.
FGAPI unsigned directions() const
Get the buffer identifier for field direction per vertex values.
FGAPI void setColor(const float pRed, const float pGreen, const float pBlue, const float pAlpha)
Set global color for the field lines.
FGAPI VectorField(const VectorField &pOther)
Copy constructor for VectorField.
FGAPI VectorField(const fg_vector_field pHandle)
Construct VectorField ojbect from fg_vector_field resource handle.
FGAPI unsigned verticesSize() const
Get the vertex buffer size in bytes.
FGAPI void setLegend(const char *pLegend)
Set VectorField legend.
FGAPI void setColor(const forge::Color pColor)
Set global color for the field lines.
FGAPI fg_vector_field get() const
Get the handle to internal implementation of VectorField.
FGAPI unsigned directionsSize() const
Get the directions buffer size.
FGAPI unsigned alphasSize() const
Get the alpha values buffer size in bytes.
FGAPI unsigned colorsSize() const
Get the colors buffer size in bytes.
FGAPI ~VectorField()
VectorField Destructor.
FGAPI unsigned alphas() const
Get the buffer identifier for alpha values per vertex.
FGAPI unsigned colors() const
Get the buffer identifier for color values per vertex.
FGAPI VectorField(const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType)
Creates a VectorField object.
#define FGAPI
Definition defines.h:28
fg_err
Definition defines.h:49
fg_dtype
Definition defines.h:150
void * fg_vector_field
Definition defines.h:47
fg_color
Definition defines.h:139
fg_chart_type
Definition defines.h:117
FGAPI fg_err fg_get_vector_field_color_buffer_size(unsigned *pOut, const fg_vector_field pField)
Get the colors buffer size in bytes.
FGAPI fg_err fg_release_vector_field(fg_vector_field pField)
Destroy vector field object.
FGAPI fg_err fg_retain_vector_field(fg_vector_field *pOut, fg_vector_field pIn)
Increase reference count of the resource.
FGAPI fg_err fg_set_vector_field_legend(fg_vector_field pField, const char *pLegend)
Set vector field legend.
FGAPI fg_err fg_get_vector_field_vertex_buffer(unsigned *pOut, const fg_vector_field pField)
Get the resource identifier for vertices buffer.
FGAPI fg_err fg_get_vector_field_direction_buffer_size(unsigned *pOut, const fg_vector_field pField)
Get the directions buffer size in bytes.
FGAPI fg_err fg_set_vector_field_color(fg_vector_field pField, const float pRed, const float pGreen, const float pBlue, const float pAlpha)
Set the color of vector field.
FGAPI fg_err fg_get_vector_field_alpha_buffer_size(unsigned *pOut, const fg_vector_field pField)
Get the alpha values buffer size in bytes.
FGAPI fg_err fg_get_vector_field_direction_buffer(unsigned *pOut, const fg_vector_field pField)
Get the resource identifier for directions buffer.
FGAPI fg_err fg_get_vector_field_color_buffer(unsigned *pOut, const fg_vector_field pField)
Get the resource identifier for colors buffer.
FGAPI fg_err fg_get_vector_field_alpha_buffer(unsigned *pOut, const fg_vector_field pField)
Get the resource identifier for alpha values buffer.
FGAPI fg_err fg_get_vector_field_vertex_buffer_size(unsigned *pOut, const fg_vector_field pField)
Get the vertices buffer size in bytes.
FGAPI fg_err fg_create_vector_field(fg_vector_field *pField, const unsigned pNPoints, const fg_dtype pType, const fg_chart_type pChartType)
Create a Vector field object.
Definition chart.h:305
dtype
Definition defines.h:188