]> Creatis software - creaMaracasVisu.git/blobdiff - lib/doxygen/DoxyMainPage.txt.in
Additional description in the creaMaracasVisu Documentation
[creaMaracasVisu.git] / lib / doxygen / DoxyMainPage.txt.in
index c34ebc5fbfe6dbd32c0d3a46fea99cb4adacbe10..306fc377661c2c12b0a081b4ec8b4e5377ddb2ae 100644 (file)
@@ -3,6 +3,12 @@
 
 \htmlonly 
 
+<!-- ******************************************************************************* -->
+<!-- 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 -->
+<!-- ******************************************************************************* -->
+
 <style type="text/css">
 .titles {
        font-family: Geneva, Arial, Helvetica, sans-serif;
@@ -32,6 +38,7 @@ color:#1A41A8;
        font-family: Geneva, Arial, Helvetica, sans-serif;
        margin-left: 25px;
        font-size: small;
+       font-weight: bold;
 }
 .paragraph {
        margin-left: 40px;
@@ -40,9 +47,27 @@ color:#1A41A8;
 }
 .style1 {
        text-decoration: underline;
+       font-weight: bold;
+}
+.style3 {
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       font-size: 21px;
+       text-decoration: underline;
+       text-align: justify;
+}
+.style4 {
+       font-family: Geneva, Arial, Helvetica, sans-serif;
+       color: #000000;
+       font-size: x-large;
+       font-weight: bold;
+       text-align: center;
 }
 </style>
-<H2 class="titles">General Description</H2>
+</head>
+
+<body>
+
+<H2 class="style4">General Description</H2>
 <H2><span class="text">First of all, <strong> 
 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a></strong> is a C++ library developed by 
 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/creatools">Creatools</a> 
@@ -54,7 +79,7 @@ software team and it follows the general architecture of Creatools architecture
 images and the interaction with them. </span></H2>
 <hr />
 
-<H2 class="titles">&nbsp;Architecture Description</H2>
+<H2 class="style4">&nbsp;Architecture Description</H2>
 <H2><span class="text">The core of the library is divided into 
 different modules, and each one provides a list of diferent functionalities that can be 
 used in specific contexts. The principal components are the following:<br />
@@ -72,39 +97,62 @@ diagram :<br />
 <a class="el" href="../GeneralArchitecture_HTML/index.html">Architecture Diagram</a></span></H2>
 <hr />
 
-<H2 class="titles">&nbsp;Modules Description</H2>
+<H2 class="style4">&nbsp;Modules Description</H2>
 <p class="text">In this section are presented the corresponding diagrams for 
 each model in <span class="text"> <strong> 
 <a class="el" href="http://www.creatis.insa-lyon.fr/site/fr/CreatoolsBBTKPackageCreaMaracasVisuUserInteractionDescription">creaMaracasVisu</a> </strong> </span>
 library including classes, components and sequence diagrams, as well as a short 
 description of the module of interest.</p>
-<span class="subtitles"><a name="ViewersInteractors"></a>Viewers and interactors</span><br />
+
+
+
+<a name="ViewersInteractors"></a>
+<div class="style3">
+       <br />
+               Viewers and interactors</div>
 <br />
-&nbsp;<span class="listDiagrams"><strong><span class="style1">Class diagrams</span><br />
+<span class="text">This module provides a set of classes that manage the 
+visualization and the interaction with images. For example, the black box 
+ViewerNV is constructed using these classes and it provides the possibility to 
+use different viewers depending of the context. For example, to manage an image 
+3D is useful to use the wxVtk3DBaseBiew and to control a 2D image it is possible 
+to use wxVtk2DBaseView. It is important to note that these viewers make the 
+connection between a wxWindow and a vtkRenderWindow, in order to include the 
+world VTK in any application implemented with wxWidgets.<br />
+<br />
+Another important point to keep in mind is that all the wxVtkBaseView instances 
+have a manager of its interactor styles. These interactors describe how the 
+events are handled and how the actual mechanism respond to the interaction 
+callbacks. Every new instance of InteractorStyleMaracas class can be added to 
+the wxBaseView in order to manage all the events made over an object. An example 
+of this process is presented in the contours section.</span><br />
+<br />
+<span class="listDiagrams">Class diagrams</span><br />
 <br />
-</strong></span><br />
 <span class="listDiagrams">&nbsp;&nbsp;
 <a href="../wxVtkViewer_classDiagram1_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 1</a><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <a href="../wxVtkViewer_classDiagram2_HTML/index.html" class="el"> - wxVtkViewer Class Diagram 2</a></span><br />
 &nbsp;<br>
-<hr /><span class="subtitles"><a name="Contours"></a>Contours<br />
+
+<hr /><span class="subtitles"><a name="Contours"></a></span>
+<span class="style3">Contours</span><br />
+<br />
 <br />
-<strong>
 <span class="listDiagrams">Class diagrams<br />
 <br />
-</span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+</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>
 &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 />
-</div><span class="subtitles">
-<strong>
-<span class="listDiagrams">Sequence diagrams<br />
+</div>
+<br />
+<span class="listDiagrams">Sequence diagrams</span><br />
 <br />
-</span></strong></span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
        - 
 <a class="el" href="../manualContour_SeqCreateContour_HTML/index.html">To create a new 
        contour MVC</a> 
@@ -117,23 +165,21 @@ When a new
        (Controller uses View and Model, and View has relation with the model), it 
        is necessary to say the viewer where it will be managed. The specific 
        methods to do this task are in the diagram.</div><br />
-<hr /><span class="subtitles"><a name="Cutter"></a>Cutter</span><br>
-<span class="subtitles">
+<hr /><span class="style3"><a name="Cutter"></a>Cutter</span><br>
+
 <br />
-<strong>
 <span class="listDiagrams">Component diagrams<br />
 <br />
-</span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
+</strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
        - 
 <a href="../CutModuleDiagrams_HTML/index.html" class="el"> Cutter module 
        components </a>
 </div>
-<span class="subtitles">
+
 <br />
-<strong>
 <span class="listDiagrams">Class diagrams<br />
 <br />
-</span></strong></span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -
+</span><div class="text">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -
        <a href="../CutModuleDiagrams_HTML/fig141309.png" class="el"> Cutter module 
        integration </a> <br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="../CutModuleDiagrams_HTML/fig134653.png" class="el">- 
@@ -141,18 +187,20 @@ 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="subtitles"><a name="Plotter"></a>Plotter and data representation</span><br>
+<hr /><span class="style3"><a name="Plotter"></a>Plotter and data representation</span><br>
 
 <br />
-<strong>
-<span class="listDiagrams"><span class="style1">Class diagrams</span><br class="style1" />
-</span></strong><span class="style1"></span></span><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>
 
 
+<!-- ******************************************************************************* -->
+<!--         End HTML Code         -->
+<!-- ******************************************************************************* -->
 
 \endhtmlonly