1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
/*******************************************************
* Copyright (c) 2015-2019, ArrayFire
* All rights reserved.
*
* This file is distributed under 3-clause BSD license.
* The complete license agreement can be obtained at:
* http://arrayfire.com/licenses/BSD-3-Clause
********************************************************/
#pragma once
#include <fg/defines.h>
#ifdef __cplusplus
extern "C" {
#endif
/** \addtogroup vfield_functions
* @{
*/
/**
Create a Vector field object
\param[out] pField will be set to surface handle upon creating the surface object
\param[in] pNPoints is number of data points
\param[in] pType takes one of the values of \ref fg_dtype that indicates
the integral data type of surface data
\param[in] pChartType dictates the dimensionality of the chart
\return \ref fg_err error code
*/
FGAPI fg_err fg_create_vector_field(fg_vector_field *pField,
const unsigned pNPoints,
const fg_dtype pType,
const fg_chart_type pChartType);
/**
Increase reference count of the resource
\param[out] pOut is the new handle to existing resource
\param[in] pIn is the existing resource handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_retain_vector_field(fg_vector_field *pOut, fg_vector_field pIn);
/**
Destroy vector field object
\param[in] pField is the surface handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_release_vector_field(fg_vector_field pField);
/**
Set the color of vector field
\param[in] pField is the surface handle
\param[in] pRed is Red component in range [0, 1]
\param[in] pGreen is Green component in range [0, 1]
\param[in] pBlue is Blue component in range [0, 1]
\param[in] pAlpha is Blue component in range [0, 1]
\return \ref fg_err error code
*/
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 vector field legend
\param[in] pField is the vector field handle
\param[in] pLegend
\return \ref fg_err error code
*/
FGAPI fg_err fg_set_vector_field_legend(fg_vector_field pField, const char* pLegend);
/**
Get the resource identifier for vertices buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_vertex_buffer(unsigned* pOut, const fg_vector_field pField);
/**
Get the resource identifier for colors buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_color_buffer(unsigned* pOut, const fg_vector_field pField);
/**
Get the resource identifier for alpha values buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_alpha_buffer(unsigned* pOut, const fg_vector_field pField);
/**
Get the resource identifier for directions buffer
\param[out] pOut will have the buffer identifier after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_direction_buffer(unsigned* pOut, const fg_vector_field pField);
/**
Get the vertices buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_vertex_buffer_size(unsigned* pOut, const fg_vector_field pField);
/**
Get the colors buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_color_buffer_size(unsigned* pOut, const fg_vector_field pField);
/**
Get the alpha values buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_alpha_buffer_size(unsigned* pOut, const fg_vector_field pField);
/**
Get the directions buffer size in bytes
\param[out] pOut will have the buffer size in bytes after this function is called
\param[in] pField is the vector field handle
\return \ref fg_err error code
*/
FGAPI fg_err fg_get_vector_field_direction_buffer_size(unsigned* pOut, const fg_vector_field pField);
/** @} */
#ifdef __cplusplus
}
#endif
#ifdef __cplusplus
namespace forge
{
/**
\class VectorField
\brief VectorField is a line graph to display two dimensional data.
*/
class VectorField {
private:
fg_vector_field mValue;
public:
/**
Creates a VectorField object
\param[in] pNumPoints is number of data points to display
\param[in] pDataType takes one of the values of \ref dtype that indicates
the integral data type of VectorField data
\param[in] pChartType dictates the dimensionality of the chart
*/
FGAPI VectorField(const unsigned pNumPoints, const dtype pDataType, const ChartType pChartType);
/**
Copy constructor for VectorField
\param[in] pOther is the VectorField of which we make a copy of.
*/
FGAPI VectorField(const VectorField& pOther);
/**
Construct VectorField ojbect from fg_vector_field resource handle
\param[in] pHandle is the input fg_vector_field resource handle
\note This kind of construction assumes ownership of the resource handle
is released during the VectorField object's destruction.
*/
FGAPI explicit VectorField(const fg_vector_field pHandle);
/**
VectorField Destructor
*/
FGAPI ~VectorField();
/**
Set global color for the field lines
\param[in] pColor takes values of forge::Color to define VectorField color
*/
FGAPI void setColor(const forge::Color pColor);
/**
Set global color for the field lines
\param[in] pRed is Red component in range [0, 1]
\param[in] pGreen is Green component in range [0, 1]
\param[in] pBlue is Blue component in range [0, 1]
\param[in] pAlpha is Blue component in range [0, 1]
*/
FGAPI void setColor(const float pRed, const float pGreen,
const float pBlue, const float pAlpha);
/**
Set VectorField legend
\param[in] pLegend
*/
FGAPI void setLegend(const char* pLegend);
/**
Get the buffer identifier for vertices
\return vertex buffer resource id.
*/
FGAPI unsigned vertices() const;
/**
Get the buffer identifier for color values per vertex
\return colors buffer resource id.
*/
FGAPI unsigned colors() const;
/**
Get the buffer identifier for alpha values per vertex
\return alpha values buffer resource id.
*/
FGAPI unsigned alphas() const;
/**
Get the buffer identifier for field direction per vertex values
\return directions buffer resource id
*/
FGAPI unsigned directions() const;
/**
Get the vertex buffer size in bytes
\return vertex buffer size in bytes
*/
FGAPI unsigned verticesSize() const;
/**
Get the colors buffer size in bytes
\return colors buffer size in bytes
*/
FGAPI unsigned colorsSize() const;
/**
Get the alpha values buffer size in bytes
\return alpha buffer size in bytes
*/
FGAPI unsigned alphasSize() const;
/**
Get the directions buffer size
\return directions buffer size in bytes
*/
FGAPI unsigned directionsSize() const;
/**
Get the handle to internal implementation of VectorField
*/
FGAPI fg_vector_field get() const;
};
}
#endif
|
