X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2Fdoxygen%2FDoxyMainPage.txt.in;h=63123b4577b6ff1b929f33ed2381e8ff1536989d;hb=70099ab75006f1f8b77d0cede54ec9199ca0321f;hp=306fc377661c2c12b0a081b4ec8b4e5377ddb2ae;hpb=2e390e22a960a1a85c9bbbc5437429ecadbf37ff;p=creaMaracasVisu.git
diff --git a/lib/doxygen/DoxyMainPage.txt.in b/lib/doxygen/DoxyMainPage.txt.in
index 306fc37..63123b4 100644
--- a/lib/doxygen/DoxyMainPage.txt.in
+++ b/lib/doxygen/DoxyMainPage.txt.in
@@ -6,9 +6,10 @@
-
+
+
-
-
General Description
First of all,
@@ -138,16 +137,37 @@ of this process is presented in the contours section.
Contours
+This module provides a set of tools to draw different types
+of contours over the viewers of the first section. In the MVC class diagram and
+the sequence diagram to create a new contour are explained the steps necessary
+to include this functionnality into a wx-vtk scene. An example of this process
+of creation of new contours is presented in the creaContours application. It is
+important to note that the contours follow as well the same interaction system
+of the wxVtkBaseView. It means that all the contour's controllers use the
+InteractorStyleMaracas system to manage the events of the mouse and the
+keyborard in the scene. In addition, every contour controller registered in the
+wxVtkBaseView with the method AddInteractorStyleMaracas of
+vtkInteractorStyleBaseView class (see the doxygen documentation of these
+classes) will react to the mouse and keyboard events, and for this reason is
+important to have a managing system of all the interactors in the scene.
+
+Regarding the different actions that can be made using the contours, they react
+in a different way depending of the actual state of each one of them. For
+example, when any contour is into an editable state, the control points are
+visualized and can be moved, removed, etc. In brief, the actions applied to the
+contours (check the
+User Guide
+ documentation) are described as a state diagram and every contours reacts
+depending of its state.
Class diagrams
Sequence diagrams