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
|
/************************************************************************
*
* Copyright (C) 2009-2025 IRCAD France
* Copyright (C) 2012-2020 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/data/config.hpp>
#include "data/array.hpp"
#include "data/factory/new.hpp"
#include "data/iterator.hpp"
#include <core/compound_types.hpp>
#include <core/macros.hpp>
#include <core/memory/buffered.hpp>
#include <boost/range/combine.hpp>
#include <boost/range/iterator_range_core.hpp>
#include <glm/vec3.hpp>
#include <array>
namespace sight::data
{
/**
* @brief Data holding a geometric structure composed of points, lines, triangles, quads or polygons.
*
* @section Structure Structure
*
* The mesh structure contains some information stocked in Array
*
* - A list of arrays (m_points) which contains point attributes, such as position, normal, color and textures
* coordinates.
* - A list of arrays (m_cells) which contains cell indexes, and other cell attributes such as normal, color and
* textures coordinates.
* *
* The arrays store attributes as array of structures, i.e. for the normals :
* -normals = [ x0, y0, z0, x1, y1, z1, x2, y2, z2, x3, y3, z3, ... ]
*
* @section Usage Usage
*
* @subsection Allocation Allocation
*
* The two methods reserve() and resize() allocate the mesh arrays. The difference between the two methods is
* that resize() modifies the number of points and cells.
*
* The pushPoint() and pushCell() methods add new points or cells, they increment the number of points/cells and
* allocate more memory if needed. It is recommended to call reserve() method before it if you know the number of
* points and cells, it avoids allocating more memory than needed.
*
* The setPoint() and set_cell() methods change the value of a point/cell at a given index.
*
* Example with resize(), setPoint() and set_cell()
* @code{.cpp}
mesh::sptr mesh = mesh::New();
mesh->resize(NB_POINTS, NB_CELLS, CELL_TYPE, EXTRA_ARRAY);
const auto lock = mesh->lock(); // prevents the buffers from being dumped on the disk
for (std::size_t i = 0; i < NB_POINTS; ++i)
{
const std::uint8_t val = static_cast<uint8_t>(i);
const mesh::color_t color[4] = {val, val, val, val};
const float floatVal = static_cast<float>(i);
const mesh::normal_t normal[3] = {floatVal, floatVal, floatVal};
const mesh::texcoord_t texCoords[2] = {floatVal, floatVal};
const size_t value = 3*i;
mesh->setPoint(i, static_cast<float>(value), static_cast<float>(value+1), static_cast<float>(value+2));
mesh->setPointColor(i, color);
mesh->setPointNormal(i, normal);
mesh->setPointTexCoord(i, texCoords);
}
for (std::size_t i = 0; i < NB_CELLS; ++i)
{
mesh->set_cell(i, i, i+1, i+2);
const mesh::color_t val = static_cast< mesh::color_t >(i);
const mesh::color_t color[4] = {val, val, val, val};
const float floatVal = static_cast<float>(i);
const mesh::normal_t normal[3] = {floatVal, floatVal, floatVal};
const mesh::texcoord_t texCoords[2] = {floatVal, floatVal};
mesh->setCellColor(i, color);
mesh->setCellNormal(i, normal);
mesh->setCellTexCoord(i, texCoords);
}
@endcode
*
* Example with reserve(), pushPoint() and pushCell()
* @code{.cpp}
mesh::sptr mesh = mesh::New();
mesh->reserve(NB_POINTS, NB_CELLS, CELL_TYPE, EXTRA_ARRAY);
const auto lock = mesh->lock();
for (std::size_t i = 0; i < NB_POINTS; ++i)
{
const std::uint8_t val = static_cast<uint8_t>(i);
const mesh::color_t color[4] = {val, val, val, val};
const float floatVal = static_cast<float>(i);
const mesh::normal_t normal[3] = {floatVal, floatVal, floatVal};
const mesh::texcoord_t texCoords[2] = {floatVal, floatVal};
const size_t value = 3*i;
const auto id =
mesh->pushPoint(static_cast<float>(value), static_cast<float>(value+1), static_cast<float>(value+2));
mesh->setPointColor(id, color);
mesh->setPointNormal(id, normal);
mesh->setPointTexCoord(id, texCoords);
}
for (std::size_t i = 0; i < NB_CELLS; ++i)
{
const auto id = mesh->pushCell(i, i+1, i+2);
const mesh::color_t val = static_cast< mesh::color_t >(i);
const mesh::color_t color[4] = {val, val, val, val};
const float floatVal = static_cast<float>(i);
const mesh::normal_t normal[3] = {floatVal, floatVal, floatVal};
const mesh::texcoord_t texCoords[2] = {floatVal, floatVal};
mesh->setCellColor(id, color);
mesh->setCellNormal(id, normal);
mesh->setCellTexCoord(id, texCoords);
}
@endcode
*
* @subsection Iterators Iterators
*
* To access the mesh points and cells, it is recommended to use iterators because they are the most efficient.
* Our iterators can loop over a single array or multiple arrays, thanks to boost::zip_iterator.
*
* Example to iterate over points:
* @code{.cpp}
mesh::sptr mesh = mesh::New();
mesh->resize(25, 33, mesh::cell_type_t::triangle);
float p[3] = {12.f, 16.f, 18.f};
for (auto& pt = mesh->range<iterator::point::xyz>())
{
pt.x = p[0];
pt.y = p[1];
pt.z = p[2];
}
@endcode
*
* Example to iterate over cells:
*
* @code{.cpp}
mesh::sptr mesh = mesh::New();
mesh->resize(25, 33, mesh::cell_type_t::triangle);
auto itrPt = mesh->begin<iterator::point::xyz>();
float p[3];
for(const auto& cell : mesh->range<iterator::cell::triangle>())
{
for(std::size_t i = 0 ; i < 3 ; ++i)
{
const auto pIdx = cell.pt[i];
auto& pointItr(itrPt + pIdx);
p[0] = pointItr->x;
p[1] = pointItr->y;
p[2] = pointItr->z;
}
}
@endcode
*
* pushCell() and set_cell() are not very efficient, you can use CellIterator to define the cells if speed is a concern.
*
* Example of defining cells using iterators
*
* @code{.cpp}
mesh::sptr mesh = mesh::New();
mesh->resize(25, 33, mesh::cell_type_t::QUAD);
const auto cellType = mesh::cell_type_t::QUAD;
const std::size_t nbPointPerCell = 4;
std::size_t count = 0;
for(const auto& cell : mesh->range<iterator::cell::quad>())
{
// define the point indices
for (std::size_t i = 0; i < 4; ++i)
{
cell.pt[i] = count++;
}
}
@endcode
*
* The iterators are compatible with all STL algorithm functions, for example std::copy.
*
* @code{.cpp}
void copyPoints(const mesh& origin, const mesh& dest)
{
SIGHT_ASSERT("Meshes must have the same number of points",
origin.num_points() == dest.num_points());
auto origIt = origin.begin< mesh::iterator::xyz >();
auto origEnd = origin.end< mesh::iterator::xyz >();
auto destIt = dest.begin< mesh::iterator::xyz >();
std::copy(origIt, origEnd, dest);
}
@endcode
*
* Last but not least, it is also possible to get an iterator over multiple attributes using the zip_range()
* function. Coupled with C++17 structured bindings, this makes such loops fairly elegant.
*
* @code{.cpp}
uint32_t count = 0;
for(auto&& [p, n, c, uv] : mesh->zip_range<point::xyz, point::nxyz, point::rgba, point::uv>())
{
p.x = static_cast<float>(3 * count);
p.y = static_cast<float>(3 * count + 1);
p.z = static_cast<float>(3 * count + 2);
n.nx = static_cast<float>(3 * count + 1);
n.ny = static_cast<float>(3 * count + 2);
n.nz = static_cast<float>(3 * count + 3);
c.r = static_cast<std::uint8_t>(4 * count);
c.g = static_cast<std::uint8_t>(4 * count + 1);
c.b = static_cast<std::uint8_t>(4 * count + 2);
c.a = static_cast<std::uint8_t>(4 * count + 3);
uv.u = static_cast<float>(2 * count);
uv.v = static_cast<float>(2 * count + 1);
++count;
}
* @endcode
*/
class SIGHT_DATA_CLASS_API mesh final : public object,
public core::memory::buffered
{
public:
SIGHT_DECLARE_CLASS(mesh, object);
/// Stores a cell type.
enum class cell_type_t : std::uint8_t
{
point = 0,
line,
triangle,
quad,
tetra,
size
};
enum class attribute : std::uint8_t
{
none = 0,
point_colors = 1 << 1,
point_normals = 1 << 2,
cell_colors = 1 << 3,
cell_normals = 1 << 4,
point_tex_coords = 1 << 5,
cell_tex_coords = 1 << 6
};
using position_t = float;
using color_t = std::uint8_t;
using normal_t = float;
using texcoord_t = float;
using cell_t = iterator::cell_t;
using point_t = iterator::point_t;
using size_t = iterator::size_t;
struct SIGHT_DATA_CLASS_API axis_aligned_box_t
{
sight::vec3f_t min {std::numeric_limits<position_t>::max(), std::numeric_limits<position_t>::max(),
std::numeric_limits<position_t>::max()
};
sight::vec3f_t max {std::numeric_limits<position_t>::lowest(), std::numeric_limits<position_t>::lowest(),
std::numeric_limits<position_t>::lowest()
};
//------------------------------------------------------------------------------
bool operator==(const axis_aligned_box_t& _other) const
{
return (min == _other.min) && (max == _other.max);
}
//------------------------------------------------------------------------------
bool operator<(const axis_aligned_box_t& _other) const
{
return (min < _other.min) && (max < _other.max);
}
};
// Lazy-compute the bounding-box using the object timestamp
SIGHT_DATA_API const axis_aligned_box_t& get_bounding_box();
/**
* @name Signals
* @{
*/
using signal_t = core::com::signal<void ()>;
/// Key in m_signals map of signal m_sigVertexModified
SIGHT_DATA_API static const core::com::signals::key_t VERTEX_MODIFIED_SIG;
SIGHT_DATA_API static const core::com::signals::key_t POINT_COLORS_MODIFIED_SIG;
SIGHT_DATA_API static const core::com::signals::key_t CELL_COLORS_MODIFIED_SIG;
SIGHT_DATA_API static const core::com::signals::key_t POINT_NORMALS_MODIFIED_SIG;
SIGHT_DATA_API static const core::com::signals::key_t CELL_NORMALS_MODIFIED_SIG;
SIGHT_DATA_API static const core::com::signals::key_t POINT_TEX_COORDS_MODIFIED_SIG;
SIGHT_DATA_API static const core::com::signals::key_t CELL_TEX_COORDS_MODIFIED_SIG;
/// @}
/**
* @brief Constructor
*/
SIGHT_DATA_API mesh();
/// Destructor
SIGHT_DATA_API ~mesh() noexcept override = default;
/**
* @brief Allocate mesh memory
*
* Initializes points, cell-types, cell-data, and cell-data-offsets arrays with the information given by the
* parameters.
* It does not modify the number of points and cells.
*
* @param _nb_pts number of points to allocate
* @param _nb_cells number of cells to allocate
* @param _cell_type type of cell to allocate, it defines the number of points by cell to allocate.
* @param _array_mask mesh attribute: additional Arrays to allocate
* (ex: Attribute::POINT_COLORS | Attribute::point_normals)
*
* @return Return the allocated memory
*
* @throw Raise Exception if the memory can not be allocated.
*/
SIGHT_DATA_API std::size_t reserve(
mesh::size_t _nb_pts,
mesh::size_t _nb_cells,
cell_type_t _cell_type = cell_type_t::triangle,
attribute _array_mask = attribute::none
);
/**
* @brief Allocate mesh memory and initialize the number of points and cells
*
* Initializes points, cell-types, cell-data, and cell-data-offsets arrays with the information given by the
* parameters.
* @param _nb_pts number of points to allocate
* @param _nb_cells number of cells to allocate
* @param _cell_type type of cell to allocate, it defines the number of points by cell to allocate.
* @param _array_mask mesh attribute: additional Arrays to allocate
* (ex: Attribute::POINT_COLORS | Attribute::point_normals)
*
* @return Return the allocated memory
*
* @throw Raise Exception if the memory can not be allocated.
*/
SIGHT_DATA_API std::size_t resize(
mesh::size_t _nb_pts,
mesh::size_t _nb_cells,
cell_type_t _cell_type = cell_type_t::triangle,
attribute _array_mask = attribute::none
);
/**
* @brief Adjust mesh memory usage
*
* The arrays (points, cell-types, cell-data, cell-data-offsets, and if they exists point-colors/normals and
* cell-colors/normals) will be resized according to the number of points and cells of the mesh.
*
* @return true if memory usage changed
*
* @throw Raise Exception if the memory can not be re-allocated.
*/
SIGHT_DATA_API bool shrink_to_fit();
/**
* @brief Truncate the number of points and cells of a mesh.
*
* Use this method to downsize the number of elements without reallocating any array.
* This is particularly useful with dynamic meshes to avoid an allocation every frame, which would occur if you
* use shrinkToFit() for instance.
*
* @throw Raise Exception if the number of elements if higher than the allocated size.
*/
SIGHT_DATA_API void truncate(mesh::size_t _nb_pts, mesh::size_t _nb_cells);
/**
* @brief Remove all data contained in the mesh. Memory is freed.
*/
SIGHT_DATA_API void clear();
/// Clear corresponding array, memory is freed.
template<mesh::attribute A>
void clear();
/// Return true if the mesh has a given attribute set
template<mesh::attribute A>
bool has() const;
/// Return true if the given attributes has a given attribute set
template<mesh::attribute A>
static bool has(mesh::attribute _attributes);
/// Get number of points.
mesh::size_t num_points() const;
/// Get number of cells.
mesh::size_t num_cells() const;
/// Get the cell type of this mesh.
cell_type_t cell_type() const;
/// Get the size of a cell given its type
mesh::size_t cell_size() const;
/// Get the mask type of point and cell attributes enabled
mesh::attribute attributes() const;
/**
* @brief Get the mesh data size in bytes.
*
* @return mesh data size in bytes
* @note The allocated memory may be greater than the data size in bytes.
*/
SIGHT_DATA_API std::size_t size_in_bytes() const;
/**
* @brief Get the amount of memory allocated in this mesh. May be bigger than getDataSizeInBytes().
*
* @return mesh data size in bytes
* @note You can call shrinkToFit() to free extra memory.
*/
SIGHT_DATA_API std::size_t allocated_size_in_bytes() const;
/**
* @{
* @brief Insert a point into the mesh.
* Reallocates the point array if needed.
*
* @return The id of the new point
*
* @throw Exception if the allocation failed
*/
SIGHT_DATA_API point_t push_point(const std::array<position_t, 3>& _p);
SIGHT_DATA_API point_t push_point(position_t _x, position_t _y, position_t _z);
/// @}
/**
* @{
* @brief Insert a cell into the mesh.
*
* Reallocates the mesh's concerned arrays if needed.
*
* @return The id of the new cell
*
* @throw Exception if the allocation failed
*/
SIGHT_DATA_API cell_t push_cell(point_t _id_pt);
SIGHT_DATA_API cell_t push_cell(point_t _id_p1, point_t _id_p2);
SIGHT_DATA_API cell_t push_cell(point_t _id_p1, point_t _id_p2, point_t _id_p3);
SIGHT_DATA_API cell_t push_cell(point_t _id_p1, point_t _id_p2, point_t _id_p3, point_t _id_p4);
SIGHT_DATA_API cell_t push_cell(const std::vector<point_t> _point_ids);
SIGHT_DATA_API cell_t push_cell(const point_t* _point_ids, std::size_t _nb_points);
/// @}
/**
* @brief Set a point's coordinates.
*
* The mesh must be allocated before calling this method.
*
* @param _id point index
* @param _p point coordinates
* @throw Raise Exception if the id is out of bounds
*/
SIGHT_DATA_API void set_point(point_t _id, const std::array<position_t, 3>& _p);
/**
* @brief Set a point coordinates.
*
* The mesh must be allocated before calling this method.
*
* @see setPoint
* @throw Raise Exception if the id is out of bounds
*/
SIGHT_DATA_API void set_point(point_t _id, position_t _x, position_t _y, position_t _z);
/**
* @{
* @brief Set a cell into the mesh.
*
* @warning Use this method carefully, the cell should be properly allocated. If the current cell does not contain
* as many points as the previous one the following cells will be corrupted.
*
* @throw Exception if the mesh is not correctly allocated (ie. the id is out of bounds)
*/
SIGHT_DATA_API void set_cell(cell_t _id, point_t _id_pt);
SIGHT_DATA_API void set_cell(cell_t _id, point_t _id_p1, point_t _id_p2);
SIGHT_DATA_API void set_cell(cell_t _id, point_t _id_p1, point_t _id_p2, point_t _id_p3);
SIGHT_DATA_API void set_cell(cell_t _id, point_t _id_p1, point_t _id_p2, point_t _id_p3, point_t _id_p4);
SIGHT_DATA_API void set_cell(cell_t _id, const std::vector<point_t>& _point_ids);
SIGHT_DATA_API void set_cell(cell_t _id, const point_t* _point_ids, std::size_t _nb_points);
/// @}
/**
* @{
* @brief Set a point's color.
*
* @warning The point colors must be allocated with 4 components (RGBA)
*
* @param _id point index
* @param _c color
*/
SIGHT_DATA_API void set_point_color(point_t _id, const std::array<color_t, 4>& _c);
SIGHT_DATA_API void set_point_color(point_t _id, color_t _r, color_t _g, color_t _b, color_t _a);
/// @}
///
/**
* @{
* @brief Set a cell's color.
*
* @warning The cell colors must be allocated with 4 components (RGBA)
*
* @param _id cell index
* @param _c color
*/
SIGHT_DATA_API void set_cell_color(cell_t _id, const std::array<color_t, 4>& _c);
SIGHT_DATA_API void set_cell_color(cell_t _id, color_t _r, color_t _g, color_t _b, color_t _a);
/// @}
/**
* @{
* @brief Set a point's normal.
*
* The normal array must be allocated before calling this method.
*
* @param _id point index
* @param _n normal
*/
SIGHT_DATA_API void set_point_normal(point_t _id, const std::array<normal_t, 3>& _n);
SIGHT_DATA_API void set_point_normal(point_t _id, normal_t _nx, normal_t _ny, normal_t _nz);
///@}
/**
* @{
* @brief Set a cell's normal.
*
* The normal array must be allocated before calling this method.
*
* @param _id cell index
* @param _n normal
*/
SIGHT_DATA_API void set_cell_normal(cell_t _id, const std::array<normal_t, 3>& _n);
SIGHT_DATA_API void set_cell_normal(cell_t _id, normal_t _nx, normal_t _ny, normal_t _nz);
/// @}
/**
* @{
* @brief Set a point's texCoord.
*
* The texCoord array must be allocated before calling this method.
*
* @param _id point index
* @param _t texCoord
*/
SIGHT_DATA_API void set_point_tex_coord(point_t _id, const std::array<texcoord_t, 2>& _t);
SIGHT_DATA_API void set_point_tex_coord(point_t _id, texcoord_t _u, texcoord_t _v);
/// @}
/**
* @{
* @brief Set a cell's texCoord.
*
* The texCoord array must be allocated before calling this method.
*
* @param _id cell index
* @param _t texCoord
*/
SIGHT_DATA_API void set_cell_tex_coord(cell_t _id, const std::array<texcoord_t, 2>& _t);
SIGHT_DATA_API void set_cell_tex_coord(cell_t _id, texcoord_t _u, texcoord_t _v);
/// @}
/**
* @brief Returns the begin/end iterators to the mesh buffers
*/
template<typename T>
array_iterator<T> begin();
template<typename T>
array_iterator<T> end();
template<typename T>
const_array_iterator<T> begin() const;
template<typename T>
const_array_iterator<T> end() const;
template<typename T>
const_array_iterator<T> cbegin() const;
template<typename T>
const_array_iterator<T> cend() const;
template<typename T>
auto range();
template<typename ... ATTRS>
auto zip_range();
template<typename T>
auto range() const;
template<typename ... ATTRS>
auto zip_range() const;
template<typename T>
auto crange() const;
template<typename ... ATTRS>
auto czip_range() const;
/// @}
/// Equality comparison operators
/// @{
SIGHT_DATA_API bool operator==(const mesh& _other) const noexcept;
SIGHT_DATA_API bool operator!=(const mesh& _other) const noexcept;
/// @}
/// Defines shallow copy
/// @throws data::exception if an errors occurs during copy
/// @param[in] _source the source object to copy
SIGHT_DATA_API void shallow_copy(const object::csptr& _source) override;
/// Defines deep copy
/// @throws data::exception if an errors occurs during copy
/// @param _source source object to copy
/// @param _cache cache used to deduplicate pointers
SIGHT_DATA_API void deep_copy(
const object::csptr& _source,
const std::unique_ptr<deep_copy_cache_t>& _cache = std::make_unique<deep_copy_cache_t>()
) override;
protected:
/// Add a lock on the mesh in the given vector to prevent from dumping the buffer on the disk
/// This is needed for IBuffered interface implementation
SIGHT_DATA_API void dump_lock_impl(std::vector<core::memory::buffer_object::lock_t>& _locks) const override;
private:
/// Time stamp indicates if the bounding box has been computed or not.
std::uint64_t m_bb_last_updated {~0UL};
/// The Axis-Aligned Bounding Box of the mesh, lazy-computed in get_mesh().
axis_aligned_box_t m_bbox {};
/// Helper function used to get the array given a point or cell attribute type
template<class ATTR>
array::sptr get_array();
/// Helper function used to get the array given a point or cell attribute type
template<class ATTR>
array::csptr get_array() const;
/// Helper function used to get the number of points or cells given a point or cell attribute type
template<class ATTR>
std::size_t num_elements() const;
enum class point_attribute : std::uint8_t
{
position = 0,
colors,
normals,
tex_coords,
size
};
enum class cell_attribute : std::uint8_t
{
index = 0,
colors,
normals,
tex_coords,
size
};
/// Number of points defined for the mesh
mesh::size_t m_num_points {0};
/// Number of cells defined for the mesh
mesh::size_t m_num_cells {0};
/// Type of primitive
cell_type_t m_cell_type {cell_type_t::size};
/**
* @brief Points arrays
*
* Position : 3-components 1-dimension float array, size = m_numPoints x 3.
* Contains points : [ x1 y1 z1 x2 y2 z2 ... xn yn zn ]
*
* Point colors array : 3 or 4-components 1-dimension float array, size = m_numPoints.
* Contains point colors : [ R1 G1 B1 R2 G2 B2 ... ] or [ R1 G1 B1 A1 R2 G2 B2 A2 ... ]
*
* mesh point array : 3-components 1-dimension uint8_t array, size = m_numPoints.
* Contains point normals : [ nx1 ny1 nz1 nx2 ny2 nz2 ... ]
*
* mesh texCoord array : 2-components 1-dimension float array, size = m_numPoints.
* Contains point texCoords : [ tx1 ty1 tx2 ty2 ... ]
*/
std::array<array::sptr, static_cast<std::size_t>(point_attribute::size)> m_points;
/**
* @brief Cell data arrays
*
* Cell index array : 1-components 1-dimension uint64 array, size = m_cellsDataSize.
* Contains cell data : cell points ids are contiguously stored regardless
* of the cell type. Size depends of cell type. If we have only TRIANGLE type, size = m_numCells x 3.
* This array contains point indexes (index in m_points) : [ TRIAN_ID1, TRIAN_ID2, TRIAN_ID3, ... ]
*
* Cell colors array : 3 or 4-components 1-dimension uint8_t array, size = m_numCells.
* Contains cell colors : [ R1 G1 B1 R2 G2 B2 ... ] or [ R1 G1 B1 A1 R2 G2 B2 A2 ... ]
*
* Cell normal array : 3-components 1-dimension float array, size = m_numCells.
* Contains cell normals : [ nx1 ny1 nz1 nx2 ny2 nz2 ... ]
*
* Cell texCoord array : 2-components 1-dimension float array, size = m_numCells.
* Contains cell texCoords : [ tx1 ty1 tx2 ty2 ... ]
*/
std::array<array::sptr, static_cast<std::size_t>(cell_attribute::size)> m_cells;
/// Stores current attributes.
attribute m_attributes {attribute::none};
};
//------------------------------------------------------------------------------
inline mesh::attribute operator|(const mesh::attribute& _lhs, const mesh::attribute& _rhs)
{
return static_cast<mesh::attribute>(
static_cast<std::underlying_type<mesh::attribute>::type>(_lhs)
| static_cast<std::underlying_type<mesh::attribute>::type>(_rhs)
);
}
//------------------------------------------------------------------------------
inline mesh::attribute operator&(const mesh::attribute& _lhs, const mesh::attribute& _rhs)
{
return static_cast<mesh::attribute>(
static_cast<std::underlying_type<mesh::attribute>::type>(_lhs)
& static_cast<std::underlying_type<mesh::attribute>::type>(_rhs)
);
}
//------------------------------------------------------------------------------
inline mesh::attribute operator~(const mesh::attribute& _lhs)
{
return static_cast<mesh::attribute>(~static_cast<std::underlying_type<mesh::attribute>::type>(_lhs));
}
//------------------------------------------------------------------------------
inline mesh::size_t mesh::num_points() const
{
return m_num_points;
}
//------------------------------------------------------------------------------
inline mesh::size_t mesh::num_cells() const
{
return m_num_cells;
}
//------------------------------------------------------------------------------
inline mesh::cell_type_t mesh::cell_type() const
{
return m_cell_type;
}
//------------------------------------------------------------------------------
inline mesh::size_t mesh::cell_size() const
{
static const std::array<mesh::size_t, static_cast<std::size_t>(mesh::cell_type_t::size)> s_CELL_TYPE_TO_SIZE =
{1, 2, 3, 4, 4};
return s_CELL_TYPE_TO_SIZE[static_cast<std::size_t>(m_cell_type)];
}
//------------------------------------------------------------------------------
inline mesh::attribute mesh::attributes() const
{
return m_attributes;
}
//------------------------------------------------------------------------------
template<mesh::attribute A>
void mesh::clear()
{
m_attributes = m_attributes & ~A;
m_points[static_cast<std::size_t>(A)]->clear();
}
//------------------------------------------------------------------------------
template<mesh::attribute A>
inline bool mesh::has() const
{
return static_cast<bool>(m_attributes & A);
}
//------------------------------------------------------------------------------
template<mesh::attribute A>
inline bool mesh::has(data::mesh::attribute _attributes)
{
return static_cast<bool>(_attributes & A);
}
//------------------------------------------------------------------------------
template<typename T>
inline array_iterator<T> mesh::begin()
{
auto array = get_array<T>();
return array_iterator<T>(static_cast<typename array_iterator<T>::pointer_t>(array->buffer()));
}
//------------------------------------------------------------------------------
template<typename T>
inline array_iterator<T> mesh::end()
{
auto itr = begin<T>();
itr += static_cast<typename array_iterator<T>::difference_type>(num_elements<T>());
return itr;
}
//------------------------------------------------------------------------------
template<typename T>
inline const_array_iterator<T> mesh::begin() const
{
auto array = get_array<T>();
return const_array_iterator<T>(static_cast<typename const_array_iterator<T>::pointer_t>(array->buffer()));
}
//------------------------------------------------------------------------------
template<typename T>
inline const_array_iterator<T> mesh::end() const
{
auto itr = cbegin<T>();
itr += static_cast<typename const_array_iterator<T>::difference_type>(num_elements<T>());
return itr;
}
//------------------------------------------------------------------------------
template<typename T>
inline const_array_iterator<T> mesh::cbegin() const
{
auto array = get_array<T>();
return const_array_iterator<T>(static_cast<typename const_array_iterator<T>::pointer_t>(array->buffer()));
}
//------------------------------------------------------------------------------
template<typename T>
inline const_array_iterator<T> mesh::cend() const
{
auto itr = cbegin<T>();
itr += static_cast<typename const_array_iterator<T>::difference_type>(num_elements<T>());
return itr;
}
//------------------------------------------------------------------------------
template<typename T>
auto mesh::range()
{
auto b = begin<T>();
auto e = end<T>();
return boost::make_iterator_range(b, e);
}
//------------------------------------------------------------------------------
template<typename ... ATTRS>
auto mesh::zip_range()
{
return boost::combine(range<ATTRS>() ...);
}
//------------------------------------------------------------------------------
template<typename T>
auto mesh::range() const
{
auto b = cbegin<T>();
auto e = cend<T>();
return boost::make_iterator_range(b, e);
}
//------------------------------------------------------------------------------
template<typename ... ATTRS>
auto mesh::zip_range() const
{
return boost::combine(crange<ATTRS>() ...);
}
//------------------------------------------------------------------------------
template<typename T>
auto mesh::crange() const
{
auto b = cbegin<T>();
auto e = cend<T>();
return boost::make_iterator_range(b, e);
}
//------------------------------------------------------------------------------
template<typename ... ATTRS>
auto mesh::czip_range() const
{
return boost::combine(crange<ATTRS>() ...);
}
//------------------------------------------------------------------------------
} // namespace sight::data
|