Commit 157eef5c authored by Sylvain Thery's avatar Sylvain Thery

SCHNApps documentation ...

parent fc656be4
...@@ -11,7 +11,11 @@ namespace CGoGN ...@@ -11,7 +11,11 @@ namespace CGoGN
namespace SCHNApps namespace SCHNApps
{ {
/**
* @brief Plugin that manage the computation of differential properties
* - Normals
* - Curvatures
*/
class Surface_DifferentialProperties_Plugin : public PluginProcessing class Surface_DifferentialProperties_Plugin : public PluginProcessing
{ {
Q_OBJECT Q_OBJECT
......
...@@ -9,7 +9,7 @@ namespace CGoGN ...@@ -9,7 +9,7 @@ namespace CGoGN
namespace SCHNApps namespace SCHNApps
{ {
/** /**
* Plugin for 2D mesh import. Supported mesh file format are: off/obj/ply. * @brief Plugin for 2D mesh import. Supported mesh file format are: off/obj/ply.
* The import image function allow the creation of a mesh with a face by pixel. * The import image function allow the creation of a mesh with a face by pixel.
* Image format support is given by Qt. * Image format support is given by Qt.
*/ */
......
...@@ -61,7 +61,7 @@ struct MapParameters ...@@ -61,7 +61,7 @@ struct MapParameters
}; };
/** /**
* Plugin for 2-Maps topology rendering. * @brief Plugin for 2-Maps topology rendering.
* Some parameters are per view / per map: * Some parameters are per view / per map:
* - drawing of relations and dart * - drawing of relations and dart
* - colors * - colors
......
...@@ -39,7 +39,7 @@ struct MapParameters ...@@ -39,7 +39,7 @@ struct MapParameters
/** /**
* Plugin for rendering a scalar attribute over a surface with colormap. * @brief Plugin for rendering a scalar attribute over a surface with colormap.
* The scalar attribute to render must have its generated VBO. * The scalar attribute to render must have its generated VBO.
* A position VBO must be provided for surface rendering. * A position VBO must be provided for surface rendering.
* All parameters are per view / per map. * All parameters are per view / per map.
......
...@@ -15,7 +15,7 @@ namespace SCHNApps ...@@ -15,7 +15,7 @@ namespace SCHNApps
{ {
/** /**
* Plugin for 2-Maps topology rendering. * @brief Plugin for 2-Maps topology rendering.
* Some parameters are per view / per map: * Some parameters are per view / per map:
* - drawing of relations and dart * - drawing of relations and dart
* - colors * - colors
......
...@@ -25,7 +25,7 @@ struct MapParameters ...@@ -25,7 +25,7 @@ struct MapParameters
}; };
/** /**
* Plugin for vector attributes rendering over a surface mesh * @brief Plugin for vector attributes rendering over a surface mesh
* Each vector attribute to render must be of dim 3, and have a VBO * Each vector attribute to render must be of dim 3, and have a VBO
* The length and color of each vector can be changed. * The length and color of each vector can be changed.
* All parameters are per view / per map. * All parameters are per view / per map.
......
...@@ -36,7 +36,7 @@ struct MapParameters ...@@ -36,7 +36,7 @@ struct MapParameters
}; };
/** /**
* Plugin for cell selection (in conjonction with CellSelectors of MapHandlers) * @brief Plugin for cell selection (in conjonction with CellSelectors of MapHandlers)
* Selection of cells can be done: * Selection of cells can be done:
* - individually * - individually
* - in a sphere * - in a sphere
......
...@@ -11,7 +11,7 @@ namespace CGoGN ...@@ -11,7 +11,7 @@ namespace CGoGN
namespace SCHNApps namespace SCHNApps
{ {
/** /**
* Plugin that manage the subdivision of surface algorithms * @brief Plugin that manage the subdivision of surface algorithms
* Supported algorithms: * Supported algorithms:
* - Loop * - Loop
* - Catmull-Clark approximation * - Catmull-Clark approximation
......
...@@ -16,7 +16,7 @@ namespace SCHNApps ...@@ -16,7 +16,7 @@ namespace SCHNApps
class SCHNApps; class SCHNApps;
/** /**
* The camera class inherit from [qglviewer::Camera](http://libqglviewer.com/refManual/classqglviewer_1_1Camera.html) * @brief The camera class inherit from [qglviewer::Camera](http://libqglviewer.com/refManual/classqglviewer_1_1Camera.html)
* A camera object is generated with each new view (named camera_0 for view_O, etc..). * A camera object is generated with each new view (named camera_0 for view_O, etc..).
* Cameras can be shared among views. * Cameras can be shared among views.
* *
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
namespace CGoGN namespace CGoGN
{ {
/** /**
* A MapHandlerGen is a generic class that encapsulate a map. * @brief A MapHandlerGen is a generic class that encapsulate a map.
* It mainly allows the management of: * It mainly allows the management of:
* - Bounding-Box * - Bounding-Box
* - VBOs * - VBOs
......
...@@ -28,7 +28,7 @@ class ControlDock_MapTab; ...@@ -28,7 +28,7 @@ class ControlDock_MapTab;
class ControlDock_PluginTab; class ControlDock_PluginTab;
/** /**
* The SCHNApps central object application * @brief The SCHNApps central object application
* Manage: * Manage:
* - views * - views
* - cameras * - cameras
......
...@@ -27,7 +27,7 @@ namespace SCHNApps ...@@ -27,7 +27,7 @@ namespace SCHNApps
{ {
/** /**
* View class inherit from QGLViewer(http://libqglviewer.com/refManual/classQGLViewer.html) allow rendering of plugins. * @brief View class inherit from QGLViewer(http://libqglviewer.com/refManual/classQGLViewer.html) allow rendering of plugins.
* It can be link with several: * It can be link with several:
* - plugins * - plugins
* - maps * - maps
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment