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

verbs with s

This commit is contained in:
Guillaume Damiand 2023-08-24 17:07:30 +02:00
parent 3e71ba95a4
commit cc03d2ccb3
3 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Basic_viewer/doc/Basic_viewer/CGAL/Basic_viewer_qt.h
View File

@ -76,58 +76,58 @@ public:
/// negate the drawing of text (becomes `true` if it was `false` and reciprocally).
void negate_draw_text();
/// @return `true` if vertices are drawn.
/// return `true` if vertices are drawn.
bool get_draw_vertices() const;
/// @return `true` if edges are drawn.
/// return `true` if edges are drawn.
bool get_draw_edges() const;
/// @return `true` if rays are drawn.
/// return `true` if rays are drawn.
bool get_draw_rays() const;
/// @return `true` if lines are drawn.
/// return `true` if lines are drawn.
bool get_draw_lines() const;
/// @return `true` if faces are drawn.
/// return `true` if faces are drawn.
bool get_draw_faces() const;
/// @return `true` if mono color mode is used.
/// return `true` if mono color mode is used.
bool get_use_mono_color() const;
/// @return `true` if normal are reversed.
/// return `true` if normal are reversed.
bool get_inverse_normal() const;
/// @return `true` if text are drawn.
/// return `true` if text are drawn.
bool get_draw_text() const;
/// @return the mono color used for vertices.
/// return the mono color used for vertices.
const CGAL::IO::Color& get_vertices_mono_color() const;
/// @return the mono color used for edges.
/// return the mono color used for edges.
const CGAL::IO::Color& get_edges_mono_color() const;
/// @return the mono color used for rays.
/// return the mono color used for rays.
const CGAL::IO::Color& get_rays_mono_color() const;
/// @return the mono color used for lines.
/// return the mono color used for lines.
const CGAL::IO::Color& get_lines_mono_color() const;
/// @return the mono color used for faces.
/// return the mono color used for faces.
const CGAL::IO::Color& get_faces_mono_color() const;
/// clear the basic viewer, i.e. remove all its elements.
void clear();
/// @return `true` if the viewer is empty.
/// return `true` if the viewer is empty.
bool is_empty() const;
/// @return the bounding box of all the elements in the viewer.
/// return the bounding box of all the elements in the viewer.
const CGAL::Bbox_3& bounding_box() const;
/// @return `true` if the clipping plane is enabled.
/// return `true` if the clipping plane is enabled.
bool is_clipping_plane_enabled() const;
/// @return the clipping plane when it is enabled.
/// return the clipping plane when it is enabled.
Local_kernel::Plane_3 clipping_plane() const;
/// add the given point in the viewer.
@ -171,7 +171,7 @@ public:
/// start a new colored face.
void face_begin(const CGAL::IO::Color &acolor);
/// @return `true` iff a face is started.
/// return `true` iff a face is started.
bool is_a_face_started() const;
/// add the given point in the current face.
@ -195,10 +195,10 @@ public:
template <typename KPoint>
void add_text(const KPoint &kp, const std::string &txt);
/// @return the graphic storage of the viewer.
/// return the graphic storage of the viewer.
Graphic_storage<BufferType>& get_graphic_storage();
/// @return the graphic storage of the viewer, const version.
/// return the graphic storage of the viewer, const version.
const Graphic_storage<BufferType>& get_graphic_storage() const;
/// negate all normal of vertices and faces.
@ -232,14 +232,14 @@ template <typename BufferType=float>
class QApplication_and_basic_viewer
{
public:
/// Constructor given a Graphic_storage and possibly a title.
/// constructs given a Graphic_storage and possibly a title.
QApplication_and_basic_viewer(CGAL::Graphic_storage<BufferType>& buffer,
const char* title="CGAL Basic Viewer");
/// run the QApplication, i.e. open the Qt window. A call to this method is blocking, that is the program continues as soon as the user closes the window.
/// runs the QApplication, i.e. open the Qt window. A call to this method is blocking, that is the program continues as soon as the user closes the window.
void run();
/// @return a reference to the `Basic_viewer_qt` associated with this.
/// returns a reference to the `Basic_viewer_qt` associated with this.
Basic_viewer_qt<BufferType>& basic_viewer();
};

8
Basic_viewer/doc/Basic_viewer/CGAL/Drawing_functor.h
View File

@ -60,13 +60,13 @@ public:
/// nullptr by default.
std::function<CGAL::IO::Color(const DS &, FaceDescriptor)> face_color;
/// Ignore all vertices when `b` is `true`; otherwise ignore only vertices for which `ignore_vertex` returns `true`.
/// ignores all vertices when `b` is `true`; otherwise ignore only vertices for which `ignore_vertex` returns `true`.
void ignore_all_vertices(bool b);
/// Ignore all edges when `b` is `true`; otherwise ignore only edges for which `ignore_edge` returns `true`.
/// ignores all edges when `b` is `true`; otherwise ignore only edges for which `ignore_edge` returns `true`.
void ignore_all_vertices(bool b);
/// Ignore all faces when `b` is `true`; otherwise ignore only faces for which `ignore_face` returns `true`.
/// ignores all faces when `b` is `true`; otherwise ignore only faces for which `ignore_face` returns `true`.
void ignore_all_vertices(bool b);
};
@ -110,7 +110,7 @@ public:
/// nullptr by default.
std::function<CGAL::IO::Color(const DS &, VolumeDescriptor)> volume_color;
/// Ignore all volumes when `b` is `true`; otherwise ignore only volumes for which `ignore_volume` returns `true`.
/// ignores all volumes when `b` is `true`; otherwise ignore only volumes for which `ignore_volume` returns `true`.
void ignore_all_volumes(bool b);
};

36
Basic_viewer/doc/Basic_viewer/CGAL/Graphic_storage.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*!
\ingroup PkgBasicViewerClasses
The class `Graphic_storage` store points, segments, triangles, rays and lines. Elements can be added, possibly with associated colors. Non triangular faces can be directly added, and are triangulated internally.
The class `Graphic_storage` stores points, segments, triangles, rays and lines. Elements can be added, possibly with associated colors. Non triangular faces can be directly added and are triangulated internally.
\tparam BufferType the type used for point coordinates: `float` by default.
@ -12,55 +12,55 @@ The class `Graphic_storage` store points, segments, triangles, rays and lines. E
template <typename BufferType=float>
class Graphic_storage {
public:
/// add the given point in the storage.
/// adds the given point in the storage.
template <typename KPoint>
void add_point(const KPoint &p);
/// add the given colored point in the storage.
/// adds the given colored point in the storage.
template <typename KPoint>
void add_point(const KPoint &p, const CGAL::IO::Color &acolor);
/// add the given segment in the storage.
/// adds the given segment in the storage.
template <typename KPoint>
void add_segment(const KPoint &p1, const KPoint &p2);
/// add the given colored segment in the storage.
/// adds the given colored segment in the storage.
template <typename KPoint>
void add_segment(const KPoint &p1, const KPoint &p2,
const CGAL::IO::Color &acolor);
/// add the given ray in the storage: an half line starting from `p` and having `v` as direction.
/// adds the given ray in the storage: an half line starting from `p` and having `v` as direction.
template <typename KPoint, typename KVector>
void add_ray(const KPoint &p, const KVector &v);
/// add the given colored ray in the storage: an half line starting from `p` and having `v` as direction.
/// adds the given colored ray in the storage: an half line starting from `p` and having `v` as direction.
template <typename KPoint, typename KVector>
void add_ray(const KPoint &p, const KVector &v,
const CGAL::IO::Color &acolor);
/// add the given line in the storage, defined by `p` and `v` as direction.
/// adds the given line in the storage, defined by `p` and `v` as direction.
template <typename KPoint, typename KVector>
void add_line(const KPoint &p, const KVector &v);
/// add the given colored line in the storage, defined by `p` and `v` as direction.
/// adds the given colored line in the storage, defined by `p` and `v` as direction.
template <typename KPoint, typename KVector>
void add_line(const KPoint &p, const KVector &v,
const CGAL::IO::Color &acolor);
/// start a new face.
/// starts a new face.
void face_begin();
/// start a new colored face.
/// starts a new colored face.
void face_begin(const CGAL::IO::Color &acolor);
/// @return `true` iff a face is started.
/// return `true` iff a face is started.
bool is_a_face_started() const;
/// add the given point in the current face.
/// adds the given point in the current face.
/// @pre `is_a_face_started()`
template <typename KPoint> bool add_point_in_face(const KPoint &kp);
/// add the given point in the current face, having the vertex normal.
/// adds the given point in the current face, having the vertex normal.
/// @pre `is_a_face_started()`
template <typename KPoint, typename KVector>
bool add_point_in_face(const KPoint &kp, const KVector &p_normal);
@ -69,18 +69,18 @@ public:
/// @pre `is_a_face_started()`
void face_end();
/// add the given text at the given position in the storage.
/// adds the given text at the given position in the storage.
template <typename KPoint>
void add_text(const KPoint &kp, const char *txt);
/// add the given text at the given position in the storage.
/// adds the given text at the given position in the storage.
template <typename KPoint>
void add_text(const KPoint &kp, const std::string &txt);
/// @return `true` iff the storage has no element.
/// returns `true` iff the storage has no element.
bool is_empty() const;
/// clear the storage, i.e. remove all points, segments, triangles and text.
/// clears the storage, i.e. remove all points, segments, triangles and text.
void clear();
};