243#ifndef vtkCellArray_h
244#define vtkCellArray_h
247#include "vtkCommonDataModelModule.h"
255#include "vtkFeatures.h"
257#include "vtkTypeInt32Array.h"
258#include "vtkTypeInt64Array.h"
262#include <initializer_list>
263#include <type_traits>
286#define VTK_CELL_ARRAY_V2
288VTK_ABI_NAMESPACE_BEGIN
322 return this->
AllocateExact(numCells, numCells * maxCellSize);
414 this->
Offsets->SetComponent(cellId, 0,
static_cast<double>(offset));
546 return std::is_same_v<vtkTypeInt32, vtkIdType>;
549 return std::is_same_v<vtkTypeInt64, vtkIdType>;
666 bool EnsureStorageForCellSize(
vtkIdType cellSize);
831 inline vtkIdType InsertNextCell(
int npts);
843 void UpdateCellCount(
int npts);
985 template <
class ArrayT>
988 template <
class OffsetsT>
991 return offsets->GetNumberOfValues() - 1;
994 template <
class ArrayT>
1001 template <
class OffsetsT>
1007 template <
class OffsetsT>
1013 template <
class OffsetsT>
1016 auto offsetsRange =
GetRange(offsets);
1017 return static_cast<vtkIdType>(offsetsRange[cellId + 1] - offsetsRange[cellId]);
1020 template <
class OffsetsT,
class ConnectivityT>
1024 auto offsetsRange =
GetRange(offsets);
1026 conn, offsetsRange[cellId], offsetsRange[cellId + 1]);
1094 template <
typename Functor,
typename... Args>
1101 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1105 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1109 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1113 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1117 functor(this->
Offsets.Get(), this->Connectivity.Get(), std::forward<Args>(args)...);
1121 template <
typename Functor,
typename... Args>
1128 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1132 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1136 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1140 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1144 functor(this->
Offsets.Get(), this->Connectivity.Get(), std::forward<Args>(args)...);
1151 template <
typename ArrayT>
1180 CellRangeType GetCellRange(
vtkIdType cellId);
1189 this->
Offsets->InsertNextValue(0);
1192 this->IsInMemkind =
true;
1196 void*
operator new(
size_t nSize)
1199#ifdef VTK_USE_MEMKIND
1206 void operator delete(
void* p)
1208#ifdef VTK_USE_MEMKIND
1229 bool IsInMemkind =
false;
1233 template <
typename Functor,
typename... Args>
1234 using GetReturnType =
decltype(std::declval<Functor>()(
1235 std::declval<VisitState<AOSArray32>&>(), std::declval<Args>()...));
1237 template <
typename Functor,
typename... Args>
1238 struct ReturnsVoid : std::is_same<GetReturnType<Functor, Args...>, void>
1272template <
typename ArrayT>
1275 return this->
Offsets->GetNumberOfValues() - 1;
1278template <
typename ArrayT>
1284template <
typename ArrayT>
1290template <
typename ArrayT>
1296template <
typename ArrayT>
1303VTK_ABI_NAMESPACE_END
1307VTK_ABI_NAMESPACE_BEGIN
1312 template <
class OffsetsT,
class ConnectivityT>
1319 OffsetsAccessorType offsetsAccesor(offsets);
1320 ConnectivityAccessorType connAccesor(conn);
1322 cellId = offsets->GetNumberOfValues() - 1;
1324 offsetsAccesor.InsertNext(
static_cast<ValueType
>(conn->GetNumberOfValues() + npts));
1328 connAccesor.InsertNext(
static_cast<ValueType
>(pts[i]));
1333 template <
class OffsetsT,
class ConnectivityT>
1338 AccessorType offsetsAccesor(offsets);
1340 cellId = offsets->GetNumberOfValues() - 1;
1342 offsetsAccesor.InsertNext(
static_cast<ValueType
>(conn->GetNumberOfValues() + npts));
1349 template <
class OffsetsT,
class ConnectivityT>
1354 auto offsetsRange =
GetRange(offsets);
1355 const ValueType cellBegin = offsetsRange[offsets->GetMaxId() - 1];
1356 offsetsRange[offsets->GetMaxId()] =
static_cast<ValueType
>(cellBegin + npts);
1362 template <
class OffsetsT,
class ConnectivityT>
1364 OffsetsT* offsets, ConnectivityT* vtkNotUsed(conn),
vtkIdType cellId,
vtkIdType& cellSize)
1372 template <
class OffsetsT,
class ConnectivityT>
1375 auto offsetsRange =
GetRange(offsets);
1376 const auto& beginOffset = offsetsRange[cellId];
1377 const auto& endOffset = offsetsRange[cellId + 1];
1379 const auto cellConnectivity =
GetRange(conn).begin() + beginOffset;
1384 for (
vtkIdType i = 0; i < cellSize; ++i)
1386 idPtr[i] =
static_cast<vtkIdType>(cellConnectivity[i]);
1390 template <
class OffsetsT,
class ConnectivityT>
1394 auto offsetsRange =
GetRange(offsets);
1395 const auto& beginOffset = offsetsRange[cellId];
1396 const auto& endOffset = offsetsRange[cellId + 1];
1397 cellSize =
static_cast<vtkIdType>(endOffset - beginOffset);
1398 const auto cellConnectivity =
GetRange(conn).begin() + beginOffset;
1401 for (
vtkIdType i = 0; i < cellSize; ++i)
1403 cellPoints[i] =
static_cast<vtkIdType>(cellConnectivity[i]);
1408 template <
typename ConnectivityT>
1412 std::is_base_of_v<vtkAOSDataArrayTemplate<vtkIdType>, ConnectivityT>;
1415 template <
class OffsetsT,
class ConnectivityT>
1416 typename std::enable_if_t<CanShareConnPtr<ConnectivityT>::value,
void>
operator()(
1420 auto offsetsRange =
GetRange(offsets);
1421 const auto& beginOffset = offsetsRange[cellId];
1422 const auto& endOffset = offsetsRange[cellId + 1];
1423 cellSize =
static_cast<vtkIdType>(endOffset - beginOffset);
1425 cellPoints = conn->GetPointer(beginOffset);
1428 template <
class OffsetsT,
class ConnectivityT>
1429 typename std::enable_if_t<!CanShareConnPtr<ConnectivityT>::value,
void>
operator()(
1433 auto offsetsRange =
GetRange(offsets);
1434 const auto& beginOffset = offsetsRange[cellId];
1435 const auto& endOffset = offsetsRange[cellId + 1];
1436 cellSize =
static_cast<vtkIdType>(endOffset - beginOffset);
1437 const auto cellConnectivity =
GetRange(conn).begin() + beginOffset;
1441 for (
vtkIdType i = 0; i < cellSize; ++i)
1443 tempPtr[i] =
static_cast<vtkIdType>(cellConnectivity[i]);
1446 cellPoints = tempPtr;
1452 template <
class OffsetsT,
class ConnectivityT>
1463 template <
class OffsetsT,
class ConnectivityT>
1470 AccessorType accessor(offsets);
1471 ValueType firstOffset = 0;
1472 accessor.InsertNext(firstOffset);
1478 template <
class OffsetsT,
class ConnectivityT>
1483 AccessorType accessor(conn);
1484 accessor.InsertNext(
static_cast<ValueType
>(
id));
1488VTK_ABI_NAMESPACE_END
1491VTK_ABI_NAMESPACE_BEGIN
1634VTK_ABI_NAMESPACE_END
Array-Of-Structs implementation of vtkGenericDataArray.
virtual vtkIdType GetNumberOfCells() const =0
Get the number of cells in the array.
void GetCellAtId(vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints)
Return the point ids for the cell at cellId.
A utility array for wrapping affine functions in implicit arrays.
static vtkAffineArray< ValueType > * FastDownCast(vtkAbstractArray *source)
Encapsulate traversal logic for vtkCellArray.
bool AppendLegacyFormat(vtkIdTypeArray *data, vtkIdType ptOffset=0)
Append an array of data with the legacy vtkCellArray layout, e.g.:
vtkIdType GetCellSize(vtkIdType cellId) const override
Return the size of the cell at cellId.
vtkDataArray * GetOffsetsArray() const
Return the array used to store cell offsets.
int GetNextCell(vtkIdType &npts, vtkIdType const *&pts)
void UseFixedSizeDefaultStorage(vtkIdType cellSize)
Initialize internal data structures to use 32- or 64-bit storage.
vtkIdType GetOffset(vtkIdType cellId) override
Get the offset (into the connectivity) for a specified cell id.
void UseDefaultStorage()
Initialize internal data structures to use 32- or 64-bit storage.
bool AllocateCopy(vtkCellArray *other)
Pre-allocate memory in internal data structures to match the used size of the input vtkCellArray.
static void SetDefaultStorageIs64Bit(bool val)
Control the default internal storage size.
void DeepCopy(vtkAbstractCellArray *ca) override
Perform a deep copy (no reference counting) of the given cell array.
bool IsValid()
Check that internal storage is consistent and in a valid state.
friend class vtkCellArrayIterator
bool SetData(vtkIdType cellSize, vtkDataArray *connectivity)
Sets the internal arrays to the supported connectivity array with an offsets array automatically gene...
void ShallowCopy(vtkAbstractCellArray *ca) override
Shallow copy ca into this cell array.
vtkIdType GetNumberOfOffsets() const override
Get the number of elements in the offsets array.
bool CanConvertToFixedSize64BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
vtkIdType GetTraversalCellId()
Get/Set the current cellId for traversal.
void SetData(AOSArray64 *, AOSArray64 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
vtkIdType GetNumberOfCells() const override
Get the number of cells in the array.
vtkAOSDataArrayTemplate< vtkTypeInt32 > AOSArray32
bool CanConvertToFixedSizeDefaultStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
vtkIdType GetNumberOfConnectivityIds() const override
Get the size of the connectivity array that stores the point ids.
vtkAOSDataArrayTemplate< vtkTypeInt64 > AOSArray64
bool CanConvertToStorageType(StorageTypes type) const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
void SetData(AffineArray32 *, AOSArray32 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
bool ConvertToFixedSize64BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
vtkAffineArray< vtkTypeInt64 > AffineArray64
bool AllocateExact(vtkIdType numCells, vtkIdType connectivitySize)
Pre-allocate memory in internal data structures.
bool ResizeExact(vtkIdType numCells, vtkIdType connectivitySize)
ResizeExact() resizes the internal structures to hold numCells total cell offsets and connectivitySiz...
AOSArray64 * GetOffsetsAOSArray64() const
Ensure that a cell of size cellSize can be safely inserted or appended.
bool AllocateEstimate(vtkIdType numCells, vtkIdType maxCellSize)
Pre-allocate memory in internal data structures.
bool ImportLegacyFormat(const vtkIdType *data, vtkIdType len)
Import an array of data with the legacy vtkCellArray layout, e.g.:
vtkIdType TraversalCellId
void UseFixedSize64BitStorage(vtkIdType cellSize)
Initialize internal data structures to use 32- or 64-bit storage.
bool IsStorageShareable() const override
bool IsStorageGeneric() const
void Use64BitStorage()
Initialize internal data structures to use 32- or 64-bit storage.
vtkSmartPointer< vtkDataArray > Offsets
vtkDataArray * GetConnectivityArray() const
Return the array used to store the point ids that define the cells' connectivity.
bool ConvertToDefaultStorage()
Convert internal data structures to use 32- or 64-bit storage.
bool CanConvertToDefaultStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
static bool DefaultStorageIs64Bit
bool CanConvertTo32BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
void GetCellAtId(vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *ptIds) override
Return the point ids for the cell at cellId.
void SetData(AffineArray64 *, AOSArray64 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
void InsertCellPoint(vtkIdType id)
Used in conjunction with InsertNextCell(npts) to add another point to the list of cells.
unsigned long GetActualMemorySize() const
Return the memory in kibibytes (1024 bytes) consumed by this cell array.
vtkCellArrayIterator * NewIterator()
NewIterator returns a new instance of vtkCellArrayIterator that is initialized to point at the first ...
void ReplaceCellAtId(vtkIdType cellId, vtkIdList *list)
Replaces the point ids for the specified cell with the supplied list.
void UseFixedSize32BitStorage(vtkIdType cellSize)
Initialize internal data structures to use 32- or 64-bit storage.
void ReverseCellAtId(vtkIdType cellId)
Reverses the order of the point ids for the specified cell.
bool IsStorage32Bit() const
bool SetData(vtkDataArray *offsets, vtkDataArray *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
void Initialize() override
Free any memory and reset to an empty state.
void Squeeze()
Reclaim any extra memory while preserving data.
vtkSmartPointer< vtkDataArray > Connectivity
bool IsStorageFixedSize32Bit() const
bool ConvertTo32BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
AffineArray64 * GetOffsetsAffineArray64() const
Ensure that a cell of size cellSize can be safely inserted or appended.
bool ImportLegacyFormat(vtkIdTypeArray *data)
Import an array of data with the legacy vtkCellArray layout, e.g.:
bool ConvertToFixedSizeDefaultStorage()
Convert internal data structures to use 32- or 64-bit storage.
void SetData(AOSArray32 *, AOSArray32 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
bool ConvertToStorageType(StorageTypes type)
Convert internal data structures to use 32- or 64-bit storage.
AffineArray32 * GetOffsetsAffineArray32() const
Ensure that a cell of size cellSize can be safely inserted or appended.
void SetOffset(vtkIdType cellId, vtkIdType offset)
Set the offset (into the connectivity) for a specified cell id.
bool ConvertToSmallestStorage()
Convert internal data structures to use 32- or 64-bit storage.
bool AppendLegacyFormat(const vtkIdType *data, vtkIdType len, vtkIdType ptOffset=0)
Append an array of data with the legacy vtkCellArray layout, e.g.:
void ExportLegacyFormat(vtkIdTypeArray *data)
Fill data with the old-style vtkCellArray data layout, e.g.
bool ConvertTo64BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
bool ConvertToFixedSize32BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
vtkAffineArray< vtkTypeInt32 > AffineArray32
void Use32BitStorage()
Initialize internal data structures to use 32- or 64-bit storage.
vtkIdType GetCellPointAtId(vtkIdType cellId, vtkIdType cellPointIndex) const
Return the point id at cellPointIndex for the cell at cellId.
void SetTraversalCellId(vtkIdType cellId)
Get/Set the current cellId for traversal.
bool IsStorageFixedSize64Bit() const
static bool GetDefaultStorageIs64Bit()
Control the default internal storage size.
int GetMaxCellSize() override
Returns the size of the largest cell.
vtkIdType InsertNextCell(vtkCell *cell)
Insert a cell object.
void Dispatch(Functor &&functor, Args &&... args)
AOSArray32 * GetOffsetsAOSArray32() const
Ensure that a cell of size cellSize can be safely inserted or appended.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instantiation, type information, and printing.
void PrintDebug(ostream &os)
Standard methods for instantiation, type information, and printing.
vtkIdType IsHomogeneous() const override
Check if all cells have the same number of vertices.
bool EnsureStorageForCellSize(vtkIdType cellSize)
Ensure that a cell of size cellSize can be safely inserted or appended.
void UpdateCellCount(int npts)
Used in conjunction with InsertNextCell(int npts) and InsertCellPoint() to update the number of point...
void Dispatch(Functor &&functor, Args &&... args) const
bool IsStorageFixedSize() const
static vtkCellArray * New()
Standard methods for instantiation, type information, and printing.
StorageTypes GetStorageType() const noexcept
void ReplaceCellPointAtId(vtkIdType cellId, vtkIdType cellPointIndex, vtkIdType newPointId)
Replaces the pointId at cellPointIndex of a cell with newPointId.
bool CanConvertToFixedSize32BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
AOSArray32 * GetConnectivityAOSArray32() const
Return the array used to store the point ids that define the cells' connectivity.
void Append(vtkCellArray *src, vtkIdType pointOffset=0)
Append cells from src into this.
bool IsStorage64Bit() const
void ReplaceCellAtId(vtkIdType cellId, vtkIdType cellSize, const vtkIdType *cellPoints)
Replaces the point ids for the specified cell with the supplied list.
AOSArray64 * GetConnectivityAOSArray64() const
Return the array used to store the point ids that define the cells' connectivity.
bool CanConvertTo64BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
abstract class to specify cell behavior
vtkIdList * GetPointIds()
Return the list of point ids defining the cell.
static vtkDataArray * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray.
list of point or cell ids
void SetNumberOfIds(vtkIdType number)
Specify the number of ids for this object to hold.
vtkIdType GetNumberOfIds() const noexcept
Return the number of id's in the list.
void Reset()
Reset to an empty state but retain previously allocated memory.
vtkIdType * GetPointer(vtkIdType i)
Get a pointer to a particular data index.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
static vtkMallocingFunction GetCurrentMallocFunction()
static vtkFreeingFunction GetAlternateFreeFunction()
static bool GetUsingMemkind()
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) o...
Hold a reference to a vtkObjectBase instance.
static vtkSmartPointer< T > New()
Create an instance of a VTK object.
typename detail::GetAPITypeImpl< ArrayType, ForceValueTypeForVtkDataArray >::APIType GetAPIType
VTK_ITER_INLINE auto DataArrayValueRange(const ArrayTypePtr &array, ValueIdType start=-1, ValueIdType end=-1) -> typename detail::SelectValueRange< ArrayTypePtr, TupleSize, ForceValueTypeForVtkDataArray >::type
Generate an stl and for-range compatible range of flat AOS iterators from a vtkDataArray.
vtkIdType GetNumberOfCells(OffsetsT *offsets)
static vtkIdType GetCellSize(OffsetsT *offsets, vtkIdType cellId)
static vtkIdType GetEndOffset(OffsetsT *offsets, vtkIdType cellId)
static decltype(vtk::DataArrayValueRange< 1, vtkIdType >(std::declval< ConnectivityT >())) GetCellRange(OffsetsT *offsets, ConnectivityT *conn, vtkIdType cellId)
static vtkIdType GetBeginOffset(OffsetsT *offsets, vtkIdType cellId)
static decltype(vtk::DataArrayValueRange< 1, vtkIdType >(std::declval< ArrayT >())) GetRange(ArrayT *array)
vtk::GetAPIType< ArrayT, vtkIdType > GetAPIType
vtkIdType GetNumberOfCells() const
friend class vtkCellArray
vtkIdType GetEndOffset(vtkIdType cellId) const
vtkSmartPointer< ArrayType > Offsets
vtkSmartPointer< ArrayType > Connectivity
static constexpr bool ValueTypeIsSameAsIdType
const ArrayType * GetOffsets() const
decltype(vtk::DataArrayValueRange< 1 >(std::declval< ArrayType >())) CellRangeType
CellRangeType GetCellRange(vtkIdType cellId)
vtkIdType GetBeginOffset(vtkIdType cellId) const
vtkIdType GetCellSize(vtkIdType cellId) const
const ArrayType * GetConnectivity() const
typename ArrayType::ValueType ValueType
ArrayType * GetConnectivity()
void operator()(OffsetsT *offsets, ConnectivityT *conn, vtkIdType cellId, vtkIdType cellPointIndex, vtkIdType &pointId)
static constexpr bool value
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdList *ids)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType *cellPoints)
std::enable_if_t< CanShareConnPtr< ConnectivityT >::value, void > operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *temp)
std::enable_if_t<!CanShareConnPtr< ConnectivityT >::value, void > operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *temp)
void operator()(OffsetsT *offsets, ConnectivityT *conn, vtkIdType cellId, vtkIdType &cellSize)
void operator()(OffsetsT *offsets, ConnectivityT *conn, vtkIdType id)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType npts, vtkIdType &cellId)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType npts, const vtkIdType pts[], vtkIdType &cellId)
void operator()(OffsetsT *offsets, ConnectivityT *conn)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType npts)
Efficient templated access to vtkDataArray.
STL-compatible iterable ranges that provide access to vtkDataArray elements.
#define VTK_DEPRECATED_IN_9_8_0(reason)
#define VTK_SIZEHINT(...)
#define VTK_MARSHALMANUAL