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  {
56  };
57 
58  static vtkAOSDataArrayTemplate* New();
59 
63  ValueType GetValue(vtkIdType valueIdx) const
64  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
65  {
66  return this->Buffer->GetBuffer()[valueIdx];
67  }
68 
73  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
74  {
75  this->Buffer->GetBuffer()[valueIdx] = value;
76  }
77 
79 
82  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
83  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
84  {
85  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
86  std::copy(this->Buffer->GetBuffer() + valueIdx,
87  this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents,
88  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,
101  this->Buffer->GetBuffer() + valueIdx);
102  }
104 
108  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
109  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
110  VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
111  {
112  return this->Buffer->GetBuffer()[this->NumberOfComponents*tupleIdx + comp];
113  }
114 
116 
119  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
120  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
121  VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
122  {
123  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
124  this->SetValue(valueIdx, value);
125  }
127 
129 
132  void FillTypedComponent(int compIdx, ValueType value) override;
134 
136 
139  void FillValue(ValueType value) override;
140  void Fill(double value) override;
142 
144 
149  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
150  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
152 
154 
161  ValueType* GetPointer(vtkIdType valueIdx);
162  void* GetVoidPointer(vtkIdType valueIdx) override;
164 
166 
180  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save,
181  int deleteMethod);
182  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save);
183  void SetVoidArray(void* array, vtkIdType size, int save) override;
184  void SetVoidArray(void* array, vtkIdType size, int save,
185  int deleteMethod) override;
187 
188  // Overridden for optimized implementations:
189  void SetTuple(vtkIdType tupleIdx, const float *tuple) override;
190  void SetTuple(vtkIdType tupleIdx, const double *tuple) override;
191  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
192  // using Superclass::SetTuple;
193  void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx,
194  vtkAbstractArray *source) override
195  { this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source); }
196  void InsertTuple(vtkIdType tupleIdx, const float *source) override;
197  void InsertTuple(vtkIdType tupleIdx, const double *source) override;
198  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
199  // using Superclass::InsertTuple;
200  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx,
201  vtkAbstractArray *source) override
202  { this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source); }
203  void InsertComponent(vtkIdType tupleIdx, int compIdx,
204  double value) override;
205  vtkIdType InsertNextTuple(const float *tuple) override;
206  vtkIdType InsertNextTuple(const double *tuple) override;
207  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
208  // using Superclass::InsertNextTuple;
210  vtkAbstractArray *source) override
211  { return this->Superclass::InsertNextTuple(srcTupleIdx, source); }
212  void GetTuple(vtkIdType tupleIdx, double * tuple) override;
213  double *GetTuple(vtkIdType tupleIdx) override;
214 
226 
231  typedef ValueType* Iterator;
232  Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
233  Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
234 
236 
245  {
246  if (source)
247  {
248  switch (source->GetArrayType())
249  {
251  if (vtkDataTypesCompare(source->GetDataType(),
253  {
254  return static_cast<vtkAOSDataArrayTemplate<ValueType>*>(source);
255  }
256  break;
257  }
258  }
259  return nullptr;
260  }
262 
265  bool HasStandardMemoryLayout() override { return true; }
266  void ShallowCopy(vtkDataArray *other) override;
267 
268  // Reimplemented for efficiency:
269  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
270  vtkAbstractArray* source) override;
271  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
272  // using Superclass::InsertTuples;
273  void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds,
274  vtkAbstractArray *source) override
275  { this->Superclass::InsertTuples(dstIds, srcIds, source); }
276 
277 protected:
279  ~vtkAOSDataArrayTemplate() override;
280 
285  bool AllocateTuples(vtkIdType numTuples);
286 
291  bool ReallocateTuples(vtkIdType numTuples);
292 
294 
295 private:
297  void operator=(const vtkAOSDataArrayTemplate&) = delete;
298 
299  friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>,
300  ValueTypeT>;
301 
302 };
303 
304 // Declare vtkArrayDownCast implementations for AoS containers:
306 
307 // This macro is used by the subclasses to create dummy
308 // declarations for these functions such that the wrapper
309 // can see them. The wrappers ignore vtkAOSDataArrayTemplate.
310 #define vtkCreateWrappedArrayInterface(T) \
311  int GetDataType() override;\
312  void GetTypedTuple(vtkIdType i, T* tuple) \
313  VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
314  void SetTypedTuple(vtkIdType i, const T* tuple) \
315  VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
316  void InsertTypedTuple(vtkIdType i, const T* tuple) \
317  VTK_EXPECTS(0 <= i); \
318  vtkIdType InsertNextTypedTuple(const T* tuple); \
319  T GetValue(vtkIdType id) \
320  VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
321  void SetValue(vtkIdType id, T value) \
322  VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
323  void SetNumberOfValues(vtkIdType number) override;\
324  void InsertValue(vtkIdType id, T f) \
325  VTK_EXPECTS(0 <= id); \
326  vtkIdType InsertNextValue(T f); \
327  T *GetValueRange(int comp) VTK_SIZEHINT(2); \
328  T *GetValueRange() VTK_SIZEHINT(2); \
329  T* WritePointer(vtkIdType id, vtkIdType number); \
330  T* GetPointer(vtkIdType id); \
331  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
332  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
333 
334 #endif // header guard
335 
336 // This portion must be OUTSIDE the include blockers. This is used to tell
337 // libraries other than vtkCommonCore that instantiations of
338 // vtkAOSDataArrayTemplate can be found externally. This prevents each library
339 // from instantiating these on their own.
340 #ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
341 #define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
342  template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate< T >
343 #elif defined(VTK_USE_EXTERN_TEMPLATE)
344 #ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
345 #define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
346 #ifdef _MSC_VER
347 #pragma warning (push)
348 // The following is needed when the vtkAOSDataArrayTemplate is declared
349 // dllexport and is used from another class in vtkCommonCore
350 #pragma warning (disable: 4910) // extern and dllexport incompatible
351 #endif
353  extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
354 #ifdef _MSC_VER
355 #pragma warning (pop)
356 #endif
357 #endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
358 
359 // The following clause is only for MSVC
360 #elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
361 #pragma warning (push)
362 
363 // C4091: 'extern ' : ignored on left of 'int' when no variable is declared
364 #pragma warning (disable: 4091)
365 
366 // Compiler-specific extension warning.
367 #pragma warning (disable: 4231)
368 
369 // We need to disable warning 4910 and do an extern dllexport
370 // anyway. When deriving vtkCharArray and other types from an
371 // instantiation of this template the compiler does an explicit
372 // instantiation of the base class. From outside the vtkCommon
373 // library we block this using an extern dllimport instantiation.
374 // For classes inside vtkCommon we should be able to just do an
375 // extern instantiation, but VS complains about missing
376 // definitions. We cannot do an extern dllimport inside vtkCommon
377 // since the symbols are local to the dll. An extern dllexport
378 // seems to be the only way to convince VS to do the right
379 // thing, so we just disable the warning.
380 #pragma warning (disable: 4910) // extern and dllexport incompatible
381 
382 // Use an "extern explicit instantiation" to give the class a DLL
383 // interface. This is a compiler-specific extension.
385  extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
386 
387 #pragma warning (pop)
388 
389 #endif
390 
391 // 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.
int vtkIdType
Definition: vtkType.h:345
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:413
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:393
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&#39;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