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 =========================================================================*/
34 #ifndef vtkAOSDataArrayTemplate_h
35 #define vtkAOSDataArrayTemplate_h
36 
37 #include "vtkCommonCoreModule.h" // For export macro
38 #include "vtkGenericDataArray.h"
39 #include "vtkBuffer.h" // For storage buffer.
40 
41 // The export macro below makes no sense, but is necessary for older compilers
42 // when we export instantiations of this class from vtkCommonCore.
43 template <class ValueTypeT>
44 class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate :
45  public vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>
46 {
49 public:
52  typedef typename Superclass::ValueType ValueType;
53 
55  {
59  };
60 
61  static vtkAOSDataArrayTemplate* New();
62 
66  ValueType GetValue(vtkIdType valueIdx) const
67  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
68  {
69  return this->Buffer->GetBuffer()[valueIdx];
70  }
71 
76  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
77  {
78  this->Buffer->GetBuffer()[valueIdx] = value;
79  }
80 
82 
85  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
86  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
87  {
88  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
89  std::copy(this->Buffer->GetBuffer() + valueIdx,
90  this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents,
91  tuple);
92  }
94 
96 
99  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
100  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
101  {
102  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
103  std::copy(tuple, tuple + this->NumberOfComponents,
104  this->Buffer->GetBuffer() + valueIdx);
105  }
107 
111  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
112  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
113  VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
114  {
115  return this->Buffer->GetBuffer()[this->NumberOfComponents*tupleIdx + comp];
116  }
117 
119 
122  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
123  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
124  VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
125  {
126  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
127  this->SetValue(valueIdx, value);
128  }
130 
132 
135  void FillTypedComponent(int compIdx, ValueType value) override;
137 
139 
142  void FillValue(ValueType value) override;
143  void Fill(double value) override;
145 
147 
152  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
153  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
155 
157 
164  ValueType* GetPointer(vtkIdType valueIdx);
165  void* GetVoidPointer(vtkIdType valueIdx) override;
167 
169 
183  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save,
184  int deleteMethod);
185  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save);
186  void SetVoidArray(void* array, vtkIdType size, int save) override;
187  void SetVoidArray(void* array, vtkIdType size, int save,
188  int deleteMethod) 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,
197  vtkAbstractArray *source) override
198  { this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source); }
199  void InsertTuple(vtkIdType tupleIdx, const float *source) override;
200  void InsertTuple(vtkIdType tupleIdx, const double *source) override;
201  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
202  // using Superclass::InsertTuple;
203  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx,
204  vtkAbstractArray *source) override
205  { this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source); }
206  void InsertComponent(vtkIdType tupleIdx, int compIdx,
207  double value) override;
208  vtkIdType InsertNextTuple(const float *tuple) override;
209  vtkIdType InsertNextTuple(const double *tuple) override;
210  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
211  // using Superclass::InsertNextTuple;
213  vtkAbstractArray *source) override
214  { return this->Superclass::InsertNextTuple(srcTupleIdx, source); }
215  void GetTuple(vtkIdType tupleIdx, double * tuple) override;
216  double *GetTuple(vtkIdType tupleIdx) override;
217 
229 
234  typedef ValueType* Iterator;
235  Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
236  Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
237 
239 
248  {
249  if (source)
250  {
251  switch (source->GetArrayType())
252  {
254  if (vtkDataTypesCompare(source->GetDataType(),
256  {
257  return static_cast<vtkAOSDataArrayTemplate<ValueType>*>(source);
258  }
259  break;
260  }
261  }
262  return nullptr;
263  }
265 
268  bool HasStandardMemoryLayout() override { return true; }
269  void ShallowCopy(vtkDataArray *other) override;
270 
271  // Reimplemented for efficiency:
272  void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart,
273  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,
277  vtkAbstractArray *source) override
278  { this->Superclass::InsertTuples(dstIds, srcIds, source); }
279 
280 protected:
282  ~vtkAOSDataArrayTemplate() override;
283 
288  bool AllocateTuples(vtkIdType numTuples);
289 
294  bool ReallocateTuples(vtkIdType numTuples);
295 
297 
298 private:
300  void operator=(const vtkAOSDataArrayTemplate&) = delete;
301 
302  friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>,
303  ValueTypeT>;
304 
305 };
306 
307 // Declare vtkArrayDownCast implementations for AoS containers:
309 
310 // This macro is used by the subclasses to create dummy
311 // declarations for these functions such that the wrapper
312 // can see them. The wrappers ignore vtkAOSDataArrayTemplate.
313 #define vtkCreateWrappedArrayInterface(T) \
314  int GetDataType(); \
315  void GetTypedTuple(vtkIdType i, T* tuple) \
316  VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
317  void SetTypedTuple(vtkIdType i, const T* tuple) \
318  VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
319  void InsertTypedTuple(vtkIdType i, const T* tuple) \
320  VTK_EXPECTS(0 <= i); \
321  vtkIdType InsertNextTypedTuple(const T* tuple); \
322  T GetValue(vtkIdType id) \
323  VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
324  void SetValue(vtkIdType id, T value) \
325  VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
326  void SetNumberOfValues(vtkIdType number); \
327  void InsertValue(vtkIdType id, T f) \
328  VTK_EXPECTS(0 <= id); \
329  vtkIdType InsertNextValue(T f); \
330  T *GetValueRange(int comp); \
331  T *GetValueRange(); \
332  T* WritePointer(vtkIdType id, vtkIdType number); \
333  T* GetPointer(vtkIdType id); \
334  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
335  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
336 
337 #endif // header guard
338 
339 // This portion must be OUTSIDE the include blockers. This is used to tell
340 // libraries other than vtkCommonCore that instantiations of
341 // vtkAOSDataArrayTemplate can be found externally. This prevents each library
342 // from instantiating these on their own.
343 #ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
344 #define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
345  template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate< T >
346 #elif defined(VTK_USE_EXTERN_TEMPLATE)
347 #ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
348 #define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
349 #ifdef _MSC_VER
350 #pragma warning (push)
351 // The following is needed when the vtkAOSDataArrayTemplate is declared
352 // dllexport and is used from another class in vtkCommonCore
353 #pragma warning (disable: 4910) // extern and dllexport incompatible
354 #endif
356  extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
357 #ifdef _MSC_VER
358 #pragma warning (pop)
359 #endif
360 #endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
361 
362 // The following clause is only for MSVC
363 #elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
364 #pragma warning (push)
365 
366 // C4091: 'extern ' : ignored on left of 'int' when no variable is declared
367 #pragma warning (disable: 4091)
368 
369 // Compiler-specific extension warning.
370 #pragma warning (disable: 4231)
371 
372 // We need to disable warning 4910 and do an extern dllexport
373 // anyway. When deriving vtkCharArray and other types from an
374 // instantiation of this template the compiler does an explicit
375 // instantiation of the base class. From outside the vtkCommon
376 // library we block this using an extern dllimport instantiation.
377 // For classes inside vtkCommon we should be able to just do an
378 // extern instantiation, but VS complains about missing
379 // definitions. We cannot do an extern dllimport inside vtkCommon
380 // since the symbols are local to the dll. An extern dllexport
381 // seems to be the only way to convince VS to do the right
382 // thing, so we just disable the warning.
383 #pragma warning (disable: 4910) // extern and dllexport incompatible
384 
385 // Use an "extern explicit instantiation" to give the class a DLL
386 // interface. This is a compiler-specific extension.
388  extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
389 
390 #pragma warning (pop)
391 
392 #endif
393 
394 // 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:411
Array-Of-Structs implementation of vtkGenericDataArray.
list of point or cell ids
Definition: vtkIdList.h:36
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:54
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:391
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:32
vtkBuffer< ValueType > * Buffer