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
|
// Copyright (c) 2011, 2015 GeometryFactory (France).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org).
//
// $URL: https://github.com/CGAL/cgal/blob/v6.1/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h $
// $Id: include/CGAL/Polygon_mesh_processing/connected_components.h b26b07a1242 $
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-Commercial
//
//
// Author(s) : Sebastien Loriot and Andreas Fabri
#ifndef CGAL_POLYGON_MESH_PROCESSING_CONNECTED_COMPONENTS_H
#define CGAL_POLYGON_MESH_PROCESSING_CONNECTED_COMPONENTS_H
#include <CGAL/license/Polygon_mesh_processing/connected_components.h>
#include <CGAL/disable_warnings.h>
#include<set>
#include<vector>
#include <CGAL/Named_function_parameters.h>
#include <CGAL/boost/graph/helpers.h>
#include <boost/graph/graph_traits.hpp>
#include <boost/property_map/vector_property_map.hpp>
#include <CGAL/assertions.h>
#include <CGAL/boost/graph/iterator.h>
#include <CGAL/boost/graph/Face_filtered_graph.h>
#include <CGAL/boost/graph/copy_face_graph.h>
#include <CGAL/Container_helper.h>
#include <CGAL/boost/graph/Dual.h>
#include <CGAL/Default.h>
#include <CGAL/Dynamic_property_map.h>
#include <CGAL/iterator.h>
#include <CGAL/tuple.h>
#include <CGAL/boost/graph/named_params_helper.h>
namespace CGAL {
namespace Polygon_mesh_processing{
namespace internal {
struct MoreSecond
{
template <typename T1, typename T2>
bool operator()(const std::pair<T1, T2>& a, const std::pair<T1, T2>& b) const {
return a.second > b.second;
}
};
// A property map
template <typename G>
struct No_constraint {
friend bool get(No_constraint<G>, typename boost::graph_traits<G>::edge_descriptor)
{
return false;
}
};
// A functor
template <typename G, typename EdgeConstraintMap = No_constraint<G> >
struct No_border {
No_border()
{}
No_border(const G & g, EdgeConstraintMap ecm = EdgeConstraintMap())
: g(&g), ecm(ecm)
{}
bool operator()(typename boost::graph_traits<G>::edge_descriptor e) const {
if (!is_border(e, *g)){
return !get(ecm, e);
}
return false;
}
const G* g;
EdgeConstraintMap ecm;
};
} // namespace internal
/*!
* \ingroup PMP_keep_connected_components_grp
*
* discovers all the faces in the same connected component as `seed_face` and records them in `out`.
* `seed_face` will also be added in `out`.
*
* \tparam PolygonMesh a model of `FaceGraph`
* \tparam FaceOutputIterator a model of `OutputIterator` with value type `boost::graph_traits<PolygonMesh>::%face_descriptor`.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param seed_face a face of `pmesh` from which exploration starts to detect the connected component that contains it
* \param pmesh the polygon mesh
* \param out the output iterator that collects faces from the same connected component as `seed_face`
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge key}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \returns the output iterator.
*
* \see `connected_components()`
*/
template <typename PolygonMesh
, typename FaceOutputIterator
, typename NamedParameters = parameters::Default_named_parameters
>
FaceOutputIterator
connected_component(typename boost::graph_traits<PolygonMesh>::face_descriptor seed_face
, const PolygonMesh& pmesh
, FaceOutputIterator out
, const NamedParameters& np = parameters::default_values())
{
using parameters::choose_parameter;
using parameters::get_parameter;
typedef typename internal_np::Lookup_named_param_def <
internal_np::edge_is_constrained_t,
NamedParameters,
internal::No_constraint<PolygonMesh>//default
> ::type EdgeConstraintMap;
EdgeConstraintMap ecmap
= choose_parameter<EdgeConstraintMap>(get_parameter(np, internal_np::edge_is_constrained));
typedef typename boost::graph_traits<PolygonMesh>::face_descriptor face_descriptor;
typedef typename boost::graph_traits<PolygonMesh>::halfedge_descriptor halfedge_descriptor;
std::set<face_descriptor> already_processed;
std::vector< face_descriptor > stack;
stack.push_back(seed_face);
while (!stack.empty())
{
seed_face=stack.back();
stack.pop_back();
if (!already_processed.insert(seed_face).second) continue;
*out++=seed_face;
for(halfedge_descriptor hd :
halfedges_around_face(halfedge(seed_face, pmesh), pmesh) )
{
if(! get(ecmap, edge(hd, pmesh))){
face_descriptor neighbor = face( opposite(hd, pmesh), pmesh );
if ( neighbor != boost::graph_traits<PolygonMesh>::null_face() )
stack.push_back(neighbor);
}
}
}
return out;
}
/*!
* \ingroup PMP_keep_connected_components_grp
*
* computes for each face the index of the corresponding connected component.
*
* \tparam PolygonMesh a model of `FaceListGraph`
* \tparam FaceComponentMap a model of `WritablePropertyMap` with
* `boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
* `boost::graph_traits<PolygonMesh>::%faces_size_type` as value type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param pmesh the polygon mesh
* \param fcm the property map with indices of components associated to faces in `pmesh`
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_index_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \returns the number of connected components.
*
* \see `connected_component()`
*/
template <typename PolygonMesh
, typename FaceComponentMap
, typename NamedParameters = parameters::Default_named_parameters
>
typename boost::property_traits<FaceComponentMap>::value_type
connected_components(const PolygonMesh& pmesh,
FaceComponentMap fcm,
const NamedParameters& np = parameters::default_values())
{
using parameters::choose_parameter;
using parameters::get_parameter;
typedef boost::graph_traits<PolygonMesh> GT;
typedef typename GT::halfedge_descriptor halfedge_descriptor;
typedef typename GT::face_descriptor face_descriptor;
typedef typename internal_np::Lookup_named_param_def <
internal_np::edge_is_constrained_t,
NamedParameters,
internal::No_constraint<PolygonMesh>//default
> ::type EdgeConstraintMap;
EdgeConstraintMap ecmap
= choose_parameter<EdgeConstraintMap>(get_parameter(np, internal_np::edge_is_constrained));
typedef typename GetInitializedFaceIndexMap<PolygonMesh, NamedParameters>::const_type FaceIndexMap;
FaceIndexMap fimap = get_initialized_face_index_map(pmesh, np);
typename boost::property_traits<FaceComponentMap>::value_type i=0;
std::vector<bool> handled(num_faces(pmesh), false);
for (face_descriptor f : faces(pmesh))
{
if (handled[get(fimap,f)]) continue;
std::vector<face_descriptor> queue;
queue.push_back(f);
while(!queue.empty())
{
face_descriptor fq = queue.back();
queue.pop_back();
typename boost::property_traits<FaceIndexMap>::value_type fq_id = get(fimap,fq);
if ( handled[fq_id]) continue;
handled[fq_id]=true;
put(fcm, fq, i);
for (halfedge_descriptor h : halfedges_around_face(halfedge(fq, pmesh), pmesh))
{
if ( get(ecmap, edge(h, pmesh)) ) continue;
halfedge_descriptor opp = opposite(h, pmesh);
face_descriptor fqo = face(opp, pmesh);
if ( fqo != GT::null_face() )
{
if ( !handled[get(fimap,fqo)] )
queue.push_back(fqo);
}
}
}
++i;
}
return i;
}
template <typename PolygonMesh
, typename ComponentRange
, typename FaceComponentMap
, typename NamedParameters = parameters::Default_named_parameters>
void keep_connected_components(PolygonMesh& pmesh
, const ComponentRange& components_to_keep
, const FaceComponentMap& fcm
, const NamedParameters& np = parameters::default_values());
namespace internal {
// /*!
// * \ingroup PMP_keep_connected_components_grp
// *
// * returns the number of connected components in the mesh.
// *
// * A property map for `CGAL::face_index_t` must be either available as an internal property map
// * to `pmesh` or provided as one of the \ref bgl_namedparameters "Named Parameters".
// *
// * \tparam PolygonMesh a model of `FaceGraph`
// * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
// *
// * \param pmesh the polygon mesh
// * \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
// *
// * \cgalNamedParamsBegin
// * \cgalParamNBegin{edge_is_constrained_map}
// * \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
// * \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
// * as key type and `bool` as value type}
// * \cgalParamDefault{a constant property map returning `false` for any edge}
// * \cgalParamNEnd
// *
// * \cgalParamNBegin{face_index_map}
// * \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
// * \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
// * as key type and `std::size_t` as value type}
// * \cgalParamDefault{an automatically indexed internal map}
// * \cgalParamNEnd
// * \cgalNamedParamsEnd
// *
// * \returns the output iterator.
// *
// * \see `connected_components()`
// */
template <typename PolygonMesh,
typename CGAL_NP_TEMPLATE_PARAMETERS>
std::size_t number_of_connected_components(const PolygonMesh& pmesh,
const CGAL_NP_CLASS& np = parameters::default_values())
{
typedef typename boost::graph_traits<PolygonMesh>::faces_size_type faces_size_type;
typedef CGAL::dynamic_face_property_t<faces_size_type> Face_property_tag;
typedef typename boost::property_map<PolygonMesh, Face_property_tag >::const_type Patch_ids_map;
Patch_ids_map patch_ids_map = get(Face_property_tag(), pmesh);
return CGAL::Polygon_mesh_processing::connected_components(pmesh, patch_ids_map, np);
}
} // end namespace internal
/*!
* \ingroup PMP_keep_connected_components_grp
*
* \brief removes the small connected components and all isolated vertices.
*
* Keep the `nb_components_to_keep` largest connected components, where the size of a connected
* component is computed as the sum of the individual sizes of all the faces of the connected component.
* By default, the size of a face is `1` (and thus the size of a connected component is the number
* of faces it contains), but it is also possible to pass custom sizes, such as the area of the face.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param pmesh the polygon mesh
* \param nb_components_to_keep the number of components to be kept. If this number is larger than
* the number of components in the mesh, all components are kept.
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge}
* \cgalParamNEnd
*
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_index_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_size_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a size}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor` as key type.
* The value type is chosen by the user, but must be constructible from `0` and support summation and comparisons.}
* \cgalParamDefault{A constant property map returning `1` for any face}
* \cgalParamNEnd
*
* \cgalParamNBegin{dry_run}
* \cgalParamDescription{If set to `true`, the mesh will not be altered, but the number of components
* that would be removed is returned.}
* \cgalParamType{Boolean}
* \cgalParamDefault{`false`}
* \cgalParamNEnd
*
* \cgalParamNBegin{output_iterator}
* \cgalParamDescription{an output iterator to collect the faces that would be removed by the algorithm,
* when using the "dry run" mode (see parameter `dry_run`)}
* \cgalParamType{a model of `OutputIterator` with value type `face_descriptor`}
* \cgalParamDefault{unused}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \return the number of connected components removed (ignoring isolated vertices).
*
* \see `keep_large_connected_components()`
*/
template <typename PolygonMesh,
typename NamedParameters = parameters::Default_named_parameters>
std::size_t keep_largest_connected_components(PolygonMesh& pmesh,
std::size_t nb_components_to_keep,
const NamedParameters& np = parameters::default_values())
{
typedef PolygonMesh PM;
typedef typename boost::graph_traits<PM>::face_descriptor face_descriptor;
using parameters::choose_parameter;
using parameters::get_parameter;
typedef typename CGAL::GetInitializedFaceIndexMap<PolygonMesh, NamedParameters>::type FaceIndexMap;
FaceIndexMap fimap = CGAL::get_initialized_face_index_map(pmesh, np);
// FaceSizeMap
typedef typename internal_np::Lookup_named_param_def<internal_np::face_size_map_t,
NamedParameters,
Constant_property_map<face_descriptor, std::size_t> // default
>::type FaceSizeMap;
typedef typename boost::property_traits<FaceSizeMap>::value_type Face_size;
FaceSizeMap face_size_pmap = choose_parameter(get_parameter(np, internal_np::face_size_map),
Constant_property_map<face_descriptor, std::size_t>(1));
const bool dry_run = choose_parameter(get_parameter(np, internal_np::dry_run), false);
typedef typename internal_np::Lookup_named_param_def<internal_np::output_iterator_t,
NamedParameters,
Emptyset_iterator>::type Output_iterator;
Output_iterator out = choose_parameter<Output_iterator>(get_parameter(np, internal_np::output_iterator));
// vector_property_map
boost::vector_property_map<std::size_t, FaceIndexMap> face_cc(static_cast<unsigned>(num_faces(pmesh)), fimap);
// Even if we do not want to keep anything we need to first
// calculate the number of existing connected_components to get the
// correct return value.
const std::size_t num = connected_components(pmesh, face_cc, np);
if(nb_components_to_keep == 0)
{
remove_all_elements(pmesh);
return num;
}
if(nb_components_to_keep >= num)
return 0;
std::vector<std::pair<std::size_t, Face_size> > component_size(num);
for(std::size_t i=0; i < num; i++)
component_size[i] = std::make_pair(i, Face_size(0));
for(face_descriptor f : faces(pmesh))
component_size[face_cc[f]].second += get(face_size_pmap, f);
// we sort the range [0, num) by component size
std::sort(component_size.begin(), component_size.end(), internal::MoreSecond());
if(dry_run)
{
std::vector<bool> is_to_be_kept(num, false);
for(std::size_t i=0; i<nb_components_to_keep; ++i)
is_to_be_kept[component_size[i].first] = true;
for(face_descriptor f : faces(pmesh))
if(!is_to_be_kept[face_cc[f]])
*out++ = f;
}
else
{
std::vector<std::size_t> cc_to_keep;
for(std::size_t i=0; i<nb_components_to_keep; ++i)
cc_to_keep.push_back(component_size[i].first);
keep_connected_components(pmesh, cc_to_keep, face_cc, np);
}
return num - nb_components_to_keep;
}
/*!
* \ingroup PMP_keep_connected_components_grp
*
* \brief removes connected components whose size is (strictly) smaller than a given threshold value,
* where the size of a connected component is computed as the sum of the individual sizes
* of all the faces of the connected component.
*
* By default, the size of a face is `1` (and thus the size of a connected component is the number
* of faces it contains), but it is also possible to pass custom sizes, such as the area of the face.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam ThresholdValueType the type of the threshold value. If a face size property map is passed
* by the user, `ThresholdValueType` must be the same type as the value type of the property map.
* Otherwise, `ThresholdValueType` must be `std::size_t`.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param pmesh the polygon mesh
* \param threshold_value any connected component with a size (strictly) smaller than this value will be discarded
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge}
* \cgalParamNEnd
*
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_index_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_size_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a size}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor` as key type.
* The value type is chosen by the user, but must be constructible from `0` and support summation and comparisons.}
* \cgalParamDefault{A constant property map returning `1` for any face}
* \cgalParamNEnd
*
* \cgalParamNBegin{dry_run}
* \cgalParamDescription{If set to `true`, the mesh will not be altered, but the number of components
* that would be removed is returned.}
* \cgalParamType{Boolean}
* \cgalParamDefault{`false`}
* \cgalParamNEnd
*
* \cgalParamNBegin{output_iterator}
* \cgalParamDescription{an output iterator to collect the faces that would be removed by the algorithm,
* when using the "dry run" mode (see parameter `dry_run`)}
* \cgalParamType{a model of `OutputIterator` with value type `face_descriptor`}
* \cgalParamDefault{unused}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \return the number of connected components removed (ignoring isolated vertices).
*
* \see `keep_largest_connected_components()`
*/
template <typename PolygonMesh,
typename ThresholdValueType,
typename NamedParameters = parameters::Default_named_parameters>
std::size_t keep_large_connected_components(PolygonMesh& pmesh,
const ThresholdValueType threshold_value,
const NamedParameters& np = parameters::default_values())
{
typedef PolygonMesh PM;
typedef typename boost::graph_traits<PM>::face_descriptor face_descriptor;
using parameters::choose_parameter;
using parameters::get_parameter;
typedef typename CGAL::GetInitializedFaceIndexMap<PolygonMesh, NamedParameters>::type FaceIndexMap;
FaceIndexMap fim = CGAL::get_initialized_face_index_map(pmesh, np);
typedef typename internal_np::Lookup_named_param_def<internal_np::face_size_map_t,
NamedParameters,
Constant_property_map<face_descriptor, std::size_t> // default
>::type FaceSizeMap;
typedef typename boost::property_traits<FaceSizeMap>::value_type Face_size;
static_assert(std::is_convertible<ThresholdValueType, Face_size>::value);
typedef typename internal_np::Lookup_named_param_def<internal_np::output_iterator_t,
NamedParameters,
Emptyset_iterator>::type Output_iterator;
FaceSizeMap face_size_pmap = choose_parameter(get_parameter(np, internal_np::face_size_map),
Constant_property_map<face_descriptor, std::size_t>(1));
const bool dry_run = choose_parameter(get_parameter(np, internal_np::dry_run), false);
Output_iterator out = choose_parameter<Output_iterator>(get_parameter(np, internal_np::output_iterator));
// vector_property_map
boost::vector_property_map<std::size_t, FaceIndexMap> face_cc(static_cast<unsigned>(num_faces(pmesh)), fim);
std::size_t num = connected_components(pmesh, face_cc, np);
std::vector<Face_size> component_size(num, 0);
for(face_descriptor f : faces(pmesh))
component_size[face_cc[f]] += get(face_size_pmap, f);
const Face_size thresh = threshold_value;
std::vector<bool> is_to_be_kept(num, false);
std::size_t res = 0;
for(std::size_t i=0; i<num; ++i)
{
if(component_size[i] >= thresh)
{
is_to_be_kept[i] = true;
++res;
}
}
if(dry_run)
{
for(face_descriptor f : faces(pmesh))
if(!is_to_be_kept[face_cc[f]])
*out++ = f;
}
else
{
std::vector<std::size_t> ccs_to_keep;
for(std::size_t i=0; i<num; ++i)
if(is_to_be_kept[i])
ccs_to_keep.push_back(i);
keep_connected_components(pmesh, ccs_to_keep, face_cc, np);
}
return num - res;
}
template <typename PolygonMesh
, typename ComponentRange
, typename FaceComponentMap
, typename CGAL_NP_TEMPLATE_PARAMETERS>
void keep_or_remove_connected_components(PolygonMesh& pmesh
, const ComponentRange& components_to_keep
, const FaceComponentMap& fcm
, bool keep
, const CGAL_NP_CLASS& np = parameters::default_values())
{
using parameters::choose_parameter;
using parameters::get_parameter;
using parameters::is_default_parameter;
typedef typename boost::graph_traits<PolygonMesh>::face_descriptor face_descriptor;
typedef typename boost::graph_traits<PolygonMesh>::vertex_descriptor vertex_descriptor;
typedef typename boost::graph_traits<PolygonMesh>::halfedge_descriptor halfedge_descriptor;
typedef typename boost::graph_traits<PolygonMesh>::edge_descriptor edge_descriptor;
typedef typename GetInitializedVertexIndexMap<PolygonMesh, CGAL_NP_CLASS>::type VertexIndexMap;
VertexIndexMap vim = get_initialized_vertex_index_map(pmesh, np);
std::set<std::size_t> cc_to_keep;
for(std::size_t i : components_to_keep)
cc_to_keep.insert(i);
boost::vector_property_map<bool, VertexIndexMap> keep_vertex(static_cast<unsigned>(num_vertices(pmesh)), vim);
for(vertex_descriptor v : vertices(pmesh))
keep_vertex[v] = false;
for(face_descriptor f : faces(pmesh)){
if (cc_to_keep.find(get(fcm,f)) != cc_to_keep.end())
put(fcm, f, keep ? 1 : 0);
else
put(fcm, f, keep ? 0 : 1);
}
for(face_descriptor f : faces(pmesh)){
if (get(fcm, f) == 1){
for(halfedge_descriptor h : halfedges_around_face(halfedge(f, pmesh), pmesh)){
vertex_descriptor v = target(h, pmesh);
keep_vertex[v] = true;
}
}
}
std::vector<edge_descriptor> edges_to_remove;
for (edge_descriptor e : edges(pmesh))
{
vertex_descriptor v = source(e, pmesh);
vertex_descriptor w = target(e, pmesh);
halfedge_descriptor h = halfedge(e, pmesh);
halfedge_descriptor oh = opposite(h, pmesh);
if (!keep_vertex[v] && !keep_vertex[w]){
// don't care about connectivity
// As vertices are not kept the faces and vertices will be removed later
edges_to_remove.push_back(e);
}
else if (keep_vertex[v] && keep_vertex[w]){
face_descriptor fh = face(h, pmesh), ofh = face(oh, pmesh);
if (is_border(h, pmesh) && is_border(oh, pmesh)){
#ifdef CGAL_CC_DEBUG
std::cerr << "null_face on both sides of " << e << " is kept\n";
#endif
}
else if ((is_border(oh, pmesh) && get(fcm,fh)) ||
(is_border(h, pmesh) && get(fcm,ofh)) ||
(!is_border(oh, pmesh) && !is_border(h, pmesh) && get(fcm,fh) && get(fcm,ofh))){
// do nothing
}
else if (!is_border(h, pmesh) && get(fcm,fh) && !is_border(oh, pmesh) && !get(fcm,ofh)){
set_face(oh, boost::graph_traits<PolygonMesh>::null_face(), pmesh);
}
else if (!is_border(h, pmesh) && !get(fcm,fh) && !is_border(oh, pmesh) && get(fcm,ofh)){
set_face(h, boost::graph_traits<PolygonMesh>::null_face(), pmesh);
}
else {
// no face kept
CGAL_assertion((is_border(h, pmesh) || !get(fcm,fh)) && (is_border(oh, pmesh) || !get(fcm,ofh)));
// vertices pointing to e must change their halfedge
if (halfedge(v, pmesh) == oh){
set_halfedge(v, prev(h, pmesh), pmesh);
}
if (halfedge(w, pmesh) == h){
set_halfedge(w, prev(oh, pmesh), pmesh);
}
// shortcut the next pointers as e will be removed
set_next(prev(h, pmesh), next(oh, pmesh), pmesh);
set_next(prev(oh, pmesh), next(h, pmesh), pmesh);
edges_to_remove.push_back(e);
}
}
else if (keep_vertex[v]){
if (halfedge(v, pmesh) == oh){
set_halfedge(v, prev(h, pmesh), pmesh);
}
set_next(prev(h, pmesh), next(oh, pmesh), pmesh);
edges_to_remove.push_back(e);
}
else {
CGAL_assertion(keep_vertex[w]);
if (halfedge(w, pmesh) == h){
set_halfedge(w, prev(oh, pmesh), pmesh);
}
set_next(prev(oh, pmesh), next(h, pmesh), pmesh);
edges_to_remove.push_back(e);
}
}
for (edge_descriptor e : edges_to_remove)
remove_edge(e, pmesh);
// We now can remove all vertices and faces not marked as kept
std::vector<face_descriptor> faces_to_remove;
for (face_descriptor f : faces(pmesh))
if (get(fcm,f) != 1)
faces_to_remove.push_back(f);
for (face_descriptor f : faces_to_remove)
remove_face(f, pmesh);
std::vector<vertex_descriptor> vertices_to_remove;
for(vertex_descriptor v: vertices(pmesh))
if (!keep_vertex[v])
vertices_to_remove.push_back(v);
if ( is_default_parameter<CGAL_NP_CLASS, internal_np::vertex_is_constrained_t>::value )
for (vertex_descriptor v : vertices_to_remove)
remove_vertex(v, pmesh);
else
{
typedef typename internal_np::Lookup_named_param_def<internal_np::vertex_is_constrained_t,
CGAL_NP_CLASS,
Static_boolean_property_map<vertex_descriptor, false> // default (not used)
>::type Vertex_map;
Vertex_map is_cst = choose_parameter(get_parameter(np, internal_np::vertex_is_constrained),
Static_boolean_property_map<vertex_descriptor, false>());
for (vertex_descriptor v : vertices_to_remove)
if (!get(is_cst, v))
remove_vertex(v, pmesh);
else
set_halfedge(v, boost::graph_traits<PolygonMesh>::null_halfedge(), pmesh);
}
}
/*!
* \ingroup PMP_keep_connected_components_grp
*
* keeps the connected components designated by theirs ids in `components_to_keep`,
* and removes the other connected components as well as all isolated vertices.
* The connected component id of a face is given by `fcm`.
*
* \note If the removal of the connected components makes `pmesh` a non-manifold surface,
* then the behavior of this function is undefined.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam ComponentRange a range of ids convertible to `std::size`
* \tparam FaceComponentMap a model of `ReadWritePropertyMap` with
* `boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
* `boost::graph_traits<PolygonMesh>::%faces_size_type` as value type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param components_to_keep the range of ids of connected components to keep
* \param pmesh the polygon mesh
* \param fcm the property map with indices of components associated to faces in `pmesh`.
* After calling this function, the values of `fcm` are undefined.
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \see `remove_connected_components()`
*/
template <typename PolygonMesh
, typename ComponentRange
, typename FaceComponentMap
, typename NamedParameters>
void keep_connected_components(PolygonMesh& pmesh
, const ComponentRange& components_to_keep
, const FaceComponentMap& fcm
, const NamedParameters& np)
{
keep_or_remove_connected_components(pmesh, components_to_keep, fcm, true, np);
}
/*!
* \ingroup PMP_keep_connected_components_grp
*
* removes in `pmesh` the connected components designated by theirs ids
* in `components_to_remove` as well as all isolated vertices.
* The connected component id of a face is given by `fcm`.
*
* \note If the removal of the connected components makes `pmesh` a non-manifold surface,
* then the behavior of this function is undefined.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam ComponentRange a range of ids convertible to `std::size`
* \tparam FaceComponentMap a model of `ReadWritePropertyMap` with
* `boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
* `boost::graph_traits<PolygonMesh>::%faces_size_type` as value type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param components_to_remove the range of ids of connected components to remove
* \param pmesh the polygon mesh
* \param fcm the property map with indices of components associated to faces in `pmesh`.
* After calling this function, the values of `fcm` are undefined.
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \see `keep_connected_components()`
*/
template <typename PolygonMesh
, typename ComponentRange
, typename FaceComponentMap
, typename NamedParameters = parameters::Default_named_parameters>
void remove_connected_components(PolygonMesh& pmesh
, const ComponentRange& components_to_remove
, const FaceComponentMap& fcm
, const NamedParameters& np = parameters::default_values())
{
if (components_to_remove.empty()) return;
keep_or_remove_connected_components(pmesh, components_to_remove, fcm, false, np);
}
/*!
* \ingroup PMP_keep_connected_components_grp
*
* keeps the connected components not designated by the faces in `components_to_remove`,
* and removes the other connected components and all isolated vertices.
*
* \note If the removal of the connected components makes `pmesh` a non-manifold surface,
* then the behavior of this function is undefined.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
* \tparam FaceRange a range of `boost::graph_traits<PolygonMesh>::%face_descriptor`
* indicating the connected components to be removed.
*
* \param components_to_remove a face range, including one face or more on each component to be removed
* \param pmesh the polygon mesh
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge}
* \cgalParamNEnd
*
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_index_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \see `keep_connected_components()`
*/
template <typename PolygonMesh
, typename FaceRange
, typename CGAL_NP_TEMPLATE_PARAMETERS>
void remove_connected_components(PolygonMesh& pmesh
, const FaceRange& components_to_remove
, const CGAL_NP_CLASS& np = parameters::default_values())
{
using parameters::choose_parameter;
using parameters::get_parameter;
if (components_to_remove.empty())
return;
typedef PolygonMesh PM;
typedef typename boost::graph_traits<PM>::face_descriptor face_descriptor;
typedef typename CGAL::GetInitializedFaceIndexMap<PolygonMesh, CGAL_NP_CLASS>::type FaceIndexMap;
FaceIndexMap fim = CGAL::get_initialized_face_index_map(pmesh, np);
boost::vector_property_map<std::size_t, FaceIndexMap> face_cc(static_cast<unsigned>(num_faces(pmesh)), fim);
connected_components(pmesh, face_cc, np);
std::vector<std::size_t> cc_to_remove;
for(face_descriptor f : components_to_remove)
cc_to_remove.push_back( face_cc[f] );
remove_connected_components(pmesh, cc_to_remove, face_cc, np);
}
/*!
* \ingroup PMP_keep_connected_components_grp
*
* keeps the connected components designated by the faces in `components_to_keep`,
* and removes the other connected components and all isolated vertices.
*
* \note If the removal of the connected components makes `pmesh` a non-manifold surface,
* then the behavior of this function is undefined.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
* \tparam FaceRange a range of `boost::graph_traits<PolygonMesh>::%face_descriptor`
* indicating the connected components to be kept.
*
* \param pmesh the polygon mesh
* \param components_to_keep a face range, including one face or more on each component to be kept
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge}
* \cgalParamNEnd
*
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_index_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \see `remove_connected_components()`
*/
template <typename PolygonMesh
, typename FaceRange
, typename CGAL_NP_TEMPLATE_PARAMETERS>
void keep_connected_components(PolygonMesh& pmesh
, const FaceRange& components_to_keep
, const CGAL_NP_CLASS& np = parameters::default_values())
{
typedef PolygonMesh PM;
typedef typename boost::graph_traits<PM>::face_descriptor face_descriptor;
using parameters::choose_parameter;
using parameters::get_parameter;
typedef typename CGAL::GetInitializedFaceIndexMap<PolygonMesh, CGAL_NP_CLASS>::type FaceIndexMap;
FaceIndexMap fim = CGAL::get_initialized_face_index_map(pmesh, np);
boost::vector_property_map<std::size_t, FaceIndexMap> face_cc(static_cast<unsigned>(num_faces(pmesh)), fim);
connected_components(pmesh, face_cc, np);
std::vector<std::size_t> cc_to_keep;
for(face_descriptor f : components_to_keep)
cc_to_keep.push_back( face_cc[f] );
keep_connected_components(pmesh, cc_to_keep, face_cc, np);
}
namespace internal {
template < class PolygonMesh, class PolygonMeshRange,
class FIMap, class VIMap,
class HIMap, class Ecm, class NamedParameters >
void split_connected_components_impl(FIMap fim,
HIMap him,
VIMap vim,
Ecm ecm,
PolygonMeshRange& range,
const PolygonMesh& tm,
const NamedParameters& np)
{
typedef typename boost::graph_traits<PolygonMesh>::faces_size_type faces_size_type;
typedef typename internal_np::Lookup_named_param_def <
internal_np::face_patch_t,
NamedParameters,
typename boost::template property_map<
PolygonMesh, CGAL::dynamic_face_property_t<faces_size_type > >::const_type> ::type
Fpm;
using parameters::choose_parameter;
using parameters::get_parameter;
using parameters::is_default_parameter;
Fpm pidmap = choose_parameter(get_parameter(np, internal_np::face_patch),
get(CGAL::dynamic_face_property_t<faces_size_type>(), tm));
faces_size_type nb_patches = 0;
if(is_default_parameter<NamedParameters, internal_np::face_patch_t>::value)
{
nb_patches = CGAL::Polygon_mesh_processing::connected_components(
tm, pidmap, CGAL::parameters::face_index_map(fim)
.edge_is_constrained_map(ecm));
}
else
{
for(const auto& f : faces(tm))
{
faces_size_type patch_id = get(pidmap, f);
if(patch_id > nb_patches)
nb_patches = patch_id;
}
nb_patches+=1;
}
CGAL::internal::reserve(range, nb_patches);
for(faces_size_type i=0; i<nb_patches; ++i)
{
CGAL::Face_filtered_graph<PolygonMesh, FIMap, VIMap, HIMap>
filter_graph(tm, i, pidmap, CGAL::parameters::face_index_map(fim)
.halfedge_index_map(him)
.vertex_index_map(vim));
range.push_back(PolygonMesh());
PolygonMesh& new_graph = range.back();
CGAL::copy_face_graph(filter_graph, new_graph);
}
}
}//internal
/*!
* \ingroup PMP_keep_connected_components_grp
*
* identifies the connected components of `pmesh` and pushes back a new `PolygonMesh`
* for each connected component in `cc_meshes`.
*
* \tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* \tparam PolygonMeshRange a model of `SequenceContainer` with `PolygonMesh` as value type
*
* \tparam NamedParameters a sequence of Named Parameters
*
* \param pmesh the polygon mesh
* \param cc_meshes container that is filled with the extracted connected components
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
* \cgalParamDescription{a property map containing the constrained-or-not status of each edge of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%edge_descriptor`
* as key type and `bool` as value type}
* \cgalParamDefault{a constant property map returning `false` for any edge}
* \cgalParamNEnd
*
* \cgalParamNBegin{vertex_index_map}
* \cgalParamDescription{a property map associating to each vertex of `pmesh` a unique index between `0` and `num_vertices(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%vertex_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{halfedge_index_map}
* \cgalParamDescription{a property map associating to each halfedge of `pmesh` a unique index between `0` and `num_halfedges(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%halfedge_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_index_map}
* \cgalParamDescription{a property map associating to each face of `pmesh` a unique index between `0` and `num_faces(pmesh) - 1`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and `std::size_t` as value type}
* \cgalParamDefault{an automatically indexed internal map}
* \cgalParamNEnd
*
* \cgalParamNBegin{face_patch_map}
* \cgalParamDescription{a property map with the patch id's associated to the faces of `pmesh`}
* \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits<PolygonMesh>::%face_descriptor`
* as key type and the desired property, model of `CopyConstructible` as value type.}
* \cgalParamDefault{a default property map where each face is associated with the ID of
* the connected component it belongs to. Connected components are
* computed with respect to the constrained edges listed in the property map
* `edge_is_constrained_map`}
* \cgalParamExtra{The map is updated during the remeshing process while new faces are created.}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
*/
template <class PolygonMesh, class PolygonMeshRange, class NamedParameters = parameters::Default_named_parameters>
void split_connected_components(const PolygonMesh& pmesh,
PolygonMeshRange& cc_meshes,
const NamedParameters& np = parameters::default_values())
{
typedef Static_boolean_property_map<
typename boost::graph_traits<PolygonMesh>::edge_descriptor, false> Default_ecm;
typedef typename internal_np::Lookup_named_param_def <
internal_np::edge_is_constrained_t,
NamedParameters,
Default_ecm//default
> ::type Ecm;
using parameters::choose_parameter;
using parameters::get_parameter;
Ecm ecm = choose_parameter(get_parameter(np, internal_np::edge_is_constrained),
Default_ecm());
internal::split_connected_components_impl(CGAL::get_initialized_face_index_map(pmesh, np),
CGAL::get_initialized_halfedge_index_map(pmesh, np),
CGAL::get_initialized_vertex_index_map(pmesh, np),
ecm, cc_meshes, pmesh, np);
}
} // namespace Polygon_mesh_processing
} // namespace CGAL
#include <CGAL/enable_warnings.h>
#endif //CGAL_POLYGON_MESH_PROCESSING_CONNECTED_COMPONENTS_H
|