Commit Graph

530 Commits

Author SHA1 Message Date
Sébastien Loriot 920c35c30e Merge cgal/master 2022-06-08 21:56:39 +02:00
Jane Tournois 38561b78c4 fix make_mesh_3 and refine_mesh_3 documentation 2022-06-08 21:48:32 +02:00
Laurent Rineau 37d1f118da Add a link to the section in MDS_3 2022-06-08 21:46:52 +02:00
Jane Tournois e0335e3e5e move everything about C3t3 to new package MDS_3 2022-06-08 21:46:51 +02:00
Jane Tournois 4575d8919c move concept 2022-06-08 21:46:51 +02:00
Jane Tournois 86c9a35c15 Merge remote-tracking branch 'cgal/master' into PMP-add_surface_mesher-jtournois 2022-06-02 08:25:30 +01:00
Sébastien Loriot ff16bec071 clean up EXAMPLE_PATH 2022-05-23 16:52:17 +02:00
albert-github ce43043735 issue #6539 Mesh3: unreachable page of ircad
Corrected reference to ircad
2022-04-30 13:47:24 +02:00
Jane Tournois c21fe46525 Merge remote-tracking branch 'cgal/master' into PMP-add_surface_mesher-jtournois
# Conflicts:
#	Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt
#	Polygon_mesh_processing/examples/Polygon_mesh_processing/CMakeLists.txt
2022-04-29 10:48:08 +02:00
albert-github b67a35c8f0 Mesh_3: correcting gforge address
Replacing the address http://inrimage.gforge.inria.fr/ by https://www-pequan.lip6.fr/~bereziat/inrimage/ as Forge is definitively shutdown.
2022-03-21 10:18:30 +01:00
Sébastien Loriot 593ff5371c Merge remote-tracking branch 'cgal/master' into HEAD 2022-02-01 20:11:27 +01:00
Sébastien Loriot ac77ee3140 fix doc build 2021-11-01 16:17:11 +01:00
Jane Tournois 909e69888c
Merge branch 'master' into PMP-add_surface_mesher-jtournois 2021-10-29 17:47:25 +02:00
Jane Tournois 1a3ce53464 user manual 2021-10-26 15:20:20 +02:00
Jane Tournois 9041574b9e remove free function remove_isolated_vertices_in_mesh_3
a member function of C3T3 is enough
2021-10-11 12:24:10 +02:00
Jane Tournois 509ecfa7d2 smoothing/smoother 2021-10-04 15:44:17 +02:00
Jane Tournois 8a6d92fff8 use "image of weights" in doc 2021-10-04 12:12:02 +02:00
Jane Tournois cf4edabb9e user manual 2021-10-04 09:12:56 +02:00
Jane Tournois 6e9252d196 doc 2021-10-01 14:25:14 +02:00
Jane Tournois c7a6adb21f move header doc as deprecation recommends 2021-09-28 11:10:01 +02:00
Jane Tournois db5e638ac2 un-document remove_far_points_in_mesh_3 and merge with remove_isolated_vertices_in_mesh_3 2021-09-27 11:47:43 +02:00
Jane Tournois 7545d2e302 document remove_isolated_vertices_in_mesh_3() 2021-09-24 17:15:36 +02:00
Jane Tournois 4b3fee813f ITK is not needed in c3t3_item, and find with the required components only 2021-09-23 14:46:40 +02:00
Jane Tournois 0bc25f9f20 doc (add dependency and new link) 2021-09-21 21:44:40 +02:00
Jane Tournois 666a54097d documents weights size 2021-09-20 12:00:11 +02:00
Jane Tournois bad72db82d document CGAL::remove_far_points_in_mesh_3() 2021-09-17 16:03:06 +02:00
Jane Tournois 2a4090b3a9 rename header in doc 2021-08-31 15:25:09 +02:00
albert-github 72e2c7b27b Warnings Mesh_3 regarding non existing file (documentation)
Currently we get a number of warnings when building the documentation for Mesh_3:
```
/home/cgal-testsuite/cgal_doc_build/CGAL-5.3.1-I-169/doc/Mesh_3/Mesh_3.txt:743: warning: unable to resolve reference to 'CGAL/Mesh_3/initialize_triangulation_from_labeled_image.h\' for \ref command
/home/cgal-testsuite/cgal_doc_build/CGAL-5.3.1-I-169/doc/Mesh_3/Mesh_3.txt:801: warning: unable to resolve reference to 'Mesh_3/random_labeled_image.h\' for \ref command
/home/cgal-testsuite/cgal_doc_build/CGAL-5.3.1-I-169/doc/Mesh_3/Mesh_3.txt:817: warning: unable to resolve reference to 'CGAL/Mesh_3/initialize_triangulation_from_gray_image.h\' for \ref command
```
Note the backslash at the end of the file name.

Most likely an attempt was made to escape the dot to not have it as part of the filename, though at least in doxygen 1.8.13 a closing dot was not seen as part of the filename.
Looking at the other escape character of doxygen: the commercial at sign, this was apparently working as escape in the filename as well, though in doxygen 1.8.15 this was not the case anymore either.
During one of the last changes also the backslash lost this possibility for this case and this is now consistent.

The current change (removing the backslashes) doesn't look like to alter the behavior for the 1.8.13 and master version in respect to CGAL.
2021-08-15 20:32:45 +02:00
Jane Tournois 868e1583e0 improve figure caption 2021-07-29 12:02:56 +02:00
Jane Tournois b4932e3188 add weighted images figure 2021-07-29 11:41:07 +02:00
Jane Tournois 85c2c20a0d doc tiny fixes 2021-07-26 12:57:57 +02:00
Jane Tournois ba95896f93 add doc for weighted images 2021-07-06 15:56:55 +02:00
albert-github 2a54687e77 Correction of hyperlinks
The link checker gave a number of redirects and incorrect links.
- the redirects have been solved ass far as possible
- the incorrect links have been checked and corrected where possible, others  have been reported through issues;
2021-06-04 13:52:14 +02:00
Sébastien Loriot 12f0e412b5 write_vtu -> write_VTU 2021-05-04 15:12:36 +02:00
Sébastien Loriot 70058db9b7 add IO namespace for Mesh_3 package 2021-05-03 15:39:07 +02:00
Sébastien Loriot 350b9172c5 replace %CGAL by \cgal (but in titles) 2021-04-11 14:52:01 +02:00
Laurent Rineau 1b54449dc5 Merge pull request #4878 from danston/Kernels-decltypes-danston
Improve decltype/result_of/invoke_result
2021-04-06 15:13:21 +02:00
Jane Tournois 032ad19677 add custom initialization of gray image to user manual
and re-organize to have both custom initializations (gray level and
segmented) together
2021-02-15 16:27:40 +01:00
Dmitry Anisimov 81d9556707 Merge remote-tracking branch 'upstream/master' into Kernels-decltypes-danston 2021-02-10 10:06:45 +01:00
Mael Rouxel-Labbé 444531b80e Fix broken `Kernel` links 2020-10-14 19:22:46 +02:00
Dmitry Anisimov 263ad6bc99 fixed ch3, inter3, otr2, psp, pmp, smsp, mesh3 + cleanup 2020-08-20 18:25:01 +02:00
Mael Rouxel-Labbé 3e9ce127b2 Misc CGAL IO doc fixes 2020-07-17 16:51:25 +02:00
Mael Rouxel-Labbé ae4c2aaa9e IO doc fixes 2020-06-26 16:08:02 +02:00
Mael Rouxel-Labbé 26355e2e32 Uniformize capital / third person usage of \brief 2020-06-25 15:13:47 +02:00
Mael Rouxel-Labbé 6f8a895671 Merge remote-tracking branch 'mine/CGAL-Improve_NP_doc_presentation-GF' into CGAL_IO-maxGimeno 2020-06-18 15:21:27 +02:00
Mael Rouxel-Labbé fc79510388 Regroup NP aliases into the base doxyfile.in 2020-04-04 17:26:32 +02:00
Maxime Gimeno 4e6fb685c6 Merge remote-tracking branch 'mine/CGAL_IO-maxGimeno' into HEAD 2020-03-27 11:11:10 +01:00
Sébastien Loriot 8b153fb495 Merge branch 'cgal/releases/CGAL-5.0-branch'
whitespace+tab removal, merged with option -Xignore-space-change
2020-03-26 14:22:32 +01:00
Sébastien Loriot 0a46621dc6 Merge branch 'cgal/releases/CGAL-4.14-branch'
whitespace+tab removal, merged with option -Xignore-all-space
2020-03-26 13:28:46 +01:00
Sébastien Loriot 590612a563 run the script to remove tabs and trailing whitespaces 2020-03-26 13:25:16 +01:00
Mael Rouxel-Labbé 30d4754a04 Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-03-17 09:03:12 +01:00
Mael Rouxel-Labbé e73b973b62 Use Parallel_if_available_tag to simplify code that used CGAL_LINKED_WITH_TBB 2019-11-20 12:24:54 +01:00
Maxime Gimeno c8c46d6f00 Finished the `Supported file formats` page 2019-09-19 13:27:06 +02:00
Maxime Gimeno e5a0ddb7ba Add skeleton for some formats and list DS with documented IO in IOStream.txt 2019-09-18 14:45:38 +02:00
Sébastien Loriot fbafb9d06f fix remaining mismatches and fix bugs 2019-07-10 11:40:45 +02:00
Sébastien Loriot 983645a51a match @{ and @} 2019-07-05 21:49:46 +02:00
Sébastien Loriot 5a30e88a92 replace cpp11::function by std::function 2019-03-29 13:28:33 +01:00
Sébastien Loriot f62624c4f9 replace cpp11::tuple by std::tuple 2019-03-29 13:28:33 +01:00
Laurent Rineau 8ae3756cb6
Merge pull request #3812 from janetournois/Mesh_3-c3t3-doc-fix-jtournois
Doc fix (tiny) in concept `MeshComplexWithFeatures_3InTriangulation_3`
2019-03-28 16:49:23 +01:00
Jane Tournois cdd2231e8a add two missing 's' (there was no link on these in the doc) 2019-03-28 16:02:06 +01:00
Andreas Fabri 7c2674abc8 More links fixed 2019-03-20 08:38:40 +01:00
Andreas Fabri e254a770df Some Fixes for #3457 2019-03-19 19:20:40 +01:00
Sébastien Loriot 59bc453b42 first batch of replacement for level 1 in classified ref man
command used:
grep -l  "##" */doc/*/PackageDescription.txt | xargs  sed -i  -E 's/\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\s*$/\\cgalCRPSection{\1}/'
2019-02-14 10:32:39 +01:00
Sébastien Loriot eadb08d976 replace mode by a np 2019-01-17 16:03:48 +01:00
Laurent Rineau c1d4608665 My changes to output_to_vtu 2019-01-17 16:03:43 +01:00
Sébastien Loriot 3a7269b8f6 improve doc 2019-01-16 12:00:07 +01:00
Maxime Gimeno cb10422e3c Fix indentation and markdown 2019-01-16 10:44:30 +01:00
Maxime Gimeno 7b13f4a969 Add misisng license header, rename vtu functions and update change.md 2018-11-23 10:11:23 +01:00
Maxime Gimeno 33482dc532 Fix conflicts 2018-11-21 10:55:09 +01:00
Maxime Gimeno 5180876290 Fix ambiguity between 2D and 3D write_VTU and restore gone bool binary in write_VTU 3D 2018-11-21 10:48:16 +01:00
Maxime Gimeno 6e4ab58edc Put write_vtk in Polyhedron_IO 2018-11-20 15:15:53 +01:00
Maxime Gimeno 08a98a5603 Update Changes.md 2018-10-30 11:51:34 +01:00
Maxime Gimeno 33a3996fa1 Rename write_VTU and write_VTP 2018-10-29 15:02:20 +01:00
Maxime Gimeno 63488d81d1 Update Changes and doc 2018-10-29 12:59:44 +01:00
Sébastien Loriot 3dd0aa112d rename macro not following the convention 2018-10-08 10:28:55 +02:00
Sébastien Loriot ea240cfac5 use \PkgXXX instead of \PkgXXXSummary 2018-10-08 10:28:44 +02:00
Sébastien Loriot a2e8a1c68f add the suffix Ref to doxygen link to reference 2018-10-08 10:26:56 +02:00
Laurent Rineau f89266bf4f Trivial fix of the documentation 2018-07-31 17:32:37 +02:00
Laurent Rineau 10a84aa34e Merge branch 'master' into Periodic_3_mesh_3-Feature-MBogdanov 2018-06-27 10:33:24 +02:00
Mael Rouxel-Labbé d6857514be Dropped 'const&' in function parameter in wrappers/model domains
1. This doesn't really make sense if the template is a function type.
2. There is already a copy of the function anyway
2018-06-20 12:35:19 +02:00
Simon Giraudot ae193e5af3 Document Eigen dependency in PackageDescription.txt of packages 2018-06-19 11:00:02 +02:00
Simon Giraudot 41d554fe58 Deprecating Diagonalize_traits: document dependency to Eigen 2018-06-19 10:57:55 +02:00
Mael Rouxel-Labbé 340e5d3b5a Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov 2018-06-12 23:29:43 +02:00
Mael Rouxel-Labbé 4bb3391601 Minor doc changes 2018-06-08 17:06:23 +02:00
Mael Rouxel-Labbé b00075a503 Fixed some trailing whitespace
(to trigger travis)
2018-06-06 17:51:09 +02:00
Mael Rouxel-Labbé 44e39f5300 Fix missing const& in the docs of Mesh_3 and P3M3 2018-06-06 17:47:20 +02:00
Mael Rouxel-Labbé cdda597e4e Renamed the medit output function 2018-06-06 11:58:36 +02:00
Mael Rouxel-Labbé 7ea3a8044e Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov 2018-06-05 14:39:18 +02:00
Laurent Rineau c1a9f93a24 Fix a warning (and doc)
Document that the interpolation, in 3D gray images, is always done using
`double` as numerical type.
2018-06-05 10:48:12 +02:00
Jane Tournois d591d100c2 doc : improve discussion on optimizers
add something to insist on the fact that ODT, Lloyd, and perturber
can't deal with a mesh already treated with sliver exudation
2018-05-17 18:24:43 +02:00
Laurent Rineau f458dc5cc4 Document that the implicit function is CopyConstructible 2018-05-15 15:13:05 +02:00
Laurent Rineau d982483431 Add (deprecated) in the list of classes 2018-05-15 15:13:04 +02:00
Laurent Rineau a69ea141b6 Add deprecation notice to Implicit_mesh_domain_3, in the doc 2018-05-15 15:13:04 +02:00
Laurent Rineau b4a14010a1 Document create_implicit_mesh_domain() 2018-05-15 15:13:04 +02:00
Laurent Rineau 2def8c6e8f typo: missing space 2018-05-15 15:13:04 +02:00
Laurent Rineau 6d64ec2a0b Document CGAL::Image_3 2018-05-15 15:13:04 +02:00
Laurent Rineau b090edb03d Remove mentions of the deprecated classes 2018-05-15 15:13:04 +02:00
Laurent Rineau d56c54179f Remove the buggy concept LabelImage_3 2018-05-15 15:13:04 +02:00
Laurent Rineau b8b4b6b351 Typo: missing ) 2018-05-15 14:56:24 +02:00
Laurent Rineau b61cef82dd Wording
See Mael's comment:
https://github.com/CGAL/cgal/pull/2739#discussion_r175448829
2018-05-15 14:56:24 +02:00
Laurent Rineau ffbd029f40 New wording
See Mael's comment:
https://github.com/CGAL/cgal/pull/2739#discussion_r175410322
2018-05-15 14:56:24 +02:00
Laurent Rineau dc3e86e281 Unify sentence "Construct a... " and "Construction from"
See Mael's comment:
https://github.com/CGAL/cgal/pull/2739#discussion_r175405016
2018-05-15 14:56:23 +02:00
Laurent Rineau 0cacf1a1bb Document where the geometric objects come from (from BGT)
See Mael's comment:
https://github.com/CGAL/cgal/pull/2739#discussion_r175414307
2018-05-15 14:56:23 +02:00
Laurent Rineau b760c9d1da Fix formatting
From Mael comment:
https://github.com/CGAL/cgal/pull/2739#discussion_r175404665
2018-05-15 14:56:23 +02:00
Laurent Rineau 016b662fba Document the deprecation of the old domain classes from 3D images 2018-05-15 14:56:23 +02:00
Laurent Rineau e4954e5b0d Document the new API of Labeled_mesh_domain 2018-05-15 14:56:23 +02:00
Mael Rouxel-Labbé 5dfdb88f22 Doc improvements 2018-04-26 14:39:12 +02:00
Mael Rouxel-Labbé a0427ec756 Fixed abusing Triangulation_cell_base_3 for Delaunay triangulations
TriangulationCellBase_3 does not request a circumcenter;
DelaunayTriangulationCellBase_3 does.

Delaunay_triangulation_3 only compiled because
Triangulation_cell_base_3 (and Triangulation_ds_cell_base_3 !)
provided circumcenter() operators and DT3 inherited T3's TDS.

- The circumcenter() functions are removed where they shouldn't exist
- DT3 uses DT_cell_base_3 as cell base instead of T_cell_base_3
- Concepts/Classes that supposedly only required TriangulationCellBase_3
  and then built Delaunay triangulations with that (Alpha Shapes, etc.)
  are upgraded to request DelaunayTriangulationCellBase_3 (anyway, it
  wouldn't compile if you actually provided a model of
  TriangulationCellBase_3)
- Fixed various wrong templates in classes/concepts such as
  MeshVertexBase_3 not refining RegularTriangulationVertexBase_3
  and (only in the doc) defaulting to Triangulation_vertex_base_3
- Removed the deprecated class (for 4+ years) T_cell_base_with_circumcenter
2018-04-26 13:21:53 +02:00
Mael Rouxel-Labbé 17d46e9211 Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov 2018-04-26 11:55:17 +02:00
Laurent Rineau cd6fe20bd4 Merge branch 'releases/CGAL-4.11-branch' 2018-03-26 11:03:37 +02:00
Jane Tournois 5ac449dfd9 remove function that makes no sense from the doc
there cannot be 2 corners with the same index
2018-03-23 11:54:45 +01:00
Mael Rouxel-Labbé 44162aad0d Minor doc improvements 2018-03-15 14:29:38 +01:00
Mael Rouxel-Labbé db8f865b9a Documentation changes 2018-02-23 17:59:19 +01:00
Laurent Rineau 42b11ddf29 Revert the merge of PR #2478
This reverts the merge commit 46cc91e787 onto
488c3e2879.
2018-01-04 17:54:08 +01:00
Mael Rouxel-Labbé ea8ba5c154 Misc minor doc changes 2017-12-19 15:45:49 +01:00
Mael Rouxel-Labbé d2ece33849 Documented Mesh_3's and P3M3's medit IO function 2017-12-19 15:44:26 +01:00
Mael Rouxel-Labbé 3e48f65c08 Doc improvements 2017-12-18 16:50:11 +01:00
Mael Rouxel-Labbé 6bc23c75a9 Replaced '*_badness' with 'Is_*_bad'
Partial revert of 583e205696eeb56df9ef9342789c35bb63e035f0.

The newer specification is actually 'Is_*_bad'.
2017-12-08 11:08:34 +01:00
Mael Rouxel-Labbé a5bfb8659f M3/P3M3 doc improvements 2017-12-08 11:02:19 +01:00
Mael Rouxel-Labbé 9b8a43d0d5 M3/P3M3 doc improvements 2017-12-06 12:50:55 +01:00
Mael Rouxel-Labbé 7c15c28b6e Capitalized section titles 2017-12-05 18:18:47 +01:00
Mael Rouxel-Labbé 61ff842be2 Improved doc (M3/P3M3) 2017-12-05 16:27:15 +01:00
Mael Rouxel-Labbé ba3a59ed5a Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov 2017-11-30 15:54:00 +01:00
Mael Rouxel-Labbé 78133c5100 Replaced usages of '.weight()' in Mesh_3 and P3M3
Either through the comparison predicate or the weight constructor.
2017-11-29 16:30:34 +01:00
Mael Rouxel-Labbé f019c4a2f6 Cleaned some Mesh_3 doc 2017-11-28 14:27:53 +01:00
Mael Rouxel-Labbé 87966f6ca8 Added a description to (P3)M3's MeshClasses doc group 2017-11-21 17:18:52 +01:00
Mael Rouxel-Labbé aadddba985 Fixed a couple of "an h..." that should have been "a h..." 2017-11-21 17:15:25 +01:00
Mael Rouxel-Labbé 816fd4f646 Doc improvements
and trailing whitespace cleaning
2017-11-21 14:26:02 +01:00
Mael Rouxel-Labbé 244fd32af6 Fixed trailing whitespace 2017-11-20 13:04:48 +01:00
Mael Rouxel-Labbé 0830a345fe Doc improvements 2017-11-20 13:04:25 +01:00
Mael Rouxel-Labbé 3bf8d442af Removed two functions from the mesh complex concept
They are neither implemented nor used.
2017-11-19 12:45:12 +01:00
Sébastien Loriot 19adf3b05e make the doc match struct/class with the implementation 2017-11-17 11:34:55 +01:00
Mael Rouxel-Labbé 1f0de91fe2 Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov 2017-11-02 15:19:38 +01:00
Mael Rouxel-Labbé 1f4475d471 Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov 2017-10-27 16:26:27 +02:00
Mael Rouxel-Labbé 5fb0ea6f04 Minor doc change 2017-10-26 12:53:21 +02:00
Laurent Rineau 728f358c31 Write the documentation 2017-10-23 18:30:31 +02:00
Laurent Rineau 3dcc4cf5d7 Merge pull request #2491 from janetournois/Mesh_3-document_manifold_criterion-jtournois
Mesh 3 : document manifold criterion
2017-10-23 17:24:51 +02:00
Jane Tournois d4769ee73f add conditions about termination with manifold() 2017-10-19 14:49:19 +02:00
Mael Rouxel-Labbé 94bb59b722 Various doc/comments improvements 2017-10-17 12:45:30 +02:00
Jane Tournois 059d7a88da improve doc 2017-10-16 15:29:51 +02:00
Jane Tournois c291be9799 improve doc 2017-10-13 15:59:48 +02:00
Jane Tournois 48e012cc0e add Point_3 typedef to get the links in the html page 2017-10-13 15:59:48 +02:00
Jane Tournois 591a20cf2b fix typos 2017-10-13 15:59:48 +02:00
Laurent Rineau f3924fe8d6 curve segment -> curve 2017-10-13 15:59:48 +02:00
Laurent Rineau 0b79594cfc Rephrase: mention orientation once cycles are mentioned too 2017-10-13 15:58:58 +02:00
Laurent Rineau 87f56930e5 New documentation for MeshDomainWithFeatures_3 2017-10-13 15:57:03 +02:00
Jane Tournois 6213cf240e doc : add precondition and rephrase 2017-10-03 16:34:28 +02:00
Jane Tournois c7613ff867 doc : fix remaining todo 2017-10-03 15:12:15 +02:00
Jane Tournois 6b62668df5 document manifold criterion 2017-10-03 14:08:31 +02:00
Jane Tournois 7464e8cf27 add a skeleton for documentation of Manifold_options in make_mesh_3()
the 3 possible values are non_manifold(), manifold(),
and manifold_with_boundary()
2017-09-19 16:29:08 +02:00