forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkScaledSOADataArrayTemplate.h
351 lines (305 loc) · 12.4 KB
/
vtkScaledSOADataArrayTemplate.h
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/*=========================================================================
Program: Visualization Toolkit
Module: vtkScaledSOADataArrayTemplate.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkScaledSOADataArrayTemplate
* @brief Struct-Of-Arrays implementation of
* vtkGenericDataArray with a scaling factor.
*
*
* vtkScaledSOADataArrayTemplate is the counterpart of vtkSOADataArrayTemplate with a
* scaling factor. Each component is stored in a separate array. The Scale value is
* used to multiply the output of the stored value in the array. For example, if Scale
* is 2 and the requested tuple value stored in memory is [1, 2, 3] then the returned tuple
* values will actually be [2, 4, 6]. Similarly, if Scale is 2 and the tuple values
* for SetTupleValue() is [2, 4, 6] then the stored values in memory will be
* [1, 2, 3].
*
* @sa
* vtkGenericDataArray vtkSOADataArrayTemplate
*/
#ifndef vtkScaledSOADataArrayTemplate_h
#define vtkScaledSOADataArrayTemplate_h
#include "vtkBuffer.h"
#include "vtkBuild.h" // For VTK_BUILD_SHARED_LIBS
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkCompiler.h" // for VTK_USE_EXTERN_TEMPLATE
#include "vtkGenericDataArray.h"
// The export macro below makes no sense, but is necessary for older compilers
// when we export instantiations of this class from vtkCommonCore.
template <class ValueTypeT>
class VTKCOMMONCORE_EXPORT vtkScaledSOADataArrayTemplate
: public vtkGenericDataArray<vtkScaledSOADataArrayTemplate<ValueTypeT>, ValueTypeT>
{
typedef vtkGenericDataArray<vtkScaledSOADataArrayTemplate<ValueTypeT>, ValueTypeT>
GenericDataArrayType;
public:
typedef vtkScaledSOADataArrayTemplate<ValueTypeT> SelfType;
vtkTemplateTypeMacro(SelfType, GenericDataArrayType);
typedef typename Superclass::ValueType ValueType;
enum DeleteMethod
{
VTK_DATA_ARRAY_FREE = vtkAbstractArray::VTK_DATA_ARRAY_FREE,
VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
};
static vtkScaledSOADataArrayTemplate* New();
///@{
/**
* Set/Get the Scale value for the object. The default is 1.
*/
void SetScale(ValueType scale)
{
if (scale != this->Scale)
{
if (scale == 0)
{
vtkErrorMacro("Cannot set Scale to 0");
}
else
{
this->Scale = scale;
this->Modified();
}
}
}
ValueType GetScale() const { return this->Scale; }
///@}
///@{
/**
* Get the value at @a valueIdx. @a valueIdx assumes AOS ordering.
*/
inline ValueType GetValue(vtkIdType valueIdx) const
{
vtkIdType tupleIdx;
int comp;
this->GetTupleIndexFromValueIndex(valueIdx, tupleIdx, comp);
return this->GetTypedComponent(tupleIdx, comp);
}
///@}
///@{
/**
* Set the value at @a valueIdx to @a value. @a valueIdx assumes AOS ordering.
*/
inline void SetValue(vtkIdType valueIdx, ValueType value)
{
vtkIdType tupleIdx;
int comp;
this->GetTupleIndexFromValueIndex(valueIdx, tupleIdx, comp);
this->SetTypedComponent(tupleIdx, comp, value);
}
///@}
/**
* Copy the tuple at @a tupleIdx into @a tuple.
*/
inline void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
{
for (size_t cc = 0; cc < this->Data.size(); cc++)
{
tuple[cc] = this->Data[cc]->GetBuffer()[tupleIdx] * this->Scale;
}
}
/**
* Set this array's tuple at @a tupleIdx to the values in @a tuple.
*/
inline void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
{
for (size_t cc = 0; cc < this->Data.size(); ++cc)
{
this->Data[cc]->GetBuffer()[tupleIdx] = tuple[cc] / this->Scale;
}
}
/**
* Get component @a comp of the tuple at @a tupleIdx.
*/
inline ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
{
return this->Data[comp]->GetBuffer()[tupleIdx] * this->Scale;
}
/**
* Set component @a comp of the tuple at @a tupleIdx to @a value.
*/
inline void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
{
this->Data[comp]->GetBuffer()[tupleIdx] = value / this->Scale;
}
/**
* Set component @a comp of all tuples to @a value.
*/
void FillTypedComponent(int compIdx, ValueType value) override;
/**
* Use this API to pass externally allocated memory to this instance. Since
* vtkScaledSOADataArrayTemplate uses separate contiguous regions for each
* component, use this API to add arrays for each of the component.
* \c save: When set to true, vtkScaledSOADataArrayTemplate will not release or
* realloc the memory even when the AllocatorType is set to RESIZABLE. If
* needed it will simply allow new memory buffers and "forget" the supplied
* pointers. When save is set to false, this will be the \c deleteMethod
* specified to release the array.
* If updateMaxId is true, the array's MaxId will be updated, and assumes
* that size is the number of tuples in the array.
* \c size is specified in number of elements of ScalarType.
*/
void SetArray(int comp, VTK_ZEROCOPY ValueType* array, vtkIdType size, bool updateMaxId = false,
bool save = false, int deleteMethod = VTK_DATA_ARRAY_FREE);
/**
* This method allows the user to specify a custom free function to be
* called when the array is deallocated. Calling this method will implicitly
* mean that the given free function will be called when the class
* cleans up or reallocates memory. This custom free function will be
* used for all components.
**/
void SetArrayFreeFunction(void (*callback)(void*)) override;
/**
* This method allows the user to specify a custom free function to be
* called when the array is deallocated. Calling this method will implicitly
* mean that the given free function will be called when the class
* cleans up or reallocates memory.
**/
void SetArrayFreeFunction(int comp, void (*callback)(void*));
/**
* Return a pointer to a contiguous block of memory containing all values for
* a particular components (ie. a single array of the struct-of-arrays). Note
* that this is to raw memory and no scaling of the data is done here.
*/
ValueType* GetComponentArrayPointer(int comp);
/**
* Use of this method is discouraged, it creates a deep copy of the data into
* a contiguous AoS-ordered buffer and prints a warning.
*/
void* GetVoidPointer(vtkIdType valueIdx) override;
/**
* Export a copy of the data in AoS ordering to the preallocated memory
* buffer.
*/
void ExportToVoidPointer(void* ptr) override;
#ifndef __VTK_WRAP__
///@{
/**
* Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray.
* This method checks if source->GetArrayType() returns DataArray
* or a more derived type, and performs a static_cast to return
* source as a vtkDataArray pointer. Otherwise, nullptr is returned.
*/
static vtkScaledSOADataArrayTemplate<ValueType>* FastDownCast(vtkAbstractArray* source)
{
if (source)
{
switch (source->GetArrayType())
{
case vtkAbstractArray::ScaleSoADataArrayTemplate:
if (vtkDataTypesCompare(source->GetDataType(), vtkTypeTraits<ValueType>::VTK_TYPE_ID))
{
return static_cast<vtkScaledSOADataArrayTemplate<ValueType>*>(source);
}
break;
}
}
return nullptr;
}
///@}
#endif
int GetArrayType() const override { return vtkAbstractArray::ScaleSoADataArrayTemplate; }
VTK_NEWINSTANCE vtkArrayIterator* NewIterator() override;
void SetNumberOfComponents(int numComps) override;
void ShallowCopy(vtkDataArray* other) override;
// Reimplemented for efficiency:
void InsertTuples(
vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
// MSVC doesn't like 'using' here (error C2487). Just forward instead:
// using Superclass::InsertTuples;
void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override
{
this->Superclass::InsertTuples(dstIds, srcIds, source);
}
protected:
vtkScaledSOADataArrayTemplate();
~vtkScaledSOADataArrayTemplate() override;
/**
* Allocate space for numTuples. Old data is not preserved. If numTuples == 0,
* all data is freed.
*/
bool AllocateTuples(vtkIdType numTuples);
/**
* Allocate space for numTuples. Old data is preserved. If numTuples == 0,
* all data is freed.
*/
bool ReallocateTuples(vtkIdType numTuples);
std::vector<vtkBuffer<ValueType>*> Data;
vtkBuffer<ValueType>* AoSCopy;
private:
vtkScaledSOADataArrayTemplate(const vtkScaledSOADataArrayTemplate&) = delete;
void operator=(const vtkScaledSOADataArrayTemplate&) = delete;
inline void GetTupleIndexFromValueIndex(vtkIdType valueIdx, vtkIdType& tupleIdx, int& comp) const
{
tupleIdx = valueIdx / this->NumberOfComponents;
comp = valueIdx % this->NumberOfComponents;
}
friend class vtkGenericDataArray<vtkScaledSOADataArrayTemplate<ValueTypeT>, ValueTypeT>;
/**
* The value to scale the data stored in memory by.
*/
ValueType Scale;
};
// Declare vtkArrayDownCast implementations for scale SoA containers:
vtkArrayDownCast_TemplateFastCastMacro(vtkScaledSOADataArrayTemplate);
#endif // header guard
// This portion must be OUTSIDE the include blockers. This is used to tell
// libraries other than vtkCommonCore that instantiations of
// vtkScaledSOADataArrayTemplate can be found externally. This prevents each library
// from instantiating these on their own.
#ifdef VTK_SCALED_SOA_DATA_ARRAY_TEMPLATE_INSTANTIATING
#define VTK_SCALED_SOA_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
namespace vtkDataArrayPrivate \
{ \
VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkScaledSOADataArrayTemplate<T>, double); \
} \
template class VTKCOMMONCORE_EXPORT vtkScaledSOADataArrayTemplate<T>
#elif defined(VTK_USE_EXTERN_TEMPLATE)
#ifndef VTK_SCALED_SOA_DATA_ARRAY_TEMPLATE_EXTERN
#define VTK_SCALED_SOA_DATA_ARRAY_TEMPLATE_EXTERN
#ifdef _MSC_VER
#pragma warning(push)
// The following is needed when the vtkScaledSOADataArrayTemplate is declared
// dllexport and is used from another class in vtkCommonCore
#pragma warning(disable : 4910) // extern and dllexport incompatible
#endif
vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkScaledSOADataArrayTemplate);
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#endif // VTK_SCALED_SOA_DATA_ARRAY_TEMPLATE_EXTERN
// The following clause is only for MSVC 2008 and 2010
#elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
#pragma warning(push)
// C4091: 'extern ' : ignored on left of 'int' when no variable is declared
#pragma warning(disable : 4091)
// Compiler-specific extension warning.
#pragma warning(disable : 4231)
// We need to disable warning 4910 and do an extern dllexport
// anyway. When deriving new arrays from an
// instantiation of this template the compiler does an explicit
// instantiation of the base class. From outside the vtkCommon
// library we block this using an extern dllimport instantiation.
// For classes inside vtkCommon we should be able to just do an
// extern instantiation, but VS 2008 complains about missing
// definitions. We cannot do an extern dllimport inside vtkCommon
// since the symbols are local to the dll. An extern dllexport
// seems to be the only way to convince VS 2008 to do the right
// thing, so we just disable the warning.
#pragma warning(disable : 4910) // extern and dllexport incompatible
// Use an "extern explicit instantiation" to give the class a DLL
// interface. This is a compiler-specific extension.
vtkInstantiateTemplateMacro(
extern template class VTKCOMMONCORE_EXPORT vtkScaledSOADataArrayTemplate);
#pragma warning(pop)
#endif
// VTK-HeaderTest-Exclude: vtkScaledSOADataArrayTemplate.h