songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

backticks and rephrasing 

Co-authored-by: Mael <mael.rouxel.labbe@geometryfactory.com>
This commit is contained in:
Sebastien Loriot 2025-11-20 13:23:26 +01:00 committed by GitHub
parent 76552ccca1
commit eb14bf2a17
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Combinatorial_map/include/CGAL/Element_topo.h
View File

@ -78,7 +78,7 @@ cell_topo topo_from_name(const std::string& t)
} }
/** /**
* @brief To get the type of dimD cell of the CMap of cmapdim dimension. * @brief To get the type of `dimD` cell of the `CMap` of `cmapdim` dimension.
*/ */
template<typename CMap, unsigned int dimcell, template<typename CMap, unsigned int dimcell,
unsigned int cmapdim=CMap::dimension> unsigned int cmapdim=CMap::dimension>

8
Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex/IO/VTK.h
View File

@ -6,7 +6,7 @@ namespace IO {
* format. * format.
* *
* Only supports: * Only supports:
* - Linear_cell_complex_for_combinatorial_map<3,3> * - `CGAL::Linear_cell_complex_for_combinatorial_map<3,3>`
* - VTK legacy ASCII format (.vtk files) * - VTK legacy ASCII format (.vtk files)
* - Optional scalar fields for vertices and volumes * - Optional scalar fields for vertices and volumes
* *
@ -23,14 +23,14 @@ namespace IO {
/** /**
* \brief Reads a VTK legacy ASCII file and load it into a 3D * \brief Reads a VTK legacy ASCII file and load it into a 3D
* Linear_cell_complex. * linear cell complex.
* \ingroup PkgLinearCellComplexRefIOVTK * \ingroup PkgLinearCellComplexRefIOVTK
* *
* \tparam LCC must be a `CGAL::Linear_cell_complex_for_combinatorial_map<3,3>` * \tparam LCC must be a `CGAL::Linear_cell_complex_for_combinatorial_map<3,3>`
* \tparam VertexScalarType Type for vertex scalar data (default: float) * \tparam VertexScalarType Type for vertex scalar data (default: float)
* \tparam VolumeScalarType Type for volume scalar data (default: float) * \tparam VolumeScalarType Type for volume scalar data (default: float)
* \param filename Path to the VTK file * \param filename Path to the VTK file
* \param alcc The Linear_cell_complex to populate (will be cleared first) * \param alcc The linear cell complex to populate (will be cleared first)
* \param vertex_scalars Optional output vector to store per-vertex scalar values. * \param vertex_scalars Optional output vector to store per-vertex scalar values.
* If provided, will be resized to match number of vertices. * If provided, will be resized to match number of vertices.
* \param volume_scalars Optional output vector to store per-volume scalar values. * \param volume_scalars Optional output vector to store per-volume scalar values.
@ -51,7 +51,7 @@ bool read_VTK(const char* filename,
* \tparam VertexScalarType Type for vertex scalar data (default: float) * \tparam VertexScalarType Type for vertex scalar data (default: float)
* \tparam VolumeScalarType Type for volume scalar data (default: float) * \tparam VolumeScalarType Type for volume scalar data (default: float)
* \param filename Path to the output VTK file * \param filename Path to the output VTK file
* \param alcc The Linear_cell_complex to export * \param alcc The linear cell complex to export
* \param vertex_scalars Optional per-vertex scalar data. If provided, must have * \param vertex_scalars Optional per-vertex scalar data. If provided, must have
* same size as number of vertex attributes in the LCC. * same size as number of vertex attributes in the LCC.
* \param volume_scalars Optional per-volume scalar data. If provided, must have * \param volume_scalars Optional per-volume scalar data. If provided, must have

6
Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt
View File

@ -289,15 +289,15 @@ The following example shows the use of \link GenericMap::insert_cell_1_between_t
Result of the run of the linear_cell_complex_3_insert program. A window shows the 3D cube where one face has a hole. Result of the run of the linear_cell_complex_3_insert program. A window shows the 3D cube where one face has a hole.
\cgalFigureEnd \cgalFigureEnd
\subsection Linear_cell_complexWriteVTK Write a Linear Cell Complex in a VTK File \subsection Linear_cell_complexWriteVTK Writing a Linear Cell Complex to a VTK File
\anchor ssecLCCWriteVtK \anchor ssecLCCWriteVtK
This example loads a 3D linear cell complex from a `.3map` file (using the `operator>>`). It computes for each 3-cell (volume) the number of incident vertices (0-cells), stores these values in a `std::vector<std::size_t>`, and writes the result to a `.vtk` file with `CGAL::IO::write_VTK()`, using the computed values as scalars for each volume. This example loads a 3D linear cell complex from a `.3map` file (using the `operator>>`). It computes for each 3-cell (volume) the number of incident vertices (0-cells), stores these values in a `std::vector<std::size_t>`, and writes the result to a `.vtk` file using `CGAL::IO::write_VTK()`, with the computed values as scalars for each volume.
\cgalExample{Linear_cell_complex/linear_cell_complex_3_vtk_io.cpp} \cgalExample{Linear_cell_complex/linear_cell_complex_3_vtk_io.cpp}
\cgalFigureBegin{fig_lcc_export_vtk,lcc-export-vtk.png} \cgalFigureBegin{fig_lcc_export_vtk,lcc-export-vtk.png}
Visualization of the VTK file generated by the linear_cell_complex_3_vtk_io program, using Paraview. Each volume is colored depending on its number of vertices. Visualization of the VTK file generated by the `linear_cell_complex_3_vtk_io` program, using Paraview. Each volume is colored depending on its number of vertices.
\cgalFigureEnd \cgalFigureEnd