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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkCellArray.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 vtkCellArray
* @brief object to represent cell connectivity
*
* vtkCellArray stores dataset topologies as an explicit connectivity table
* listing the point ids that make up each cell.
*
* Internally, the connectivity table is represented as two arrays: Offsets and
* Connectivity.
*
* Offsets is an array of [numCells+1] values indicating the index in the
* Connectivity array where each cell's points start. The last value is always
* the length of the Connectivity array.
*
* The Connectivity array stores the lists of point ids for each cell.
*
* Thus, for a dataset consisting of 2 triangles, a quad, and a line, the
* internal arrays will appear as follows:
*
* ```
* Topology:
* ---------
* Cell 0: Triangle | point ids: {0, 1, 2}
* Cell 1: Triangle | point ids: {5, 7, 2}
* Cell 2: Quad | point ids: {3, 4, 6, 7}
* Cell 4: Line | point ids: {5, 8}
*
* vtkCellArray (current):
* -----------------------
* Offsets: {0, 3, 6, 10, 12}
* Connectivity: {0, 1, 2, 5, 7, 2, 3, 4, 6, 7, 5, 8}
* ```
*
* While this class provides traversal methods (the legacy InitTraversal(),
* GetNextCell() methods, and the newer method GetCellAtId()) these are in
* general not thread-safe. Whenever possible it is preferrable to use a
* local thread-safe, vtkCellArrayIterator object, which can be obtained via:
*
* ```
* auto iter = vtk::TakeSmartPointer(cellArray->NewIterator());
* for (iter->GoToFirstCell(); !iter->IsDoneWithTraversal(); iter->GoToNextCell())
* {
* // do work with iter
* }
* ```
* (Note however that depending on the type and structure of internal
* storage, a cell array iterator may be significantly slower than direct
* traversal over the cell array due to extra data copying. Factors of 3-4X
* are not uncommon. See vtkCellArrayIterator for more information. Also note
* that an iterator may become invalid if the internal vtkCellArray storage
* is modified.)
*
* Other methods are also available for allocation and memory-related
* management; insertion of new cells into the vtkCellArray; and limited
* editing operations such as replacing one cell with a new cell of the
* same size.
*
* The internal arrays may store either 32- or 64-bit values, though most of
* the API will prefer to use vtkIdType to refer to items in these
* arrays. This enables significant memory savings when vtkIdType is 64-bit,
* but 32 bits are sufficient to store all of the values in the connectivity
* table. Using 64-bit storage with a 32-bit vtkIdType is permitted, but
* values too large to fit in a 32-bit signed integer will be truncated when
* accessed through the API. (The particular internal storage type has
* implications on performance depending on vtkIdType. If the internal
* storage is equivalent to vtkIdType, then methods that return pointers to
* arrays of point ids can share the internal storage; otherwise a copy of
* internal memory must be performed.)
*
* Methods for managing the storage type are:
*
* - `bool IsStorage64Bit()`
* - `bool IsStorageShareable() // Can pointers to internal storage be shared`
* - `void Use32BitStorage()`
* - `void Use64BitStorage()`
* - `void UseDefaultStorage() // Depends on vtkIdType`
* - `bool CanConvertTo32BitStorage()`
* - `bool CanConvertTo64BitStorage()`
* - `bool CanConvertToDefaultStorage() // Depends on vtkIdType`
* - `bool ConvertTo32BitStorage()`
* - `bool ConvertTo64BitStorage()`
* - `bool ConvertToDefaultStorage() // Depends on vtkIdType`
* - `bool ConvertToSmallestStorage() // Depends on current values in arrays`
*
* Note that some legacy methods are still available that reflect the
* previous storage format of this data, which embedded the cell sizes into
* the Connectivity array:
*
* ```
* vtkCellArray (legacy):
* ----------------------
* Connectivity: {3, 0, 1, 2, 3, 5, 7, 2, 4, 3, 4, 6, 7, 2, 5, 8}
* |--Cell 0--||--Cell 1--||----Cell 2---||--C3-|
* ```
*
* The methods require an external lookup table to allow random access, which
* was historically stored in the vtkCellTypes object. The following methods in
* vtkCellArray still support this style of indexing for compatibility
* purposes, but these are slow as they must perform some complex computations
* to convert the old "location" into the new "offset" and should be avoided.
* These methods (and their modern equivalents) are:
*
* - GetCell (Prefer GetCellAtId)
* - GetInsertLocation (Prefer GetNumberOfCells)
* - GetTraversalLocation (Prefer GetTraversalCellId, or better, NewIterator)
* - SetTraversalLocation (Prefer SetTraversalLocation, or better, NewIterator)
* - ReverseCell (Prefer ReverseCellAtId)
* - ReplaceCell (Prefer ReplaceCellAtId)
* - SetCells (Use ImportLegacyFormat, or SetData)
* - GetData (Use ExportLegacyFormat, or Get[Offsets|Connectivity]Array[|32|64])
*
* Some other legacy methods were completely removed, such as GetPointer() /
* WritePointer(), since they are cannot be effectively emulated under the
* current design. If external code needs to support both the old and new
* version of the vtkCellArray API, the VTK_CELL_ARRAY_V2 preprocessor
* definition may be used to detect which API is being compiled against.
*
* @sa vtkCellTypes vtkCellLinks
*/
#ifndef vtkCellArray_h
#define vtkCellArray_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkAOSDataArrayTemplate.h" // Needed for inline methods
#include "vtkCell.h" // Needed for inline methods
#include "vtkDataArrayRange.h" // Needed for inline methods
#include "vtkSmartPointer.h" // For vtkSmartPointer
#include "vtkTypeInt32Array.h" // Needed for inline methods
#include "vtkTypeInt64Array.h" // Needed for inline methods
#include "vtkTypeList.h" // Needed for ArrayList definition
#include <cassert> // for assert
#include <initializer_list> // for API
#include <type_traits> // for std::is_same
#include <utility> // for std::forward
/**
* @def VTK_CELL_ARRAY_V2
* @brief This preprocessor definition indicates that the updated vtkCellArray
* is being used. It may be used to conditionally switch between old and new
* API when both must be supported.
*
* For example:
*
* ```
* vtkIdType npts;
*
* #ifdef VTK_CELL_ARRAY_V2
* const vtkIdType *pts;
* #else // VTK_CELL_ARRAY_V2
* vtkIdType *pts'
* #endif // VTK_CELL_ARRAY_V2
*
* cellArray->GetCell(legacyLocation, npts, pts);
* ```
*/
#define VTK_CELL_ARRAY_V2
class vtkCellArrayIterator;
class vtkIdTypeArray;
class VTKCOMMONDATAMODEL_EXPORT vtkCellArray : public vtkObject
{
public:
using ArrayType32 = vtkTypeInt32Array;
using ArrayType64 = vtkTypeInt64Array;
//@{
/**
* Standard methods for instantiation, type information, and
* printing.
*/
static vtkCellArray* New();
vtkTypeMacro(vtkCellArray, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
void PrintDebug(ostream& os);
//@}
/**
* List of possible array types used for storage. May be used with
* vtkArrayDispatch::Dispatch[2]ByArray to process internal arrays.
* Both the Connectivity and Offset arrays are guaranteed to have the same
* type.
*
* @sa vtkCellArray::Visit() for a simpler mechanism.
*/
using StorageArrayList = vtkTypeList::Create<ArrayType32, ArrayType64>;
/**
* List of possible ArrayTypes that are compatible with internal storage.
* Single component AOS-layout arrays holding one of these types may be
* passed to the method SetData to setup the cell array state.
*
* This can be used with vtkArrayDispatch::DispatchByArray, etc to
* check input arrays before assigning them to a cell array.
*/
using InputArrayList =
typename vtkTypeList::Unique<vtkTypeList::Create<vtkAOSDataArrayTemplate<int>,
vtkAOSDataArrayTemplate<long>, vtkAOSDataArrayTemplate<long long> > >::Result;
/**
* Allocate memory.
*
* This currently allocates both the offsets and connectivity arrays to @a sz.
*
* @note It is preferrable to use AllocateEstimate(numCells, maxCellSize)
* or AllocateExact(numCells, connectivitySize) instead.
*/
vtkTypeBool Allocate(vtkIdType sz, vtkIdType vtkNotUsed(ext) = 1000)
{
return this->AllocateExact(sz, sz) ? 1 : 0;
}
/**
* @brief Pre-allocate memory in internal data structures. Does not change
* the number of cells, only the array capacities. Existing data is NOT
* preserved.
* @param numCells The number of expected cells in the dataset.
* @param maxCellSize The number of points per cell to allocate memory for.
* @return True if allocation succeeds.
* @sa Squeeze AllocateExact AllocateCopy
*/
bool AllocateEstimate(vtkIdType numCells, vtkIdType maxCellSize)
{
return this->AllocateExact(numCells, numCells * maxCellSize);
}
/**
* @brief Pre-allocate memory in internal data structures. Does not change
* the number of cells, only the array capacities. Existing data is NOT
* preserved.
* @param numCells The number of expected cells in the dataset.
* @param connectivitySize The total number of pointIds stored for all cells.
* @return True if allocation succeeds.
* @sa Squeeze AllocateEstimate AllocateCopy
*/
bool AllocateExact(vtkIdType numCells, vtkIdType connectivitySize);
/**
* @brief Pre-allocate memory in internal data structures to match the used
* size of the input vtkCellArray. Does not change
* the number of cells, only the array capacities. Existing data is NOT
* preserved.
* @param other The vtkCellArray to use as a reference.
* @return True if allocation succeeds.
* @sa Squeeze AllocateEstimate AllocateExact
*/
bool AllocateCopy(vtkCellArray* other)
{
return this->AllocateExact(other->GetNumberOfCells(), other->GetNumberOfConnectivityIds());
}
/**
* @brief ResizeExact() resizes the internal structures to hold @a numCells
* total cell offsets and @a connectivitySize total pointIds. Old data is
* preserved, and newly-available memory is not initialized.
*
* @warning For advanced use only. You probably want an Allocate method.
*
* @return True if allocation succeeds.
*/
bool ResizeExact(vtkIdType numCells, vtkIdType connectivitySize);
/**
* Free any memory and reset to an empty state.
*/
void Initialize();
/**
* Reuse list. Reset to initial state without freeing memory.
*/
void Reset();
/**
* Reclaim any extra memory while preserving data.
*
* @sa ConvertToSmallestStorage
*/
void Squeeze();
/**
* Check that internal storage is consistent and in a valid state.
*
* Specifically, this function returns true if and only if:
* - The offset and connectivity arrays have exactly one component.
* - The offset array has at least one value and starts at 0.
* - The offset array values never decrease.
* - The connectivity array has as many entries as the last value in the
* offset array.
*/
bool IsValid();
/**
* Get the number of cells in the array.
*/
vtkIdType GetNumberOfCells() const
{
if (this->Storage.Is64Bit())
{
return this->Storage.GetArrays64().Offsets->GetNumberOfValues() - 1;
}
else
{
return this->Storage.GetArrays32().Offsets->GetNumberOfValues() - 1;
}
}
/**
* Get the number of elements in the offsets array. This will be the number of
* cells + 1.
*/
vtkIdType GetNumberOfOffsets() const
{
if (this->Storage.Is64Bit())
{
return this->Storage.GetArrays64().Offsets->GetNumberOfValues();
}
else
{
return this->Storage.GetArrays32().Offsets->GetNumberOfValues();
}
}
/**
* Get the size of the connectivity array that stores the point ids.
* @note Do not confuse this with the deprecated
* GetNumberOfConnectivityEntries(), which refers to the legacy memory
* layout.
*/
vtkIdType GetNumberOfConnectivityIds() const
{
if (this->Storage.Is64Bit())
{
return this->Storage.GetArrays64().Connectivity->GetNumberOfValues();
}
else
{
return this->Storage.GetArrays32().Connectivity->GetNumberOfValues();
}
}
/**
* @brief NewIterator returns a new instance of vtkCellArrayIterator that
* is initialized to point at the first cell's data. The caller is responsible
* for Delete()'ing the object.
*/
VTK_NEWINSTANCE vtkCellArrayIterator* NewIterator();
#ifndef __VTK_WRAP__ // The wrappers have issues with some of these templates
/**
* Set the internal data arrays to the supplied offsets and connectivity
* arrays.
*
* Note that the input arrays may be copied and not used directly. To avoid
* copying, use vtkIdTypeArray, vtkCellArray::ArrayType32, or
* vtkCellArray::ArrayType64.
*
* @{
*/
void SetData(vtkTypeInt32Array* offsets, vtkTypeInt32Array* connectivity);
void SetData(vtkTypeInt64Array* offsets, vtkTypeInt64Array* connectivity);
void SetData(vtkIdTypeArray* offsets, vtkIdTypeArray* connectivity);
void SetData(vtkAOSDataArrayTemplate<int>* offsets, vtkAOSDataArrayTemplate<int>* connectivity);
void SetData(vtkAOSDataArrayTemplate<long>* offsets, vtkAOSDataArrayTemplate<long>* connectivity);
void SetData(
vtkAOSDataArrayTemplate<long long>* offsets, vtkAOSDataArrayTemplate<long long>* connectivity);
/**@}*/
#endif // __VTK_WRAP__
/**
* Sets the internal arrays to the supplied offsets and connectivity arrays.
*
* This is a convenience method, and may fail if the following conditions
* are not met:
*
* - Both arrays must be of the same type.
* - The array type must be one of the types in InputArrayList.
*
* If invalid arrays are passed in, an error is logged and the function
* will return false.
*/
bool SetData(vtkDataArray* offsets, vtkDataArray* connectivity);
/**
* @return True if the internal storage is using 64 bit arrays. If false,
* the storage is using 32 bit arrays.
*/
bool IsStorage64Bit() const { return this->Storage.Is64Bit(); }
/**
* @return True if the internal storage can be shared as a
* pointer to vtkIdType, i.e., the type and organization of internal
* storage is such that copying of data can be avoided, and instead
* a pointer to vtkIdType can be used.
*/
bool IsStorageShareable() const
{
if (this->Storage.Is64Bit())
{
return this->Storage.GetArrays64().ValueTypeIsSameAsIdType;
}
else
{
return this->Storage.GetArrays32().ValueTypeIsSameAsIdType;
}
}
/**
* Initialize internal data structures to use 32- or 64-bit storage.
* If selecting default storage, the storage depends on the VTK_USE_64BIT_IDS
* setting.
*
* All existing data is erased.
* @{
*/
void Use32BitStorage();
void Use64BitStorage();
void UseDefaultStorage();
/**@}*/
/**
* Check if the existing data can safely be converted to use 32- or 64- bit
* storage. Ensures that all values can be converted to the target storage
* without truncating.
* If selecting default storage, the storage depends on the VTK_USE_64BIT_IDS
* setting.
* @{
*/
bool CanConvertTo32BitStorage() const;
bool CanConvertTo64BitStorage() const;
bool CanConvertToDefaultStorage() const;
/**@}*/
/**
* Convert internal data structures to use 32- or 64-bit storage.
*
* If selecting default storage, the storage depends on the VTK_USE_64BIT_IDS
* setting.
*
* If selecting smallest storage, the data is checked to see what the smallest
* safe storage for the existing data is, and then converts to it.
*
* Existing data is preserved.
*
* @return True on success, false on failure. If this algorithm fails, the
* cell array will be in an unspecified state.
*
* @{
*/
bool ConvertTo32BitStorage();
bool ConvertTo64BitStorage();
bool ConvertToDefaultStorage();
bool ConvertToSmallestStorage();
/**@}*/
/**
* Return the array used to store cell offsets. The 32/64 variants are only
* valid when IsStorage64Bit() returns the appropriate value.
* @{
*/
vtkDataArray* GetOffsetsArray()
{
if (this->Storage.Is64Bit())
{
return this->GetOffsetsArray64();
}
else
{
return this->GetOffsetsArray32();
}
}
ArrayType32* GetOffsetsArray32() { return this->Storage.GetArrays32().Offsets; }
ArrayType64* GetOffsetsArray64() { return this->Storage.GetArrays64().Offsets; }
/**@}*/
/**
* Return the array used to store the point ids that define the cells'
* connectivity. The 32/64 variants are only valid when IsStorage64Bit()
* returns the appropriate value.
* @{
*/
vtkDataArray* GetConnectivityArray()
{
if (this->Storage.Is64Bit())
{
return this->GetConnectivityArray64();
}
else
{
return this->GetConnectivityArray32();
}
}
ArrayType32* GetConnectivityArray32() { return this->Storage.GetArrays32().Connectivity; }
ArrayType64* GetConnectivityArray64() { return this->Storage.GetArrays64().Connectivity; }
/**@}*/
/**
* Check if all cells have the same number of vertices.
*
* The return value is coded as:
* * -1 = heterogeneous
* * 0 = Cell array empty
* * n (positive integer) = homogeneous array of cell size n
*/
vtkIdType IsHomogeneous();
/**
* @warning This method is not thread-safe. Consider using the NewIterator()
* iterator instead.
*
* InitTraversal() initializes the traversal of the list of cells.
*
* @note This method is not thread-safe and has tricky syntax to use
* correctly. Prefer the use of vtkCellArrayIterator (see NewIterator()).
*/
void InitTraversal();
/**
* @warning This method is not thread-safe. Consider using the NewIterator()
* iterator instead.
*
* GetNextCell() gets the next cell in the list. If end of list
* is encountered, 0 is returned. A value of 1 is returned whenever
* npts and pts have been updated without error.
*
* Do not modify the returned @a pts pointer, as it may point to shared
* memory.
*
* @note This method is not thread-safe and has tricky syntax to use
* correctly. Prefer the use of vtkCellArrayIterator (see NewIterator()).
*/
int GetNextCell(vtkIdType& npts, vtkIdType const*& pts) VTK_SIZEHINT(pts, npts);
/**
* @warning This method is not thread-safe. Consider using the NewIterator()
* iterator instead.
*
* GetNextCell() gets the next cell in the list. If end of list is
* encountered, 0 is returned.
*
* @note This method is not thread-safe and has tricky syntax to use
* correctly. Prefer the use of vtkCellArrayIterator (see NewIterator()).
*/
int GetNextCell(vtkIdList* pts);
/**
* Return the point ids for the cell at @a cellId.
*
* @warning Subsequent calls to this method may invalidate previous call
* results if the internal storage type is not the same as vtkIdType and
* cannot be shared through the @a cellPoints pointer. In other words, the
* method may not be thread safe. Check if shareable (using
* IsStorageShareable()), or use a vtkCellArrayIterator to guarantee thread
* safety.
*/
void GetCellAtId(vtkIdType cellId, vtkIdType& cellSize, vtkIdType const*& cellPoints)
VTK_SIZEHINT(cellPoints, cellSize) VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells());
/**
* Return the point ids for the cell at @a cellId. This always copies
* the cell ids (i.e., the list of points @a pts into the supplied
* vtkIdList). This method is thread safe.
*/
void GetCellAtId(vtkIdType cellId, vtkIdList* pts)
VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells());
/**
* Return the size of the cell at @a cellId.
*/
vtkIdType GetCellSize(const vtkIdType cellId) const;
/**
* Insert a cell object. Return the cell id of the cell.
*/
vtkIdType InsertNextCell(vtkCell* cell);
/**
* Create a cell by specifying the number of points and an array of point
* id's. Return the cell id of the cell.
*/
vtkIdType InsertNextCell(vtkIdType npts, const vtkIdType* pts) VTK_SIZEHINT(pts, npts);
/**
* Create a cell by specifying a list of point ids. Return the cell id of
* the cell.
*/
vtkIdType InsertNextCell(vtkIdList* pts);
/**
* Overload that allows `InsertNextCell({0, 1, 2})` syntax.
*
* @warning This approach is useful for testing, but beware that trying to
* pass a single value (eg. `InsertNextCell({3})`) will call the
* `InsertNextCell(int)` overload instead.
*/
vtkIdType InsertNextCell(const std::initializer_list<vtkIdType>& cell)
{
return this->InsertNextCell(static_cast<vtkIdType>(cell.size()), cell.begin());
}
/**
* Create cells by specifying a count of total points to be inserted, and
* then adding points one at a time using method InsertCellPoint(). If you
* don't know the count initially, use the method UpdateCellCount() to
* complete the cell. Return the cell id of the cell.
*/
vtkIdType InsertNextCell(int npts);
/**
* Used in conjunction with InsertNextCell(npts) to add another point
* to the list of cells.
*/
void InsertCellPoint(vtkIdType id);
/**
* Used in conjunction with InsertNextCell(int npts) and InsertCellPoint() to
* update the number of points defining the cell.
*/
void UpdateCellCount(int npts);
/**
* Get/Set the current cellId for traversal.
*
* @note This method is not thread-safe and has tricky syntax to use
* correctly. Prefer the use of vtkCellArrayIterator (see NewIterator()).
* @{
*/
vtkIdType GetTraversalCellId();
void SetTraversalCellId(vtkIdType cellId);
/**@}*/
/**
* Reverses the order of the point ids for the specified cell.
*/
void ReverseCellAtId(vtkIdType cellId) VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells());
/**
* Replaces the point ids for the specified cell with the supplied list.
*
* @warning This can ONLY replace the cell if the size does not change.
* Attempting to change cell size through this method will have undefined
* results.
* @{
*/
void ReplaceCellAtId(vtkIdType cellId, vtkIdList* list);
void ReplaceCellAtId(vtkIdType cellId, vtkIdType cellSize, const vtkIdType* cellPoints)
VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells()) VTK_SIZEHINT(cellPoints, cellSize);
/**@}*/
/**
* Overload that allows `ReplaceCellAtId(cellId, {0, 1, 2})` syntax.
*
* @warning This can ONLY replace the cell if the size does not change.
* Attempting to change cell size through this method will have undefined
* results.
*/
void ReplaceCellAtId(vtkIdType cellId, const std::initializer_list<vtkIdType>& cell)
{
return this->ReplaceCellAtId(cellId, static_cast<vtkIdType>(cell.size()), cell.begin());
}
/**
* Returns the size of the largest cell. The size is the number of points
* defining the cell.
*/
int GetMaxCellSize();
/**
* Perform a deep copy (no reference counting) of the given cell array.
*/
void DeepCopy(vtkCellArray* ca);
/**
* Shallow copy @a ca into this cell array.
*/
void ShallowCopy(vtkCellArray* ca);
/**
* Append cells from src into this. Point ids are offset by @a pointOffset.
*/
void Append(vtkCellArray* src, vtkIdType pointOffset = 0);
/**
* Fill @a data with the old-style vtkCellArray data layout, e.g.
*
* ```
* { n0, p0_0, p0_1, ..., p0_n, n1, p1_0, p1_1, ..., p1_n, ... }
* ```
*
* where `n0` is the number of points in cell 0, and `pX_Y` is the Y'th point
* in cell X.
*/
void ExportLegacyFormat(vtkIdTypeArray* data);
/**
* Import an array of data with the legacy vtkCellArray layout, e.g.:
*
* ```
* { n0, p0_0, p0_1, ..., p0_n, n1, p1_0, p1_1, ..., p1_n, ... }
* ```
*
* where `n0` is the number of points in cell 0, and `pX_Y` is the Y'th point
* in cell X.
* @{
*/
void ImportLegacyFormat(vtkIdTypeArray* data);
void ImportLegacyFormat(const vtkIdType* data, vtkIdType len) VTK_SIZEHINT(data, len);
/** @} */
/**
* Append an array of data with the legacy vtkCellArray layout, e.g.:
*
* ```
* { n0, p0_0, p0_1, ..., p0_n, n1, p1_0, p1_1, ..., p1_n, ... }
* ```
*
* where `n0` is the number of points in cell 0, and `pX_Y` is the Y'th point
* in cell X.
* @{
*/
void AppendLegacyFormat(vtkIdTypeArray* data, vtkIdType ptOffset = 0);
void AppendLegacyFormat(const vtkIdType* data, vtkIdType len, vtkIdType ptOffset = 0)
VTK_SIZEHINT(data, len);
/** @} */
/**
* Return the memory in kibibytes (1024 bytes) consumed by this cell 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() const;
// The following code is used to support
// The wrappers get understandably confused by some of the template code below
#ifndef __VTK_WRAP__
// Holds connectivity and offset arrays of the given ArrayType.
template <typename ArrayT>
struct VisitState
{
using ArrayType = ArrayT;
using ValueType = typename ArrayType::ValueType;
using CellRangeType = decltype(vtk::DataArrayValueRange<1>(std::declval<ArrayType>()));
// We can't just use is_same here, since binary compatible representations
// (e.g. int and long) are distinct types. Instead, ensure that ValueType
// is a signed integer the same size as vtkIdType.
// If this value is true, ValueType pointers may be safely converted to
// vtkIdType pointers via reinterpret cast.
static constexpr bool ValueTypeIsSameAsIdType = std::is_integral<ValueType>::value &&
std::is_signed<ValueType>::value && (sizeof(ValueType) == sizeof(vtkIdType));
ArrayType* GetOffsets() { return this->Offsets; }
const ArrayType* GetOffsets() const { return this->Offsets; }
ArrayType* GetConnectivity() { return this->Connectivity; }
const ArrayType* GetConnectivity() const { return this->Connectivity; }
vtkIdType GetNumberOfCells() const;
vtkIdType GetBeginOffset(vtkIdType cellId) const;
vtkIdType GetEndOffset(vtkIdType cellId) const;
vtkIdType GetCellSize(vtkIdType cellId) const;
CellRangeType GetCellRange(vtkIdType cellId);
friend class vtkCellArray;
protected:
VisitState()
: Connectivity(vtkSmartPointer<ArrayType>::New())
, Offsets(vtkSmartPointer<ArrayType>::New())
{
this->Offsets->InsertNextValue(0);
}
~VisitState() = default;
vtkSmartPointer<ArrayType> Connectivity;
vtkSmartPointer<ArrayType> Offsets;
private:
VisitState(const VisitState&) = delete;
VisitState& operator=(const VisitState&) = delete;
};
private: // Helpers that allow Visit to return a value:
template <typename Functor, typename... Args>
using GetReturnType = decltype(
std::declval<Functor>()(std::declval<VisitState<ArrayType32>&>(), std::declval<Args>()...));
template <typename Functor, typename... Args>
struct ReturnsVoid : std::is_same<GetReturnType<Functor, Args...>, void>
{
};
public:
/**
* @warning Advanced use only.
*
* The Visit methods allow efficient bulk modification of the vtkCellArray
* internal arrays by dispatching a functor with the current storage arrays.
* The simplest functor is of the form:
*
* ```
* // Functor definition:
* struct Worker
* {
* template <typename CellStateT>
* void operator()(CellStateT &state)
* {
* // Do work on state object
* }
* };
*
* // Functor usage:
* vtkCellArray *cellArray = ...;
* cellArray->Visit(Worker{});
* ```
*
* where `state` is an instance of the vtkCellArray::VisitState<ArrayT> class,
* instantiated for the current storage type of the cell array. See that
* class for usage details.
*
* The functor may also:
* - Return a value from `operator()`
* - Pass additional arguments to `operator()`
* - Hold state.
*
* A more advanced functor that does these things is shown below, along
* with its usage. This functor scans a range of cells and returns the largest
* cell's id:
*
* ```
* struct FindLargestCellInRange
* {
* template <typename CellStateT>
* vtkIdType operator()(CellStateT &state,
* vtkIdType rangeBegin,
* vtkIdType rangeEnd)
* {
* vtkIdType largest = rangeBegin;
* vtkIdType largestSize = state.GetCellSize(rangeBegin);
* ++rangeBegin;
* for (; rangeBegin < rangeEnd; ++rangeBegin)
* {
* const vtkIdType curSize = state.GetCellSize(rangeBegin);
* if (curSize > largestSize)
* {
* largest = rangeBegin;
* largestSize = curSize;
* }
* }
*
* return largest;
* }
* };
*
* // Usage:
* // Scan cells in range [128, 1024) and return the id of the largest.
* vtkCellArray cellArray = ...;
* vtkIdType largest = cellArray->Visit(FindLargestCellInRange{},
* 128, 1024);
* ```
* @{
*/
template <typename Functor, typename... Args,
typename = typename std::enable_if<ReturnsVoid<Functor, Args...>::value>::type>
void Visit(Functor&& functor, Args&&... args)
{
if (this->Storage.Is64Bit())
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
functor(this->Storage.GetArrays64(), std::forward<Args>(args)...);
}
else
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
functor(this->Storage.GetArrays32(), std::forward<Args>(args)...);
}
}
template <typename Functor, typename... Args,
typename = typename std::enable_if<ReturnsVoid<Functor, Args...>::value>::type>
void Visit(Functor&& functor, Args&&... args) const
{
if (this->Storage.Is64Bit())
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
functor(this->Storage.GetArrays64(), std::forward<Args>(args)...);
}
else
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
functor(this->Storage.GetArrays32(), std::forward<Args>(args)...);
}
}
template <typename Functor, typename... Args,
typename = typename std::enable_if<!ReturnsVoid<Functor, Args...>::value>::type>
GetReturnType<Functor, Args...> Visit(Functor&& functor, Args&&... args)
{
if (this->Storage.Is64Bit())
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
return functor(this->Storage.GetArrays64(), std::forward<Args>(args)...);
}
else
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
return functor(this->Storage.GetArrays32(), std::forward<Args>(args)...);
}
}
template <typename Functor, typename... Args,
typename = typename std::enable_if<!ReturnsVoid<Functor, Args...>::value>::type>
GetReturnType<Functor, Args...> Visit(Functor&& functor, Args&&... args) const
{
if (this->Storage.Is64Bit())
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
return functor(this->Storage.GetArrays64(), std::forward<Args>(args)...);
}
else
{
// If you get an error on the next line, a call to Visit(functor, Args...)
// is being called with arguments that do not match the functor's call
// signature. See the Visit documentation for details.
return functor(this->Storage.GetArrays32(), std::forward<Args>(args)...);
}
}
/** @} */
#endif // __VTK_WRAP__
//=================== Begin Legacy Methods ===================================
// These should be deprecated at some point as they are confusing or very slow
/**
* Set the number of cells in the array.
* DO NOT do any kind of allocation, advanced use only.
*
* @note This call has no effect.
*/
virtual void SetNumberOfCells(vtkIdType);
/**
* Utility routines help manage memory of cell array. EstimateSize()
* returns a value used to initialize and allocate memory for array based
* on number of cells and maximum number of points making up cell. If
* every cell is the same size (in terms of number of points), then the
* memory estimate is guaranteed exact. (If not exact, use Squeeze() to
* reclaim any extra memory.)
*
* @note This method was often misused (e.g. called alone and then
* discarding the result). Use AllocateEstimate directly instead.
*/
vtkIdType EstimateSize(vtkIdType numCells, int maxPtsPerCell);
/**
* Get the size of the allocated connectivity array.
*
* @warning This returns the allocated capacity of the internal arrays as a
* number of elements, NOT the number of elements in use.
*
* @note Method incompatible with current internal storage.
*/
vtkIdType GetSize();
/**
* Return the size of the array that would be returned from
* ExportLegacyFormat().
*
* @note Method incompatible with current internal storage.
*/
vtkIdType GetNumberOfConnectivityEntries();
/**
* Internal method used to retrieve a cell given a legacy offset location.
*
* @warning Subsequent calls to this method may invalidate previous call
* results.
*
* @note The location-based API is now a super-slow compatibility layer.
* Prefer GetCellAtId.
*/
void GetCell(vtkIdType loc, vtkIdType& npts, const vtkIdType*& pts)
VTK_EXPECTS(0 <= loc && loc < GetNumberOfConnectivityEntries()) VTK_SIZEHINT(pts, npts);
/**
* Internal method used to retrieve a cell given a legacy offset location.
*
* @note The location-based API is now a super-slow compatibility layer.
* Prefer GetCellAtId.
*/
void GetCell(vtkIdType loc, vtkIdList* pts)
VTK_EXPECTS(0 <= loc && loc < GetNumberOfConnectivityEntries());
/**
* Computes the current legacy insertion location within the internal array.
* Used in conjunction with GetCell(int loc,...).
*
* @note The location-based API is now a super-slow compatibility layer.
*/
vtkIdType GetInsertLocation(int npts);
/**
* Get/Set the current traversal legacy location.
*
* @note The location-based API is now a super-slow compatibility layer.
* Prefer Get/SetTraversalCellId.
* @{
*/
vtkIdType GetTraversalLocation();
vtkIdType GetTraversalLocation(vtkIdType npts);
void SetTraversalLocation(vtkIdType loc);
/**@}*/
/**
* Special method inverts ordering of cell at the specified legacy location.
* Must be called carefully or the cell topology may be corrupted.
*
* @note The location-based API is now a super-slow compatibility layer.
* Prefer ReverseCellAtId;
*/
void ReverseCell(vtkIdType loc) VTK_EXPECTS(0 <= loc && loc < GetNumberOfConnectivityEntries());
/**
* Replace the point ids of the cell at the legacy location with a different
* list of point ids. Calling this method does not mark the vtkCellArray as
* modified. This is the responsibility of the caller and may be done after
* multiple calls to ReplaceCell. This call does not support changing the
* number of points in the cell -- the caller must ensure that the target
* cell has npts points.
*
* @note The location-based API is now a super-slow compatibility layer.
* Prefer ReplaceCellAtId.
*/
void ReplaceCell(vtkIdType loc, int npts, const vtkIdType pts[])
VTK_EXPECTS(0 <= loc && loc < GetNumberOfConnectivityEntries()) VTK_SIZEHINT(pts, npts);
/**
* Define multiple cells by providing a connectivity list. The list is in
* the form (npts,p0,p1,...p(npts-1), repeated for each cell). Be careful
* using this method because it discards the old cells, and anything
* referring these cells becomes invalid (for example, if BuildCells() has
* been called see vtkPolyData). The traversal location is reset to the
* beginning of the list; the insertion location is set to the end of the
* list.
*
* @warning The vtkCellArray will not hold a reference to `cells`. This
* function merely calls ImportLegacyFormat.
*
* @note Use ImportLegacyFormat or SetData instead.
*/
void SetCells(vtkIdType ncells, vtkIdTypeArray* cells);
/**
* Return the underlying data as a data array.
*
* @warning The returned array is not the actual internal representation used
* by vtkCellArray. Modifications to the returned array will not change the
* vtkCellArray's topology.
*
* @note Use ExportLegacyFormat, or GetOffsetsArray/GetConnectivityArray
* instead.
*/
vtkIdTypeArray* GetData();
//=================== End Legacy Methods =====================================
friend class vtkCellArrayIterator;
protected:
vtkCellArray();
~vtkCellArray() override;
// Encapsulates storage of the internal arrays as a discriminated union
// between 32-bit and 64-bit storage.
struct Storage
{
// Union type that switches 32 and 64 bit array storage
union ArraySwitch {
ArraySwitch() {} // handled by Storage
~ArraySwitch() {} // handle by Storage
VisitState<ArrayType32> Int32;
VisitState<ArrayType64> Int64;
};
Storage()
{
// Default to the compile-time setting:
#ifdef VTK_USE_64BIT_IDS
new (&this->Arrays.Int64) VisitState<ArrayType64>;
this->StorageIs64Bit = true;
#else // VTK_USE_64BIT_IDS
new (&this->Arrays.Int32) VisitState<ArrayType32>;
this->StorageIs64Bit = false;
#endif // VTK_USE_64BIT_IDS
}
~Storage()
{
if (this->StorageIs64Bit)
{
this->Arrays.Int64.~VisitState();
}
else
{
this->Arrays.Int32.~VisitState();
}
}
// Switch the internal arrays to be 32-bit. Any old data is lost. Returns
// true if the storage changes.
bool Use32BitStorage()
{
if (!this->StorageIs64Bit)
{
return false;
}
this->Arrays.Int64.~VisitState();
new (&this->Arrays.Int32) VisitState<ArrayType32>;
this->StorageIs64Bit = false;
return true;
}
// Switch the internal arrays to be 64-bit. Any old data is lost. Returns
// true if the storage changes.
bool Use64BitStorage()
{
if (this->StorageIs64Bit)
{
return false;
}
this->Arrays.Int32.~VisitState();
new (&this->Arrays.Int64) VisitState<ArrayType64>;
this->StorageIs64Bit = true;
return true;
}
// Returns true if the storage is currently configured to be 64 bit.
bool Is64Bit() const { return this->StorageIs64Bit; }
// Get the VisitState for 32-bit arrays
VisitState<ArrayType32>& GetArrays32()
{
assert(!this->StorageIs64Bit);
return this->Arrays.Int32;
}
const VisitState<ArrayType32>& GetArrays32() const
{
assert(!this->StorageIs64Bit);
return this->Arrays.Int32;
}
// Get the VisitState for 64-bit arrays
VisitState<ArrayType64>& GetArrays64()
{
assert(this->StorageIs64Bit);
return this->Arrays.Int64;
}
const VisitState<ArrayType64>& GetArrays64() const
{
assert(this->StorageIs64Bit);
return this->Arrays.Int64;
}
private:
// Access restricted to ensure proper union construction/destruction thru
// API.
ArraySwitch Arrays;
bool StorageIs64Bit;
};
Storage Storage;
vtkNew<vtkIdList> TempCell;
vtkIdType TraversalCellId{ 0 };
vtkNew<vtkIdTypeArray> LegacyData; // For GetData().
private:
vtkCellArray(const vtkCellArray&) = delete;
void operator=(const vtkCellArray&) = delete;
};
template <typename ArrayT>
vtkIdType vtkCellArray::VisitState<ArrayT>::GetNumberOfCells() const
{
return this->Offsets->GetNumberOfValues() - 1;
}
template <typename ArrayT>
vtkIdType vtkCellArray::VisitState<ArrayT>::GetBeginOffset(vtkIdType cellId) const
{
return static_cast<vtkIdType>(this->Offsets->GetValue(cellId));
}
template <typename ArrayT>
vtkIdType vtkCellArray::VisitState<ArrayT>::GetEndOffset(vtkIdType cellId) const
{
return static_cast<vtkIdType>(this->Offsets->GetValue(cellId + 1));
}
template <typename ArrayT>
vtkIdType vtkCellArray::VisitState<ArrayT>::GetCellSize(vtkIdType cellId) const
{
return this->GetEndOffset(cellId) - this->GetBeginOffset(cellId);
}
template <typename ArrayT>
typename vtkCellArray::VisitState<ArrayT>::CellRangeType
vtkCellArray::VisitState<ArrayT>::GetCellRange(vtkIdType cellId)
{
return vtk::DataArrayValueRange<1>(
this->GetConnectivity(), this->GetBeginOffset(cellId), this->GetEndOffset(cellId));
}
namespace vtkCellArray_detail
{
struct InsertNextCellImpl
{
// Insert full cell
template <typename CellStateT>
vtkIdType operator()(CellStateT& state, const vtkIdType npts, const vtkIdType pts[])
{
using ValueType = typename CellStateT::ValueType;
auto* conn = state.GetConnectivity();
auto* offsets = state.GetOffsets();
const vtkIdType cellId = offsets->GetNumberOfValues() - 1;
offsets->InsertNextValue(static_cast<ValueType>(conn->GetNumberOfValues() + npts));
for (vtkIdType i = 0; i < npts; ++i)
{
conn->InsertNextValue(static_cast<ValueType>(pts[i]));
}
return cellId;
}
// Just update offset table (for incremental API)
template <typename CellStateT>
vtkIdType operator()(CellStateT& state, const vtkIdType npts)
{
using ValueType = typename CellStateT::ValueType;
auto* conn = state.GetConnectivity();
auto* offsets = state.GetOffsets();
const vtkIdType cellId = offsets->GetNumberOfValues() - 1;
offsets->InsertNextValue(static_cast<ValueType>(conn->GetNumberOfValues() + npts));
return cellId;
}
};
// for incremental API:
struct UpdateCellCountImpl
{
template <typename CellStateT>
void operator()(CellStateT& state, const vtkIdType npts)
{
using ValueType = typename CellStateT::ValueType;
auto* offsets = state.GetOffsets();
const ValueType cellBegin = offsets->GetValue(offsets->GetMaxId() - 1);
offsets->SetValue(offsets->GetMaxId(), static_cast<ValueType>(cellBegin + npts));
}
};
struct GetCellSizeImpl
{
template <typename CellStateT>
vtkIdType operator()(CellStateT& state, const vtkIdType cellId)
{
return state.GetCellSize(cellId);
}
};
struct GetCellAtIdImpl
{
template <typename CellStateT>
void operator()(CellStateT& state, const vtkIdType cellId, vtkIdList* ids)
{
using ValueType = typename CellStateT::ValueType;
const auto cellPts = state.GetCellRange(cellId);
ids->SetNumberOfIds(cellPts.size());
vtkIdType* idPtr = ids->GetPointer(0);
for (ValueType ptId : cellPts)
{
*idPtr++ = static_cast<vtkIdType>(ptId);
}
}
// SFINAE helper to check if a VisitState's connectivity array's memory
// can be used as a vtkIdType*.
template <typename CellStateT>
struct CanShareConnPtr
{
private:
using ValueType = typename CellStateT::ValueType;
using ArrayType = typename CellStateT::ArrayType;
using AOSArrayType = vtkAOSDataArrayTemplate<ValueType>;
static constexpr bool ValueTypeCompat = CellStateT::ValueTypeIsSameAsIdType;
static constexpr bool ArrayTypeCompat = std::is_base_of<AOSArrayType, ArrayType>::value;
public:
static constexpr bool value = ValueTypeCompat && ArrayTypeCompat;
};
template <typename CellStateT>
typename std::enable_if<CanShareConnPtr<CellStateT>::value, void>::type operator()(
CellStateT& state, const vtkIdType cellId, vtkIdType& cellSize, vtkIdType const*& cellPoints,
vtkIdList* vtkNotUsed(temp))
{
const vtkIdType beginOffset = state.GetBeginOffset(cellId);
const vtkIdType endOffset = state.GetEndOffset(cellId);
cellSize = endOffset - beginOffset;
// This is safe, see CanShareConnPtr helper above.
cellPoints = reinterpret_cast<vtkIdType*>(state.GetConnectivity()->GetPointer(beginOffset));
}
template <typename CellStateT>
typename std::enable_if<!CanShareConnPtr<CellStateT>::value, void>::type operator()(
CellStateT& state, const vtkIdType cellId, vtkIdType& cellSize, vtkIdType const*& cellPoints,
vtkIdList* temp)
{
using ValueType = typename CellStateT::ValueType;
const auto cellPts = state.GetCellRange(cellId);
cellSize = cellPts.size();
// ValueType differs from vtkIdType, so we have to copy into a temporary
// buffer:
temp->SetNumberOfIds(cellSize);
vtkIdType* tempPtr = temp->GetPointer(0);
for (ValueType ptId : cellPts)
{
*tempPtr++ = static_cast<vtkIdType>(ptId);
}
cellPoints = temp->GetPointer(0);
}
};
struct ResetImpl
{
template <typename CellStateT>
void operator()(CellStateT& state)
{
state.GetOffsets()->Reset();
state.GetConnectivity()->Reset();
state.GetOffsets()->InsertNextValue(0);
}
};
} // end namespace vtkCellArray_detail
//----------------------------------------------------------------------------
inline void vtkCellArray::InitTraversal()
{
this->TraversalCellId = 0;
}
//----------------------------------------------------------------------------
inline int vtkCellArray::GetNextCell(vtkIdType& npts, vtkIdType const*& pts) VTK_SIZEHINT(pts, npts)
{
if (this->TraversalCellId < this->GetNumberOfCells())
{
this->GetCellAtId(this->TraversalCellId, npts, pts);
++this->TraversalCellId;
return 1;
}
npts = 0;
pts = nullptr;
return 0;
}
//----------------------------------------------------------------------------
inline int vtkCellArray::GetNextCell(vtkIdList* pts)
{
if (this->TraversalCellId < this->GetNumberOfCells())
{
this->GetCellAtId(this->TraversalCellId, pts);
++this->TraversalCellId;
return 1;
}
pts->Reset();
return 0;
}
//----------------------------------------------------------------------------
inline vtkIdType vtkCellArray::GetCellSize(const vtkIdType cellId) const
{
return this->Visit(vtkCellArray_detail::GetCellSizeImpl{}, cellId);
}
//----------------------------------------------------------------------------
inline void vtkCellArray::GetCellAtId(vtkIdType cellId, vtkIdType& cellSize,
vtkIdType const*& cellPoints) VTK_SIZEHINT(cellPoints, cellSize)
{
this->Visit(vtkCellArray_detail::GetCellAtIdImpl{}, cellId, cellSize, cellPoints, this->TempCell);
}
//----------------------------------------------------------------------------
inline void vtkCellArray::GetCellAtId(vtkIdType cellId, vtkIdList* pts)
{
this->Visit(vtkCellArray_detail::GetCellAtIdImpl{}, cellId, pts);
}
//----------------------------------------------------------------------------
inline vtkIdType vtkCellArray::InsertNextCell(vtkIdType npts, const vtkIdType pts[])
VTK_SIZEHINT(pts, npts)
{
return this->Visit(vtkCellArray_detail::InsertNextCellImpl{}, npts, pts);
}
//----------------------------------------------------------------------------
inline vtkIdType vtkCellArray::InsertNextCell(int npts)
{
return this->Visit(vtkCellArray_detail::InsertNextCellImpl{}, npts);
}
//----------------------------------------------------------------------------
inline void vtkCellArray::InsertCellPoint(vtkIdType id)
{
if (this->Storage.Is64Bit())
{
using ValueType = typename ArrayType64::ValueType;
this->Storage.GetArrays64().Connectivity->InsertNextValue(static_cast<ValueType>(id));
}
else
{
using ValueType = typename ArrayType32::ValueType;
this->Storage.GetArrays32().Connectivity->InsertNextValue(static_cast<ValueType>(id));
}
}
//----------------------------------------------------------------------------
inline void vtkCellArray::UpdateCellCount(int npts)
{
this->Visit(vtkCellArray_detail::UpdateCellCountImpl{}, npts);
}
//----------------------------------------------------------------------------
inline vtkIdType vtkCellArray::InsertNextCell(vtkIdList* pts)
{
return this->Visit(
vtkCellArray_detail::InsertNextCellImpl{}, pts->GetNumberOfIds(), pts->GetPointer(0));
}
//----------------------------------------------------------------------------
inline vtkIdType vtkCellArray::InsertNextCell(vtkCell* cell)
{
vtkIdList* pts = cell->GetPointIds();
return this->Visit(
vtkCellArray_detail::InsertNextCellImpl{}, pts->GetNumberOfIds(), pts->GetPointer(0));
}
//----------------------------------------------------------------------------
inline void vtkCellArray::Reset()
{
this->Visit(vtkCellArray_detail::ResetImpl{});
}
#endif // vtkCellArray.h
|