]> Creatis software - creaMaracasVisu.git/blobdiff - lib/doxygen/DoxyMainPage.txt.in
#2532 creaMaracasVisu Feature New Normal - creaPanelButtonContainer All List Contain...
[creaMaracasVisu.git] / lib / doxygen / DoxyMainPage.txt.in
index 306fc377661c2c12b0a081b4ec8b4e5377ddb2ae..f49cc28d71fe0f9a390f76c1e458c3f827196392 100644 (file)
@@ -6,8 +6,36 @@
 <!-- ******************************************************************************* -->
 <!-- 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 -->
 <!-- ******************************************************************************* -->
+<!--
+# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
+#                        pour la Sant�)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+# Previous Authors : Laurent Guigues, Jean-Pierre Roux
+# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+#
+#  This software is governed by the CeCILL-B license under French law and 
+#  abiding by the rules of distribution of free software. You can  use, 
+#  modify and/ or redistribute the software under the terms of the CeCILL-B 
+#  license as circulated by CEA, CNRS and INRIA at the following URL 
+#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+#  or in the file LICENSE.txt.
+#
+#  As a counterpart to the access to the source code and  rights to copy,
+#  modify and redistribute granted by the license, users are provided only
+#  with a limited warranty  and the software's author,  the holder of the
+#  economic rights,  and the successive licensors  have only  limited
+#  liability. 
+#
+#  The fact that you are presently reading this means that you have had
+#  knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------ */ 
+
+-->
+
 
 <style type="text/css">
 .titles {
@@ -63,9 +91,7 @@ color:#1A41A8;
        text-align: center;
 }
 </style>
-</head>
 
-<body>
 
 <H2 class="style4">General Description</H2>
 <H2><span class="text">First of all, <strong> 
@@ -88,6 +114,9 @@ used in specific contexts. The principal components are the following:<br />
 - <a class="el" href="#Contours">Contours</a><br />
 - <a class="el" href="#Cutter">Cutter Module</a><br />
 - <a class="el" href="#Plotter">Plotter and Data Representation</a><br />
+- <a class="el" href="#ManualPaint">Manual Paint</a><br />
+- <a class="el" href="#ThresholdImageView">Threshold Image View</a><br />
+- <a class="el" href="#ButtonContainer">Button Container</a><br />
 
 <br />
 The relationship among this set of elements is described in the following 
@@ -138,16 +167,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 />
@@ -187,16 +237,51 @@ When a new
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134781.png" class="el">- 
        Kernel</a></div>
 <br />
+
+
+
 <hr /><span class="style3"><a name="Plotter"></a>Plotter and data representation</span><br>
+<br />
+<span class="listDiagrams">Class diagrams</span><br class="style1" />
+<br />
+<div class="text">
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
+</div>
 
+
+<hr /><span class="style3"><a name="ManualPaint"></a>Manual Paint</span><br>
+<br />
+<span class="listDiagrams">Class diagrams</span><br class="style1" />
 <br />
+<div class="text">
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../ManualPaint_html/index.html" class="el">- Manual Paint Class Diagram</a> <br>
+</div>
 
+<hr /><span class="style3"><a name="ThresholdImageView"></a>Threshold Image View</span><br>
+<br />
 <span class="listDiagrams">Class diagrams</span><br class="style1" />
 <br />
 <div class="text">
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../pPlotter_HTML/index.html" class="el">- pPlotter Class Diagram</a> <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../ThresholdImageView_html/index.html" class="el">- Threshold Image View Class Diagram</a> <br>
+</div>
+
+
+<hr /><span class="style3"><a name="ButtonContainer"></a>Button Container</span><br>
+<br />
+<span class="listDiagrams">Class diagrams</span><br class="style1" />
+<br />
+<div class="text">
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../ButtonContainerModify_HTML/fig128255.png" class="el">- Button Container Class Diagram</a> <br>
 </div>
 
+<br />
+<span class="listDiagrams">Sequence diagrams<br />
+<br />
+</strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+       - 
+<a href="../ButtonContainerModify_HTML/fig134783.png" class="el"> Create List
+        </a>
+</div>
 
 <!-- ******************************************************************************* -->
 <!--         End HTML Code         -->
@@ -205,4 +290,5 @@ When a new
 \endhtmlonly
 
          
- */
\ No newline at end of file
+ */
+