]> Creatis software - creaMaracasVisu.git/commitdiff
Changes in the main doxygen doc
authorRicardo Corredor <Ricardo.Corredor@creatis.insa-lyon.fr>
Tue, 6 Apr 2010 08:43:27 +0000 (08:43 +0000)
committerRicardo Corredor <Ricardo.Corredor@creatis.insa-lyon.fr>
Tue, 6 Apr 2010 08:43:27 +0000 (08:43 +0000)
lib/doxygen/DoxyMainPage.txt.in
lib/doxygen/TemplateHomeLibDoxygen.html

index 306fc377661c2c12b0a081b4ec8b4e5377ddb2ae..0b05ae129d0a6df01d439ffbce72a6135ede19c7 100644 (file)
@@ -6,9 +6,10 @@
 <!-- ******************************************************************************* -->
 <!-- Paste here the new code HTML for the main page of creaMaracasVisu documentation -->
 <!-- It is possible to use the file TemplateHomeLibDoxygen.html to edit easily -->
-<!-- but don't forget to delete head and body tags. RaC -->
+<!-- but don't forget to delete head and body open tags. RaC -->
 <!-- ******************************************************************************* -->
 
+
 <style type="text/css">
 .titles {
        font-family: Geneva, Arial, Helvetica, sans-serif;
@@ -63,9 +64,7 @@ color:#1A41A8;
        text-align: center;
 }
 </style>
-</head>
 
-<body>
 
 <H2 class="style4">General Description</H2>
 <H2><span class="text">First of all, <strong> 
@@ -138,16 +137,37 @@ of this process is presented in the contours section.</span><br />
 <hr /><span class="subtitles"><a name="Contours"></a></span>
 <span class="style3">Contours</span><br />
 <br />
+<span class="text">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&#39;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.<br />
+<br />
+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 <span class="text"> <strong> 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaMaracasVisuUserGuide#Contours">User Guide</a> </strong> </span>
+ documentation) are described as a state diagram and every contours reacts 
+depending of its state.</span><br />
 <br />
 <span class="listDiagrams">Class diagrams<br />
 <br />
 </strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
        - 
-<a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controler)</a> <br>
+<a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controller)</a> <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controler</a><br />
-       <br />
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controller</a><br />
 </div>
 <br />
 <span class="listDiagrams">Sequence diagrams</span><br />
@@ -198,6 +218,9 @@ When a new
 </div>
 
 
+
+
+
 <!-- ******************************************************************************* -->
 <!--         End HTML Code         -->
 <!-- ******************************************************************************* -->
index ba3c7586b6c4361bea9f5aa32065750ddf788a20..71a8490539b62450f41d2fc408cad0beddf4c836 100644 (file)
@@ -133,16 +133,37 @@ of this process is presented in the contours section.</span><br />
 <hr /><span class="subtitles"><a name="Contours"></a></span>
 <span class="style3">Contours</span><br />
 <br />
+<span class="text">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&#39;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.<br />
+<br />
+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 <span class="text"> <strong> 
+<a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreaMaracasVisuUserGuide#Contours">User Guide</a> </strong> </span>
+ documentation) are described as a state diagram and every contours reacts 
+depending of its state.</span><br />
 <br />
 <span class="listDiagrams">Class diagrams<br />
 <br />
 </strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
        - 
-<a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controler)</a> <br>
+<a href="../manualContour_MVC_HTML/index.html" class="el"> MVC (Model View Controller)</a> <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Model_HTML/index.html" class="el">- Model</a> <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_View_HTML/index.html" class="el">- View</a> <br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controler</a><br />
-       <br />
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../manualContour_Controler_HTML/index.html" class="el">- Controller</a><br />
 </div>
 <br />
 <span class="listDiagrams">Sequence diagrams</span><br />