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 "vtkBuffer.h" // For storage buffer.
35 #include "vtkCommonCoreModule.h" // For export macro
36 #include "vtkGenericDataArray.h"
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 {
45 
46 public:
49  typedef typename Superclass::ValueType ValueType;
50 
52  {
54  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
55  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
56  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
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, tuple);
89  }
91 
93 
96  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
97  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
98  {
99  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
100  std::copy(tuple, tuple + this->NumberOfComponents, this->Buffer->GetBuffer() + valueIdx);
101  }
103 
107  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const VTK_EXPECTS(0 <= tupleIdx &&
108  tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
109  {
110  return this->Buffer->GetBuffer()[this->NumberOfComponents * tupleIdx + comp];
111  }
112 
114 
117  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value) VTK_EXPECTS(0 <= tupleIdx &&
118  tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
119  {
120  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
121  this->SetValue(valueIdx, value);
122  }
124 
126 
129  void FillTypedComponent(int compIdx, ValueType value) override;
131 
133 
136  void FillValue(ValueType value) override;
137  void Fill(double value) override;
139 
141 
146  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
147  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
149 
151 
158  ValueType* GetPointer(vtkIdType valueIdx);
159  void* GetVoidPointer(vtkIdType valueIdx) override;
161 
163 
177  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save, int deleteMethod);
178  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save);
179  void SetVoidArray(void* array, vtkIdType size, int save) override;
180  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override;
182 
189  void SetArrayFreeFunction(void (*callback)(void*)) override;
190 
191  // Overridden for optimized implementations:
192  void SetTuple(vtkIdType tupleIdx, const float* tuple) override;
193  void SetTuple(vtkIdType tupleIdx, const double* tuple) override;
194  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
195  // using Superclass::SetTuple;
196  void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
197  {
198  this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source);
199  }
200  void InsertTuple(vtkIdType tupleIdx, const float* source) override;
201  void InsertTuple(vtkIdType tupleIdx, const double* source) override;
202  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
203  // using Superclass::InsertTuple;
204  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
205  {
206  this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source);
207  }
208  void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
209  vtkIdType InsertNextTuple(const float* tuple) override;
210  vtkIdType InsertNextTuple(const double* tuple) override;
211  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
212  // using Superclass::InsertNextTuple;
214  {
215  return this->Superclass::InsertNextTuple(srcTupleIdx, source);
216  }
217  void GetTuple(vtkIdType tupleIdx, double* tuple) override;
218  double* GetTuple(vtkIdType tupleIdx) override;
219 
231 
236  typedef ValueType* Iterator;
237  Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
238  Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
239 
241 
249  {
250  if (source)
251  {
252  switch (source->GetArrayType())
253  {
255  if (vtkDataTypesCompare(source->GetDataType(), vtkTypeTraits<ValueType>::VTK_TYPE_ID))
256  {
257  return static_cast<vtkAOSDataArrayTemplate<ValueType>*>(source);
258  }
259  break;
260  }
261  }
262  return nullptr;
263  }
265 
266  int GetArrayType() const override { return vtkAbstractArray::AoSDataArrayTemplate; }
268  bool HasStandardMemoryLayout() const override { return true; }
269  void ShallowCopy(vtkDataArray* other) override;
270 
271  // Reimplemented for efficiency:
272  void InsertTuples(
273  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
274  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
275  // using Superclass::InsertTuples;
276  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override
277  {
278  this->Superclass::InsertTuples(dstIds, srcIds, source);
279  }
280 
281 protected:
283  ~vtkAOSDataArrayTemplate() override;
284 
289  bool AllocateTuples(vtkIdType numTuples);
290 
295  bool ReallocateTuples(vtkIdType numTuples);
296 
298 
299 private:
301  void operator=(const vtkAOSDataArrayTemplate&) = delete;
302 
303  friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>;
304 };
305 
306 // Declare vtkArrayDownCast implementations for AoS containers:
308 
309 // This macro is used by the subclasses to create dummy
310 // declarations for these functions such that the wrapper
311 // can see them. The wrappers ignore vtkAOSDataArrayTemplate.
312 #define vtkCreateWrappedArrayInterface(T) \
313  int GetDataType() const override; \
314  void GetTypedTuple(vtkIdType i, T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
315  void SetTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
316  void InsertTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i); \
317  vtkIdType InsertNextTypedTuple(const T* tuple); \
318  T GetValue(vtkIdType id) const VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
319  void SetValue(vtkIdType id, T value) VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
320  bool SetNumberOfValues(vtkIdType number) override; \
321  void InsertValue(vtkIdType id, T f) VTK_EXPECTS(0 <= id); \
322  vtkIdType InsertNextValue(T f); \
323  T* GetValueRange(int comp) VTK_SIZEHINT(2); \
324  T* GetValueRange() VTK_SIZEHINT(2); \
325  T* WritePointer(vtkIdType id, vtkIdType number); \
326  T* GetPointer(vtkIdType id); \
327  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
328  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
329 
330 #endif // header guard
331 
332 // This portion must be OUTSIDE the include blockers. This is used to tell
333 // libraries other than vtkCommonCore that instantiations of
334 // vtkAOSDataArrayTemplate can be found externally. This prevents each library
335 // from instantiating these on their own.
336 #ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
337 #define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
338  template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate<T>
339 #elif defined(VTK_USE_EXTERN_TEMPLATE)
340 #ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
341 #define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
342 #ifdef _MSC_VER
343 #pragma warning(push)
344 // The following is needed when the vtkAOSDataArrayTemplate is declared
345 // dllexport and is used from another class in vtkCommonCore
346 #pragma warning(disable : 4910) // extern and dllexport incompatible
347 #endif
348 vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
349 #ifdef _MSC_VER
350 #pragma warning(pop)
351 #endif
352 #endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
353 
354 // The following clause is only for MSVC
355 #elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
356 #pragma warning(push)
357 
358 // C4091: 'extern ' : ignored on left of 'int' when no variable is declared
359 #pragma warning(disable : 4091)
360 
361 // Compiler-specific extension warning.
362 #pragma warning(disable : 4231)
363 
364 // We need to disable warning 4910 and do an extern dllexport
365 // anyway. When deriving vtkCharArray and other types from an
366 // instantiation of this template the compiler does an explicit
367 // instantiation of the base class. From outside the vtkCommon
368 // library we block this using an extern dllimport instantiation.
369 // For classes inside vtkCommon we should be able to just do an
370 // extern instantiation, but VS complains about missing
371 // definitions. We cannot do an extern dllimport inside vtkCommon
372 // since the symbols are local to the dll. An extern dllexport
373 // seems to be the only way to convince VS to do the right
374 // thing, so we just disable the warning.
375 #pragma warning(disable : 4910) // extern and dllexport incompatible
376 
377 // Use an "extern explicit instantiation" to give the class a DLL
378 // interface. This is a compiler-specific extension.
379 vtkInstantiateTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
380 
381 #pragma warning(pop)
382 
383 #endif
384 
385 // VTK-HeaderTest-Exclude: vtkAOSDataArrayTemplate.h
vtkAOSDataArrayTemplate::InsertTuple
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
Definition: vtkAOSDataArrayTemplate.h:204
vtkAOSDataArrayTemplate::InsertNextTuple
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple from srcTupleIdx in the source array at the end of this array.
Definition: vtkAOSDataArrayTemplate.h:213
vtkAbstractArray::DeleteMethod
DeleteMethod
Definition: vtkAbstractArray.h:321
VTK_ZEROCOPY
#define VTK_ZEROCOPY
Definition: vtkWrappingHints.h:43
vtkGenericDataArray::ValueType
ValueTypeT ValueType
Definition: vtkGenericDataArray.h:84
vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE
Definition: vtkAbstractArray.h:325
vtkGenericDataArray::SetValue
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
Definition: vtkGenericDataArray.h:119
vtkTypeTraits
Template defining traits of native types used by VTK.
Definition: vtkTypeTraits.h:30
vtkGenericDataArray::vtkTemplateTypeMacro
vtkTemplateTypeMacro(SelfType, vtkDataArray)
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:44
vtkAOSDataArrayTemplate::Begin
Iterator Begin()
Definition: vtkAOSDataArrayTemplate.h:237
vtkX3D::value
Definition: vtkX3D.h:226
vtkAbstractArray::VTK_DATA_ARRAY_DELETE
Definition: vtkAbstractArray.h:324
vtkIdType
int vtkIdType
Definition: vtkType.h:343
vtkGenericDataArray::GetVoidPointer
void * GetVoidPointer(vtkIdType valueIdx) override
Default implementation raises a runtime error.
vtkGenericDataArray::InsertTuple
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
vtkGenericDataArray::SetVoidArray
void SetVoidArray(void *, vtkIdType, int) override
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkAOSDataArrayTemplate::SelfType
vtkAOSDataArrayTemplate< ValueTypeT > SelfType
Definition: vtkAOSDataArrayTemplate.h:47
save
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
Definition: vtkVariantBoostSerialization.h:64
vtkAbstractArray::VTK_DATA_ARRAY_FREE
Definition: vtkAbstractArray.h:323
vtkGenericDataArray::InsertNextTuple
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple from srcTupleIdx in the source array at the end of this array.
vtkGenericDataArray
Base interface for all typed vtkDataArray subclasses.
Definition: vtkGenericDataArray.h:79
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
vtkGenericDataArray::SetTuple
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.
vtkAOSDataArrayTemplate::SetTypedComponent
void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
Set component comp of the tuple at tupleIdx to value.
Definition: vtkAOSDataArrayTemplate.h:117
vtkGenericDataArray::GetTuple
double * GetTuple(vtkIdType tupleIdx) override
Get the data tuple at tupleIdx.
vtkGenericDataArray::SetArrayFreeFunction
void SetArrayFreeFunction(void(*callback)(void *)) override
This method allows the user to specify a custom free function to be called when the array is dealloca...
vtkGenericDataArray::DataChanged
void DataChanged() override
Tell the array explicitly that the data has changed.
vtkAOSDataArrayTemplate::GetTypedTuple
void GetTypedTuple(vtkIdType tupleIdx, ValueType *tuple) const
Copy the tuple at tupleIdx into tuple.
Definition: vtkAOSDataArrayTemplate.h:83
vtkAbstractArray::GetNumberOfTuples
vtkIdType GetNumberOfTuples() const
Get the number of complete tuples (a component group) in the array.
Definition: vtkAbstractArray.h:172
vtkBuffer< ValueType >
vtkGenericDataArray::FillTypedComponent
virtual void FillTypedComponent(int compIdx, ValueType value)
Set component comp of all tuples to value.
vtkAOSDataArrayTemplate::HasStandardMemoryLayout
bool HasStandardMemoryLayout() const override
Returns true if this array uses the standard memory layout defined in the VTK user guide,...
Definition: vtkAOSDataArrayTemplate.h:268
vtkAbstractArray::AoSDataArrayTemplate
Definition: vtkAbstractArray.h:637
vtkGenericDataArray::InsertTuples
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...
vtkAbstractArray::GetNumberOfValues
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Definition: vtkAbstractArray.h:180
vtkBuffer.h
vtkGenericDataArray::AllocateTuples
bool AllocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
Definition: vtkGenericDataArray.h:335
vtkAOSDataArrayTemplate::GetValue
ValueType GetValue(vtkIdType valueIdx) const
Get the value at valueIdx.
Definition: vtkAOSDataArrayTemplate.h:64
vtkExternTemplateMacro
#define vtkExternTemplateMacro(decl)
A macro to declare extern templates for all numerical types.
Definition: vtkType.h:408
vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
Definition: vtkAbstractArray.h:326
vtkGenericDataArray.h
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkX3D::size
Definition: vtkX3D.h:259
vtkAOSDataArrayTemplate::End
Iterator End()
Definition: vtkAOSDataArrayTemplate.h:238
vtkAOSDataArrayTemplate::DataElementChanged
void DataElementChanged(vtkIdType)
Tell the array explicitly that a single data element has changed.
Definition: vtkAOSDataArrayTemplate.h:230
vtkArrayDownCast_TemplateFastCastMacro
vtkArrayDownCast_TemplateFastCastMacro(vtkAOSDataArrayTemplate)
vtkDataArray::Fill
virtual void Fill(double value)
Fill all values of a data array with a specified value.
vtkAOSDataArrayTemplate::SetValue
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
Definition: vtkAOSDataArrayTemplate.h:73
vtkDataArray::ShallowCopy
virtual void ShallowCopy(vtkDataArray *other)
Create a shallow copy of other into this, if possible.
vtkGenericDataArray::FillValue
virtual void FillValue(ValueType value)
Set all the values in array to value.
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:75
vtkInstantiateTemplateMacro
#define vtkInstantiateTemplateMacro(decl)
A macro to instantiate a template over all numerical types.
Definition: vtkType.h:389
vtkGenericDataArray::NewIterator
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
vtkGenericDataArray::InsertComponent
void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override
Insert value at the location specified by tupleIdx and compIdx.
vtkAOSDataArrayTemplate::GetTypedComponent
ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
Get component comp of the tuple at tupleIdx.
Definition: vtkAOSDataArrayTemplate.h:107
vtkGenericDataArray::WritePointer
ValueType * WritePointer(vtkIdType valueIdx, vtkIdType numValues)
vtkArrayIterator
Abstract superclass to iterate over elements in an vtkAbstractArray.
Definition: vtkArrayIterator.h:49
vtkAOSDataArrayTemplate::GetArrayType
int GetArrayType() const override
Method for type-checking in FastDownCast implementations.
Definition: vtkAOSDataArrayTemplate.h:266
vtkAOSDataArrayTemplate::InsertTuples
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...
Definition: vtkAOSDataArrayTemplate.h:276
vtkGenericDataArray::GetPointer
ValueType * GetPointer(vtkIdType valueIdx)
vtkAOSDataArrayTemplate::Buffer
vtkBuffer< ValueType > * Buffer
Definition: vtkAOSDataArrayTemplate.h:297
vtkAOSDataArrayTemplate::FastDownCast
static vtkAOSDataArrayTemplate< ValueType > * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkAOSDataArrayTemplate.
Definition: vtkAOSDataArrayTemplate.h:248
vtkAOSDataArrayTemplate
Array-Of-Structs implementation of vtkGenericDataArray.
Definition: vtkAOSDataArrayTemplate.h:41
vtkGenericDataArray::WriteVoidPointer
void * WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override
Get the address of a particular data index.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:42
vtkAOSDataArrayTemplate::ValueType
Superclass::ValueType ValueType
Definition: vtkAOSDataArrayTemplate.h:49
vtkAOSDataArrayTemplate::SetTypedTuple
void SetTypedTuple(vtkIdType tupleIdx, const ValueType *tuple)
Set this array's tuple at tupleIdx to the values in tuple.
Definition: vtkAOSDataArrayTemplate.h:96
vtkAOSDataArrayTemplate::Iterator
ValueType * Iterator
Legacy support for array-of-structs value iteration.
Definition: vtkAOSDataArrayTemplate.h:236
vtkGenericDataArray::ReallocateTuples
bool ReallocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
Definition: vtkGenericDataArray.h:345
vtkAOSDataArrayTemplate::SetTuple
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.
Definition: vtkAOSDataArrayTemplate.h:196
vtkAbstractArray::NumberOfComponents
int NumberOfComponents
Definition: vtkAbstractArray.h:679