VTK
Portals.h
Go to the documentation of this file.
1 //=============================================================================
2 //
3 // Copyright (c) Kitware, Inc.
4 // All rights reserved.
5 // See LICENSE.txt for details.
6 //
7 // This software is distributed WITHOUT ANY WARRANTY; without even
8 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9 // PURPOSE. See the above copyright notice for more information.
10 //
11 // Copyright 2012 Sandia Corporation.
12 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
13 // the U.S. Government retains certain rights in this software.
14 //
15 //=============================================================================
16 
17 #ifndef vtkmlib_Portals_h
18 #define vtkmlib_Portals_h
19 #ifndef __VTK_WRAP__
20 
21 #include "vtkAcceleratorsVTKmModule.h"
22 #include "vtkmConfig.h" //required for general vtkm setup
23 #include "PortalTraits.h"
24 #include "vtkmTags.h"
25 
26 class vtkDataArray;
27 class vtkPoints;
28 
29 #include <vtkm/cont/internal/IteratorFromArrayPortal.h>
30 
31 namespace tovtkm {
32 
33 template <typename Type, typename VTKDataArrayType_>
34 class VTKM_ALWAYS_EXPORT vtkArrayPortal
35 {
36  static const int NUM_COMPONENTS = vtkm::VecTraits<Type>::NUM_COMPONENTS;
37 
38 public:
39  typedef VTKDataArrayType_ VTKDataArrayType;
42 
44 
45  vtkArrayPortal(VTKDataArrayType* array, vtkm::Id size);
46 
47  vtkm::Id GetNumberOfValues() const
48  {
49  return this->Size;
50  }
51 
52  VTKM_SUPPRESS_EXEC_WARNINGS
53  VTKM_EXEC
54  ValueType Get(vtkm::Id index) const;
55 
56  void Set(vtkm::Id index, const ValueType& value) const;
57 
58  typedef vtkm::cont::internal::IteratorFromArrayPortal<vtkArrayPortal>
60 
62  {
63  return IteratorType(*this, 0);
64  }
65 
67  {
68  return IteratorType(*this, this->Size);
69  }
70 
72  {
73  return this->VTKData;
74  }
75 
76 private:
77  VTKDataArrayType* VTKData;
78  vtkm::Id Size;
79 };
80 
81 template <typename Type> class VTKM_ALWAYS_EXPORT vtkPointsPortal
82 {
83  static const int NUM_COMPONENTS = vtkm::VecTraits<Type>::NUM_COMPONENTS;
84 
85 public:
88 
90 
92 
97  template <typename OtherType>
99 
100  vtkm::Id GetNumberOfValues() const
101  {
102  return this->Size;
103  }
104 
105  VTKM_SUPPRESS_EXEC_WARNINGS
106  VTKM_EXEC
107  ValueType Get(vtkm::Id index) const;
108 
109  void Set(vtkm::Id index, const ValueType& value) const;
110 
111  typedef vtkm::cont::internal::IteratorFromArrayPortal<vtkPointsPortal>
113 
115  {
116  return IteratorType(*this, 0);
117  }
118 
120  {
121  return IteratorType(*this, this->Size);
122  }
123 
125  {
126  return Points;
127  }
128 
129 private:
130  vtkPoints* Points;
131  ComponentType* Array;
132  vtkm::Id Size;
133 };
134 }
135 
136 #define VTKM_TEMPLATE_EXPORT_ArrayPortal(T, S) \
137  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
138  vtkArrayPortal<const T, S<T>>; \
139  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT vtkArrayPortal<T, S<T>>; \
140  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
141  vtkArrayPortal<const vtkm::Vec<T, 2>, S<T>>; \
142  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
143  vtkArrayPortal<vtkm::Vec<T, 2>, S<T>>; \
144  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
145  vtkArrayPortal<const vtkm::Vec<T, 3>, S<T>>; \
146  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
147  vtkArrayPortal<vtkm::Vec<T, 3>, S<T>>; \
148  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
149  vtkArrayPortal<const vtkm::Vec<T, 4>, S<T>>; \
150  extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
151  vtkArrayPortal<vtkm::Vec<T, 4>, S<T>>;
152 
153 #define VTKM_TEMPLATE_IMPORT_ArrayPortal(T, S) \
154  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT vtkArrayPortal<const T, S<T>>; \
155  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT vtkArrayPortal<T, S<T>>; \
156  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
157  vtkArrayPortal<const vtkm::Vec<T, 2>, S<T>>; \
158  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
159  vtkArrayPortal<vtkm::Vec<T, 2>, S<T>>; \
160  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
161  vtkArrayPortal<const vtkm::Vec<T, 3>, S<T>>; \
162  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
163  vtkArrayPortal<vtkm::Vec<T, 3>, S<T>>; \
164  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
165  vtkArrayPortal<const vtkm::Vec<T, 4>, S<T>>; \
166  template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT \
167  vtkArrayPortal<vtkm::Vec<T, 4>, S<T>>;
168 
169 #ifndef vtkmlib_Portals_cxx
170 #include <vtkm/cont/internal/ArrayPortalFromIterators.h>
171 namespace tovtkm {
172 // T extern template instantiations
184 
196 
197 #if VTKM_SIZE_LONG_LONG == 8
200 
203 #endif
204 
205 extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT
206  vtkPointsPortal<vtkm::Vec<vtkm::Float32, 3> const>;
207 extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT
208  vtkPointsPortal<vtkm::Vec<vtkm::Float64, 3> const>;
209 extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT
210  vtkPointsPortal<vtkm::Vec<vtkm::Float32, 3>>;
211 extern template class VTKACCELERATORSVTKM_TEMPLATE_EXPORT
212  vtkPointsPortal<vtkm::Vec<vtkm::Float64, 3>>;
213 }
214 
215 #endif // defined vtkmlib_Portals_cxx
216 
217 #include "Portals.hxx"
218 #endif
219 #endif // vtkmlib_Portals_h
typename vtkPortalTraits< Type >::Type ValueType
Definition: Portals.h:86
Struct-Of-Arrays implementation of vtkGenericDataArray.
IteratorType GetIteratorBegin() const
Definition: Portals.h:114
IteratorType GetIteratorEnd() const
Definition: Portals.h:119
vtkPoints * GetVtkData() const
Definition: Portals.h:124
typename vtkPortalTraits< Type >::ComponentType ComponentType
Definition: Portals.h:41
vtkm::Id GetNumberOfValues() const
Definition: Portals.h:100
vtkm::cont::internal::IteratorFromArrayPortal< vtkArrayPortal > IteratorType
Definition: Portals.h:59
VTKDataArrayType * GetVtkData() const
Definition: Portals.h:71
typename vtkPortalTraits< Type >::ComponentType ComponentType
Definition: Portals.h:87
vtkm::cont::internal::IteratorFromArrayPortal< vtkPointsPortal > IteratorType
Definition: Portals.h:112
Array-Of-Structs implementation of vtkGenericDataArray.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
VTKM_TEMPLATE_EXPORT_ArrayPortal(char, vtkAOSDataArrayTemplate)
vtkm::Id GetNumberOfValues() const
Definition: Portals.h:47
IteratorType GetIteratorEnd() const
Definition: Portals.h:66
typename std::remove_const< T >::type ComponentType
Definition: PortalTraits.h:32
VTKDataArrayType_ VTKDataArrayType
Definition: Portals.h:39
represent and manipulate 3D points
Definition: vtkPoints.h:33
IteratorType GetIteratorBegin() const
Definition: Portals.h:61
typename vtkPortalTraits< Type >::Type ValueType
Definition: Portals.h:40