mirror of https://github.com/CGAL/cgal
Unexpected backtick (#7378)
In the file: Arrangement_on_surface_2/index.html we see: ``` The example below shows how to construct the same arrangement of five line segments built incrementally in Arrangement_on_surface_2/incremental_insertion.cpp` depicted in Figure 34.9 using the aggregate insertion ``` i.e. an unexpected backtick.
This commit is contained in:
Laurent Rineau
GitHub
commit
9e18cc6989
|
|
@ -76,7 +76,7 @@ A functor object to compare the distance of two points wrt a third one. Provides
|
|||
|
||||
`CGAL::Comparison_result operator()(const Point_3& p1, const Point_3& p2, const Point_3& p3)`,
|
||||
|
||||
which compares the distance between `p1 and `p2`, and between `p2` and `p3`.
|
||||
which compares the distance between `p1` and `p2`, and between `p2` and `p3`.
|
||||
*/
|
||||
typedef unspecified_type Compare_distance_3;
|
||||
|
||||
|
|
|
|||
|
|
@ -186,7 +186,7 @@ namespace CGAL {
|
|||
CGAL::Advancing_front_surface_reconstruction_vertex_base_3<
|
||||
CGAL::Exact_predicates_inexact_constructions_kernel>,
|
||||
CGAL::Advancing_front_surface_reconstruction_cell_base_3<
|
||||
CGAL::Exact_predicates_inexact_constructions_kernel> > >`
|
||||
CGAL::Exact_predicates_inexact_constructions_kernel> > >
|
||||
\endcode
|
||||
|
||||
\tparam P must be a functor offering
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ It defaults to:
|
|||
\code
|
||||
CGAL::Triangulation_data_structure_2<
|
||||
CGAL::Apollonius_graph_vertex_base_2<Gt,true>,
|
||||
CGAL::Triangulation_face_base_2<Gt> >`
|
||||
CGAL::Triangulation_face_base_2<Gt> >
|
||||
\endcode
|
||||
|
||||
\cgalHeading{Traversal of the Apollonius Graph}
|
||||
|
|
|
|||
|
|
@ -2058,7 +2058,7 @@ insertion.
|
|||
|
||||
The example below shows how to construct the same arrangement of five
|
||||
line segments built incrementally in \ref
|
||||
Arrangement_on_surface_2/incremental_insertion.cpp` depicted in
|
||||
Arrangement_on_surface_2/incremental_insertion.cpp depicted in
|
||||
\cgalFigureRef{aos_fig-incremental_insertion} using the aggregate
|
||||
insertion function \link CGAL::insert<>() `insert()`\endlink. Note
|
||||
that no point-location object needs to be defined and attached to the
|
||||
|
|
@ -2266,7 +2266,7 @@ description of geometric objects from a file and constructs them. It
|
|||
accepts the name of an input file that contains the plain-text
|
||||
description of the geometric objects and an output iterator for
|
||||
storing the newly constructed objects. When the function is
|
||||
instantiated, the first template parameter, namely Type`, must be
|
||||
instantiated, the first template parameter, namely `Type`, must be
|
||||
substituted with the type of objects to read. It is assumed that an
|
||||
extractor operator (`>>`) that extracts objects of the given type from
|
||||
the input stream is available. The listing of the function template,
|
||||
|
|
@ -4953,7 +4953,7 @@ nested type `Algebraic_real_1` of the \f$y\f$-coordinate is only
|
|||
computed upon request, as it can be a rather costly operation.
|
||||
|
||||
The aforementioned types, `Polynomial_1`, `Coefficient`,
|
||||
`Bound, and `Algebraic_real_1`, are conveniently nested in
|
||||
`Bound`, and `Algebraic_real_1`, are conveniently nested in
|
||||
the `Arr_rational_function_traits_2` class template among
|
||||
the others and obtained from there in the type definitions used
|
||||
in the examples given in this section and listed below. These types
|
||||
|
|
@ -5510,7 +5510,7 @@ nested types are defined as follows:
|
|||
The latter ensures that every instance of the class template
|
||||
`Arr_curve_data_traits_2` obtained by substituting the `BaseTraits`
|
||||
template parameter with a model of the `ArrangementLandmarkTraits_2`
|
||||
concept models the ArrangementLandmarkTraits_2` concept as well
|
||||
concept models the `ArrangementLandmarkTraits_2` concept as well
|
||||
|
||||
</UL>
|
||||
|
||||
|
|
@ -6936,7 +6936,7 @@ demonstrates the application of the breadth-first search} (BFS)
|
|||
algorithm on a dual arrangement. It uses the functor template
|
||||
`Extended_face_property_map<Arrangement, Type>` to directly access
|
||||
information stored inside the faces. The functor implements a property
|
||||
map that utilizes the `data()` and `set_data() member functions of the
|
||||
map that utilizes the `data()` and `set_data()` member functions of the
|
||||
extended face to update or obtain the property. When the property map
|
||||
is instantiated, the `Type` parameter must be substituted with the
|
||||
same type that is used to extend the arrangement face; see Section
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ class Gps_face_base : public Arr_face_base {};
|
|||
/*!
|
||||
\ingroup PkgBooleanSetOperations2Ref
|
||||
|
||||
An instance of this teplate serves as a basis type for any halfedge record
|
||||
An instance of this template serves as a basis type for any halfedge record
|
||||
of the \dcel class used by instances of the
|
||||
General_polygon_set_2` and `General_polygon_with_holes_2` class templates.
|
||||
`General_polygon_set_2` and `General_polygon_with_holes_2` class templates.
|
||||
|
||||
The `X_monotone_curve_2` template parameter is the type of
|
||||
\f$ x\f$-monotone curves associated with the halfedges.
|
||||
|
|
|
|||
|
|
@ -280,7 +280,7 @@ There are also two different classes of ranges containing one dart per <I>i</I>-
|
|||
|
||||
The iterators of the \link GenericMap::Dart_range `Dart_range`\endlink are bidirectional iterators, while the iterators of the other four ranges are forward iterators. The value type of all these iterators is `Dart` thus all these iterators can be directly used as \link GenericMap::Dart_descriptor `Dart_descriptor`\endlink.
|
||||
|
||||
Additionally, there is a range over non void <I>i</I>-attributes: \link GenericMap::Attribute_range `Attribute_range<i>::type`\endlink, having a bidirectional iterator with value type \link GenericMap::Attribute_type Attribute_type<i>::type`\endlink.
|
||||
Additionally, there is a range over non void <I>i</I>-attributes: \link GenericMap::Attribute_range `Attribute_range<i>::type`\endlink, having a bidirectional iterator with value type \link GenericMap::Attribute_type `Attribute_type<i>::type`\endlink.
|
||||
|
||||
For each range, there is an associated const range, a model of the `ConstRange` concept. You can find some examples of ranges in Section \ref ssecexample3DCM "A 3D Combinatorial Map".
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ defined, unless `BOOST_HAS_THREADS` or `_OPENMP` is defined. It is possible
|
|||
to force its definition in the compiler options, and it is possible to prevent its
|
||||
default definition by defining the macro `CGAL_HAS_NO_THREADS`.
|
||||
If you are using CMake, then you can set the CMake option `CGAL_HAS_NO_THREADS` to
|
||||
`TRUE`. In addition to defining the preprocessor macro CGAL_HAS_NO_THREADS`, it will
|
||||
`TRUE`. In addition to defining the preprocessor macro `CGAL_HAS_NO_THREADS`, it will
|
||||
also avoid CMake to link with the native threads support library on your system.
|
||||
|
||||
\section Preliminaries_cc0x C++14 Support
|
||||
|
|
|
|||
|
|
@ -175,7 +175,7 @@ After that, you will have to specify the Qt5_DIR by hand to cmake, using somethi
|
|||
|
||||
-DQt5_DIR=/usr/local/opt/qt5/lib/cmake/Qt5
|
||||
|
||||
where '/usr/local/` is actually your current brew installation directory. Check this directory
|
||||
where `/usr/local/` is actually your current brew installation directory. Check this directory
|
||||
to be sure where the Qt5 is placed on your machine.
|
||||
|
||||
\subsection usage_configuring_cmake_gui Specifying Missing Dependencies
|
||||
|
|
|
|||
|
|
@ -279,7 +279,7 @@ There are also two different classes of ranges containing one dart per <I>i</I>-
|
|||
|
||||
The iterators of the \link GenericMap::Dart_range `Dart_range`\endlink are bidirectional iterators, while the iterators of the other four ranges are forward iterators. The value type of all these iterators is `Dart` thus all these iterators can be directly used as \link GenericMap::Dart_descriptor `Dart_descriptor`\endlink.
|
||||
|
||||
Additionally, there is a range over non void <I>i</I>-attributes: \link GenericMap::Attribute_range `Attribute_range<i>::type`\endlink, having a bidirectional iterator with value type \link GenericMap::Attribute_type Attribute_type<i>::type`\endlink.
|
||||
Additionally, there is a range over non void <I>i</I>-attributes: \link GenericMap::Attribute_range `Attribute_range<i>::type`\endlink, having a bidirectional iterator with value type \link GenericMap::Attribute_type `Attribute_type<i>::type`\endlink.
|
||||
|
||||
For each range, there is an associated const range, a model of the `ConstRange` concept. You can find some examples of ranges in Section \ref ssecexample3DGM "A 3D Generalized Map".
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ public:
|
|||
/// Functor with operator: `Vector_3 operator()(const Vector_3& v, const Vector_3& w) const`, which constructs the cross product of `v` and `w`.
|
||||
typedef unspecified_type Construct_cross_product_vector_3;
|
||||
|
||||
/// Functor with operator: `FT operator()(const Vector_3& v, const Vector_3& w) const, which constructs the scalar product of `v` and `w`.
|
||||
/// Functor with operator: `FT operator()(const Vector_3& v, const Vector_3& w) const`, which constructs the scalar product of `v` and `w`.
|
||||
typedef unspecified_type Compute_scalar_product_3;
|
||||
|
||||
/// Functor with operator: `FT operator()(const Point_3& p, const Point_3& q) const` which computes the squared distance between `p` and `q`.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ const Point_3<Kernel> &r);
|
|||
|
||||
/*!
|
||||
Test for equality: two triangles `t1` and `t2` are equal, iff there
|
||||
exists a cyclic permutation of the vertices of t2`, such that
|
||||
exists a cyclic permutation of the vertices of `t2`, such that
|
||||
they are equal to the vertices of `t1`.
|
||||
*/
|
||||
bool operator==(const Triangle_3<Kernel> &t2) const;
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ source to the target.
|
|||
typedef unspecified_type Construct_segment_3;
|
||||
|
||||
/*!
|
||||
Model of `::Kernel::ConstructScaledVector_3``.
|
||||
Model of `::Kernel::ConstructScaledVector_3`.
|
||||
|
||||
That function object must provide the operator:
|
||||
- `Vector_3 operator()(Vector_3 v, FT scale)` which returns
|
||||
|
|
@ -174,7 +174,7 @@ Model of `::Kernel::HasOnBoundedSide_3`.
|
|||
|
||||
That function object must provide the operator:
|
||||
- `bool operator()(Sphere_3 s, Point_3 p)` which
|
||||
returns true iff `p` lies on the bounded side of `s.
|
||||
returns true iff `p` lies on the bounded side of `s`.
|
||||
*/
|
||||
typedef unspecified_type Has_on_bounded_side_3;
|
||||
|
||||
|
|
|
|||
|
|
@ -261,7 +261,7 @@ the faces and vertices maintaining incidence and adjacency relations (see
|
|||
Chapter \ref Chapter_2D_Triangulation_Data_Structure). In addition, the concepts
|
||||
`TriangulationDataStructure_2::Vertex` and `TriangulationDataStructure_2::Face` are extended
|
||||
to support periodicity: the vertex and face must be models of
|
||||
`Periodic_2TriangulationVertexBase_2` and Periodic_2TriangulationFaceBase_2`.
|
||||
`Periodic_2TriangulationVertexBase_2` and `Periodic_2TriangulationFaceBase_2`.
|
||||
A model of such concept is `CGAL::Triangulation_data_structure_2`. It is
|
||||
parameterized by a vertex base class and a face base class, which gives the
|
||||
possibility to customize the vertices and cells used by the triangulation data
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ struct Allow_all_moves{
|
|||
* \cgalParamNBegin{allow_move_functor}
|
||||
* \cgalParamDescription{A function object used to determinate if a vertex move should be allowed or not}
|
||||
* \cgalParamType{Unary functor that provides `bool operator()(vertex_descriptor v, Point_3 src, Point_3 tgt)` returning `true`
|
||||
* if the vertex `v` can be moved from `src` to `tgt`; %Point_3` being the value type of the vertex point map }
|
||||
* if the vertex `v` can be moved from `src` to `tgt`; `Point_3` being the value type of the vertex point map }
|
||||
* \cgalParamDefault{If not provided, all moves are allowed.}
|
||||
* \cgalParamNEnd
|
||||
*
|
||||
|
|
|
|||
|
|
@ -538,7 +538,7 @@ bool triangulate_face(typename boost::graph_traits<PolygonMesh>::face_descriptor
|
|||
* \cgalParamDefault{`Triangulate_faces::Default_visitor<PolygonMesh>`}
|
||||
* \cgalParamExtra{Note that the visitor will be copied, so
|
||||
* it must not have any data member that does not have a reference-like type.}
|
||||
* `\cgalParamNEnd
|
||||
* \cgalParamNEnd
|
||||
* \cgalNamedParamsEnd
|
||||
*
|
||||
* @return `true` if all the faces have been triangulated.
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ struct Concurrent_compact_container_traits {
|
|||
/// @{
|
||||
/*!
|
||||
Returns the pointer held by `t`.
|
||||
The template version defines this function as: `return t.for_compact_container();
|
||||
The template version defines this function as: `return t.for_compact_container();`
|
||||
*/
|
||||
static void * pointer(const T &t);
|
||||
|
||||
|
|
|
|||
|
|
@ -408,7 +408,7 @@ namespace internal {
|
|||
a model of `OutputIterator` whose value type is `Item`
|
||||
|
||||
\tparam InputRange
|
||||
a model of `ConstRange
|
||||
a model of `ConstRange`
|
||||
|
||||
\tparam ItemMap
|
||||
a model of `ReadablePropertyMap` with `InputRange::const_iterator` as key type and `Item` as value type.
|
||||
|
|
|
|||
|
|
@ -110,7 +110,7 @@ namespace Segment_set {
|
|||
\cgalParamNEnd
|
||||
\cgalParamNBegin{item_map}
|
||||
\cgalParamDescription{an instance of a model of `ReadablePropertyMap` with `InputRange::const_iterator`
|
||||
as key type and `Item` as value type.`}
|
||||
as key type and `Item` as value type.}
|
||||
\cgalParamDefault{A default is provided when `Item` is `InputRange::const_iterator` or its value type.}
|
||||
\cgalParamNEnd
|
||||
\cgalParamNBegin{geom_traits}
|
||||
|
|
|
|||
|
|
@ -447,7 +447,7 @@ bool read_3MF(const std::string& fname,
|
|||
* \param fname the name of the 3mf file to write
|
||||
* \param all_points a `PointRanges` that contains the points of the soups to write
|
||||
* \param all_triangles a `TriangleRanges` that contains the triangles of the soups in `fname`
|
||||
* \param names a range of std::string` associating a name to each soup, which will appear in the output
|
||||
* \param names a range of `std::string` associating a name to each soup, which will appear in the output
|
||||
*
|
||||
* \return `true` if the writing is successful, `false` otherwise.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ namespace Surface_mesh_parameterization {
|
|||
/// \ingroup PkgSurfaceMeshParameterizationOrbifoldHelperFunctions
|
||||
///
|
||||
/// reads a series of cones from an input stream. Cones are passed as an
|
||||
/// integer value that is the index of a vertex handle in the mesh tm`, using
|
||||
/// integer value that is the index of a vertex handle in the mesh `tm`, using
|
||||
/// the vertex index property map `vpmap` for correspondency.
|
||||
///
|
||||
/// \attention The mesh is here `tm`, it is the base mesh of the `CGAL::Seam_mesh`
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ The algorithm used is based on a paper by Despré and Lazarus \cgalCite{cgal:dl-
|
|||
The main class for this package is `Surface_mesh_topology::Curves_on_surface_topology`. Its constructor takes the input surface. An internal representation of the surface (described below) is computed the first time an homotopy test is called.
|
||||
|
||||
Each combinatorial curve on this surface is contained in an instance of the class `Surface_mesh_topology::Path_on_surface`. An object in this class behaves as a list. This list is initially empty and the halfedges corresponding to the sequence of consecutive oriented edges of an input curve should be pushed back in this list. The class provides four ways for extending a nonempty path.
|
||||
- Simply push the next halfedge using the \ref Surface_mesh_topology::Path_on_surface::push_back "push_back()" member function. One can also specify if this halfedge should have its direction flipped so as to satisfy the condition of a `Path_on_surface` (see the description of \ref Surface_mesh_topology::Path_on_surface::can_be_pushed "`can_be_pushed()`" below) This can be done even when the path is empty,
|
||||
- Simply push the next halfedge using the \ref Surface_mesh_topology::Path_on_surface::push_back "push_back()" member function. One can also specify if this halfedge should have its direction flipped so as to satisfy the condition of a `Path_on_surface` (see the description of \ref Surface_mesh_topology::Path_on_surface::can_be_pushed "can_be_pushed()" below) This can be done even when the path is empty,
|
||||
- The user may push the index of the next halfedge instead of the halfedge itself with the member function \ref Surface_mesh_topology::Path_on_surface::push_back_by_index "push_back_by_index()". This may however be at the cost of an overhead computation mapping the index to the actual dart,
|
||||
- The path may be extended with the member function \ref Surface_mesh_topology::Path_on_surface::extend_positive_turn "extend_positive_turn()" by specifying the next halfedge thanks to a number of positive turns with respect to the previous dart/halfedge in the path. Calling this previous halfedge `h`, extending by a positive one turn is thus equivalent to extend the path with `next(h)`. An analogous member function \ref Surface_mesh_topology::Path_on_surface::extend_negative_turn "extend_negative_turn()" is provided for convenience,
|
||||
- Finally, when the input surface is a model of `PolygonalSchema`, which is a model of `GenericMap` with labeled edges as explained in section \ref SMTopology_Schema, the user may push the label of the next halfedge instead of the halfedge itself with the member function \ref Surface_mesh_topology::Path_on_surface::push_back_by_label "push_back_by_label()".
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ It is really simple to add a pop-up box with Qt. Use a QMessageBox and give it s
|
|||
This section describes how to add a dock widget to the application.\n
|
||||
You can make your plugin inherit from CGAL::Three::Polyhedron_demo_plugin_helper, which gives access to the function CGAL::Three::Polyhedron_demo_plugin_helper#addDockWidget.
|
||||
This will manage automatically the position and tabification of a dock widget. \n
|
||||
Just like with the Dialog, create a new Qt Designer form (file->New file or Project->Qt->Qt Designer Form), choose `QDockWidget in Widgets
|
||||
Just like with the Dialog, create a new Qt Designer form (file->New file or Project->Qt->Qt Designer Form), choose `QDockWidget` in Widgets
|
||||
* \image html menu_6.png
|
||||
Add it to the project in the CMakeLists.txt :
|
||||
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ typedef unspecified_type Compute_squared_distance_2;
|
|||
A function object whose
|
||||
`operator()` computes the bounding box of a point.
|
||||
|
||||
CGAL::Bbox_2 operator()(Point_2 p);` Returns the bounding box of `p`.
|
||||
`CGAL::Bbox_2 operator()(Point_2 p);` Returns the bounding box of `p`.
|
||||
The result type is `CGAL::Bbox_2` (even for projection traits classes).
|
||||
*/
|
||||
typedef unspecified_type Compute_bounding_box_2;
|
||||
|
|
|
|||
Loading…
Reference in New Issue