1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkCellTypes.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkCellTypes
* @brief object provides direct access to cells in vtkCellArray and type information
*
* This class is a supplemental object to vtkCellArray to allow random access
* into cells as well as representing cell type information. The "location"
* field is the location in the vtkCellArray list in terms of an integer
* offset. An integer offset was used instead of a pointer for easy storage
* and inter-process communication. The type information is defined in the
* file vtkCellType.h.
*
* @warning
* Sometimes this class is used to pass type information independent of the
* random access (i.e., location) information. For example, see
* vtkDataSet::GetCellTypes(). If you use the class in this way, you can use
* a location value of -1.
*
* @sa
* vtkCellArray vtkCellLinks
*/
#ifndef vtkCellTypes_h
#define vtkCellTypes_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkCellType.h" // Needed for inline methods
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
#include "vtkIdTypeArray.h" // Needed for inline methods
#include "vtkSmartPointer.h" // Needed for internals
#include "vtkUnsignedCharArray.h" // Needed for inline methods
VTK_ABI_NAMESPACE_BEGIN
class vtkIntArray;
class VTKCOMMONDATAMODEL_EXPORT vtkCellTypes : public vtkObject
{
public:
static vtkCellTypes* New();
vtkTypeMacro(vtkCellTypes, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Allocate memory for this array. Delete old storage only if necessary.
*/
int Allocate(vtkIdType sz = 512, vtkIdType ext = 1000);
/**
* Add a cell at specified id.
*/
void InsertCell(vtkIdType id, unsigned char type, vtkIdType loc);
/**
* Add a cell to the object in the next available slot.
*/
vtkIdType InsertNextCell(unsigned char type, vtkIdType loc);
/**
* Specify a group of cell types.
*
* \deprecated Please use method version that doesn't use `cellLocations` instead.
*/
VTK_DEPRECATED_IN_9_2_0("Please use version without cellLocations.")
void SetCellTypes(
vtkIdType ncells, vtkUnsignedCharArray* cellTypes, vtkIdTypeArray* cellLocations);
/**
* Specify a group of cell types.
*/
void SetCellTypes(vtkIdType ncells, vtkUnsignedCharArray* cellTypes);
VTK_DEPRECATED_IN_9_2_0("Please use version without cellLocations.")
void SetCellTypes(vtkIdType ncells, vtkUnsignedCharArray* cellTypes, vtkIntArray* cellLocations);
/**
* Return the location of the cell in the associated vtkCellArray.
*
* \deprecated This method will go away in future releases.
* Please do not rely on `CellLocation` in this class.
*/
VTK_DEPRECATED_IN_9_2_0("The Location API will disappear.")
vtkIdType GetCellLocation(vtkIdType cellId) { return this->LocationArray->GetValue(cellId); }
/**
* Delete cell by setting to nullptr cell type.
*/
void DeleteCell(vtkIdType cellId) { this->TypeArray->SetValue(cellId, VTK_EMPTY_CELL); }
/**
* Return the number of types in the list.
*/
vtkIdType GetNumberOfTypes() { return (this->MaxId + 1); }
/**
* Return 1 if type specified is contained in list; 0 otherwise.
*/
int IsType(unsigned char type);
/**
* Add the type specified to the end of the list. Range checking is performed.
*/
vtkIdType InsertNextType(unsigned char type) { return this->InsertNextCell(type, -1); }
/**
* Return the type of cell.
*/
unsigned char GetCellType(vtkIdType cellId) { return this->TypeArray->GetValue(cellId); }
/**
* Reclaim any extra memory.
*/
void Squeeze();
/**
* Initialize object without releasing memory.
*/
void Reset();
/**
* Return the memory in kibibytes (1024 bytes) consumed by this cell type array.
* Used to support streaming and reading/writing data. The value
* returned is guaranteed to be greater than or equal to the memory
* required to actually represent the data represented by this object.
* The information returned is valid only after the pipeline has
* been updated.
*/
unsigned long GetActualMemorySize();
/**
* Standard DeepCopy method. Since this object contains no reference
* to other objects, there is no ShallowCopy.
*/
void DeepCopy(vtkCellTypes* src);
/**
* Given an int (as defined in vtkCellType.h) identifier for a class
* return it's classname.
*/
static const char* GetClassNameFromTypeId(int typeId);
/**
* Given a data object classname, return it's int identified (as
* defined in vtkCellType.h)
*/
static int GetTypeIdFromClassName(const char* classname);
/**
* This convenience method is a fast check to determine if a cell type
* represents a linear or nonlinear cell. This is generally much more
* efficient than getting the appropriate vtkCell and checking its IsLinear
* method.
*/
static int IsLinear(unsigned char type);
/**
* Get the dimension of a cell.
*/
static int GetDimension(unsigned char type);
///@{
/**
* Methods for obtaining the arrays representing types and locations.
*/
vtkUnsignedCharArray* GetCellTypesArray() { return this->TypeArray; }
vtkIdTypeArray* GetCellLocationsArray() { return this->LocationArray; }
///@}
protected:
vtkCellTypes();
~vtkCellTypes() override = default;
vtkSmartPointer<vtkUnsignedCharArray> TypeArray; // pointer to types array
// DEPRECATION_IN_9_2_0 Note for whoever is in deprecation duties:
// The attribute LocationArray needs to be deleted, and any code in this class that would fail
// compiling because of its removal deleted as well.
vtkSmartPointer<vtkIdTypeArray> LocationArray; // pointer to array of offsets
vtkIdType MaxId; // maximum index inserted thus far
private:
vtkCellTypes(const vtkCellTypes&) = delete;
void operator=(const vtkCellTypes&) = delete;
};
//----------------------------------------------------------------------------
inline int vtkCellTypes::IsType(unsigned char type)
{
vtkIdType numTypes = this->GetNumberOfTypes();
for (vtkIdType i = 0; i < numTypes; i++)
{
if (type == this->GetCellType(i))
{
return 1;
}
}
return 0;
}
//-----------------------------------------------------------------------------
inline int vtkCellTypes::IsLinear(unsigned char type)
{
return ((type <= 20) || (type == VTK_CONVEX_POINT_SET) || (type == VTK_POLYHEDRON));
}
VTK_ABI_NAMESPACE_END
#endif
|
