VTK
vtkAOSDataArrayTemplate.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAOSDataArrayTemplate.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
31 #ifndef vtkAOSDataArrayTemplate_h
32 #define vtkAOSDataArrayTemplate_h
33 
34 #include "vtkCommonCoreModule.h" // For export macro
35 #include "vtkGenericDataArray.h"
36 #include "vtkBuffer.h" // For storage buffer.
37 
38 // The export macro below makes no sense, but is necessary for older compilers
39 // when we export instantiations of this class from vtkCommonCore.
40 template <class ValueTypeT>
41 class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate :
42  public vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>
43 {
46 public:
49  typedef typename Superclass::ValueType ValueType;
50 
52  {
55  VTK_DATA_ARRAY_ALIGNED_FREE=vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
57  };
58 
59  static vtkAOSDataArrayTemplate* New();
60 
64  ValueType GetValue(vtkIdType valueIdx) const
65  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
66  {
67  return this->Buffer->GetBuffer()[valueIdx];
68  }
69 
74  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
75  {
76  this->Buffer->GetBuffer()[valueIdx] = value;
77  }
78 
80 
83  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
84  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
85  {
86  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
87  std::copy(this->Buffer->GetBuffer() + valueIdx,
88  this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents,
89  tuple);
90  }
92 
94 
97  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
98  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
99  {
100  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
101  std::copy(tuple, tuple + this->NumberOfComponents,
102  this->Buffer->GetBuffer() + valueIdx);
103  }
105 
109  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
110  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
111  VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
112  {
113  return this->Buffer->GetBuffer()[this->NumberOfComponents*tupleIdx + comp];
114  }
115 
117 
120  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
121  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
122  VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
123  {
124  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
125  this->SetValue(valueIdx, value);
126  }
128 
130 
133  void FillTypedComponent(int compIdx, ValueType value) override;
135 
137 
140  void FillValue(ValueType value) override;
141  void Fill(double value) override;
143 
145 
150  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
151  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
153 
155 
162  ValueType* GetPointer(vtkIdType valueIdx);
163  void* GetVoidPointer(vtkIdType valueIdx) override;
165 
167 
181  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save,
182  int deleteMethod);
183  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save);
184  void SetVoidArray(void* array, vtkIdType size, int save) override;
185  void SetVoidArray(void* array, vtkIdType size, int save,
186  int deleteMethod) override;
188 
195  void SetArrayFreeFunction(void (*callback)(void *)) override;
196 
197  // Overridden for optimized implementations:
198  void SetTuple(vtkIdType tupleIdx, const float *tuple) override;
199  void SetTuple(vtkIdType tupleIdx, const double *tuple) override;
200  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
201  // using Superclass::SetTuple;
202  void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx,
203  vtkAbstractArray *source) override
204  { this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source); }
205  void InsertTuple(vtkIdType tupleIdx, const float *source) override;
206  void InsertTuple(vtkIdType tupleIdx, const double *source) override;
207  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
208  // using Superclass::InsertTuple;
209  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx,
210  vtkAbstractArray *source) override
211  { this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source); }
212  void InsertComponent(vtkIdType tupleIdx, int compIdx,
213  double value) override;
214  vtkIdType InsertNextTuple(const float *tuple) override;
215  vtkIdType InsertNextTuple(const double *tuple) override;
216  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
217  // using Superclass::InsertNextTuple;
219  vtkAbstractArray *source) override
220  { return this->Superclass::InsertNextTuple(srcTupleIdx, source); }
221  void GetTuple(vtkIdType tupleIdx, double * tuple) override;
222  double *GetTuple(vtkIdType tupleIdx) override;
223 
235 
240  typedef ValueType* Iterator;
241  Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
242  Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
243 
245 
254  {
255  if (source)
256  {
257  switch (source->GetArrayType())
258  {
260  if (vtkDataTypesCompare(source->GetDataType(),
262  {
263  return static_cast<vtkAOSDataArrayTemplate<ValueType>*>(source);
264  }
265  break;
266  }
267  }
268  return nullptr;
269  }
271 
274  bool HasStandardMemoryLayout() override { return true; }
275  void ShallowCopy(vtkDataArray *other) override;
276 
277  // Reimplemented for efficiency:
278  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
279  vtkAbstractArray* source) override;
280  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
281  // using Superclass::InsertTuples;
282  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
283  vtkAbstractArray *source) override
284  { this->Superclass::InsertTuples(dstIds, srcIds, source); }
285 
286 protected:
288  ~vtkAOSDataArrayTemplate() override;
289 
294  bool AllocateTuples(vtkIdType numTuples);
295 
300  bool ReallocateTuples(vtkIdType numTuples);
301 
303 
304 private:
306  void operator=(const vtkAOSDataArrayTemplate&) = delete;
307 
308  friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>,
309  ValueTypeT>;
310 
311 };
312 
313 // Declare vtkArrayDownCast implementations for AoS containers:
315 
316 // This macro is used by the subclasses to create dummy
317 // declarations for these functions such that the wrapper
318 // can see them. The wrappers ignore vtkAOSDataArrayTemplate.
319 #define vtkCreateWrappedArrayInterface(T) \
320  int GetDataType() override;\
321  void GetTypedTuple(vtkIdType i, T* tuple) \
322  VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
323  void SetTypedTuple(vtkIdType i, const T* tuple) \
324  VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
325  void InsertTypedTuple(vtkIdType i, const T* tuple) \
326  VTK_EXPECTS(0 <= i); \
327  vtkIdType InsertNextTypedTuple(const T* tuple); \
328  T GetValue(vtkIdType id) \
329  VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
330  void SetValue(vtkIdType id, T value) \
331  VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
332  void SetNumberOfValues(vtkIdType number) override;\
333  void InsertValue(vtkIdType id, T f) \
334  VTK_EXPECTS(0 <= id); \
335  vtkIdType InsertNextValue(T f); \
336  T *GetValueRange(int comp) VTK_SIZEHINT(2); \
337  T *GetValueRange() VTK_SIZEHINT(2); \
338  T* WritePointer(vtkIdType id, vtkIdType number); \
339  T* GetPointer(vtkIdType id); \
340  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
341  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
342 
343 #endif // header guard
344 
345 // This portion must be OUTSIDE the include blockers. This is used to tell
346 // libraries other than vtkCommonCore that instantiations of
347 // vtkAOSDataArrayTemplate can be found externally. This prevents each library
348 // from instantiating these on their own.
349 #ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
350 #define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
351  template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate< T >
352 #elif defined(VTK_USE_EXTERN_TEMPLATE)
353 #ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
354 #define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
355 #ifdef _MSC_VER
356 #pragma warning (push)
357 // The following is needed when the vtkAOSDataArrayTemplate is declared
358 // dllexport and is used from another class in vtkCommonCore
359 #pragma warning (disable: 4910) // extern and dllexport incompatible
360 #endif
362  extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
363 #ifdef _MSC_VER
364 #pragma warning (pop)
365 #endif
366 #endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
367 
368 // The following clause is only for MSVC
369 #elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
370 #pragma warning (push)
371 
372 // C4091: 'extern ' : ignored on left of 'int' when no variable is declared
373 #pragma warning (disable: 4091)
374 
375 // Compiler-specific extension warning.
376 #pragma warning (disable: 4231)
377 
378 // We need to disable warning 4910 and do an extern dllexport
379 // anyway. When deriving vtkCharArray and other types from an
380 // instantiation of this template the compiler does an explicit
381 // instantiation of the base class. From outside the vtkCommon
382 // library we block this using an extern dllimport instantiation.
383 // For classes inside vtkCommon we should be able to just do an
384 // extern instantiation, but VS complains about missing
385 // definitions. We cannot do an extern dllimport inside vtkCommon
386 // since the symbols are local to the dll. An extern dllexport
387 // seems to be the only way to convince VS to do the right
388 // thing, so we just disable the warning.
389 #pragma warning (disable: 4910) // extern and dllexport incompatible
390 
391 // Use an "extern explicit instantiation" to give the class a DLL
392 // interface. This is a compiler-specific extension.
394  extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
395 
396 #pragma warning (pop)
397 
398 #endif
399 
400 // VTK-HeaderTest-Exclude: vtkAOSDataArrayTemplate.h
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array.
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
virtual void ShallowCopy(vtkDataArray *other)
Create a shallow copy of other into this, if possible.
vtkIdType GetNumberOfTuples()
Get the number of complete tuples (a component group) in the array.
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple from srcTupleIdx in the source array at the end of this array.
Abstract superclass for all arrays.
ValueType * GetPointer(vtkIdType valueIdx)
Default implementation raises a runtime error.
void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
Set component comp of the tuple at tupleIdx to value.
vtkTemplateTypeMacro(SelfType, vtkDataArray) enum
Compile time access to the VTK type identifier.
void SetArrayFreeFunction(void(*callback)(void *)) override
Default implementation raises a runtime error.
int vtkIdType
Definition: vtkType.h:347
Base interface for all typed vtkDataArray subclasses.
void SetVoidArray(void *, vtkIdType, int) override
Default implementation raises a runtime error.
vtkAOSDataArrayTemplate< ValueTypeT > SelfType
virtual void Fill(double value)
Fill all values of a data array with a specified value.
void GetTypedTuple(vtkIdType tupleIdx, ValueType *tuple) const
Copy the tuple at tupleIdx into tuple.
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
double * GetTuple(vtkIdType tupleIdx) override
Get the data tuple at tupleIdx.
#define vtkExternTemplateMacro(decl)
A macro to declare extern templates for all numerical types.
Definition: vtkType.h:415
Array-Of-Structs implementation of vtkGenericDataArray.
list of point or cell ids
Definition: vtkIdList.h:30
bool AllocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
ValueType GetValue(vtkIdType valueIdx) const
Get the value at valueIdx.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
virtual void FillValue(ValueType value)
Set all the values in array to value.
void * WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override
Default implementation raises a runtime error.
ValueType * WritePointer(vtkIdType valueIdx, vtkIdType numValues)
Default implementation raises a runtime error.
Abstract superclass to iterate over elements in an vtkAbstractArray.
bool HasStandardMemoryLayout() override
Returns true if this array uses the standard memory layout defined in the VTK user guide,...
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void DataChanged() override
Tell the array explicitly that the data has changed.
#define VTK_NEWINSTANCE
#define vtkInstantiateTemplateMacro(decl)
A macro to instantiate a template over all numerical types.
Definition: vtkType.h:395
void * GetVoidPointer(vtkIdType valueIdx) override
Default implementation raises a runtime error.
int GetArrayType() override
Method for type-checking in FastDownCast implementations.
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
vtkArrayDownCast_TemplateFastCastMacro(vtkTypedDataArray) template< class Scalar > inline typename vtkTypedDataArray< Scalar >
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
void DataElementChanged(vtkIdType)
Tell the array explicitly that a single data element has changed.
#define VTK_ZEROCOPY
virtual void FillTypedComponent(int compIdx, ValueType value)
Set component comp of all tuples to value.
static vtkAOSDataArrayTemplate< ValueType > * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkAOSDataArrayTemplate.
ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
Get component comp of the tuple at tupleIdx.
void SetTypedTuple(vtkIdType tupleIdx, const ValueType *tuple)
Set this array's tuple at tupleIdx to the values in tuple.
void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override
Insert value at the location specified by tupleIdx and compIdx.
ValueType * Iterator
Legacy support for array-of-structs value iteration.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
bool ReallocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple from srcTupleIdx in the source array at the end of this array.
void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array.
#define VTK_EXPECTS(x)
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
Template defining traits of native types used by VTK.
Definition: vtkTypeTraits.h:29
vtkBuffer< ValueType > * Buffer