X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2Fdoxygen%2FTemplateHomeLibDoxygen.html;h=71a8490539b62450f41d2fc408cad0beddf4c836;hb=e5dd3702826e57ae15d40b8cda521e8ae17d5c57;hp=a94786092abef6912aa05c3bab553108046b6c5d;hpb=96facb2168314bc57826afc4342abd43e27f0ff7;p=creaMaracasVisu.git
diff --git a/lib/doxygen/TemplateHomeLibDoxygen.html b/lib/doxygen/TemplateHomeLibDoxygen.html
index a947860..71a8490 100644
--- a/lib/doxygen/TemplateHomeLibDoxygen.html
+++ b/lib/doxygen/TemplateHomeLibDoxygen.html
@@ -33,6 +33,7 @@ color:#1A41A8;
font-family: Geneva, Arial, Helvetica, sans-serif;
margin-left: 25px;
font-size: small;
+ font-weight: bold;
}
.paragraph {
margin-left: 40px;
@@ -41,13 +42,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;
}
-General Description
+General Description
First of all,
creaMaracasVisu is a C++ library developed by
Creatools
@@ -59,7 +74,7 @@ software team and it follows the general architecture of Creatools architecture
images and the interaction with them.
- Architecture Description
+ Architecture Description
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:
@@ -77,39 +92,83 @@ diagram :
Architecture Diagram
- Modules Description
+ Modules Description
In this section are presented the corresponding diagrams for
each model in
creaMaracasVisu
library including classes, components and sequence diagrams, as well as a short
description of the module of interest.
-Viewers and interactors
+
+
+
+
+
+
+ Viewers and interactors
+
+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.
+
+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.
- Class diagrams
+Class diagrams
-
- wxVtkViewer Class Diagram 1
- wxVtkViewer Class Diagram 2
-
Contours
+
+
+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
+ - Controller
+
+Sequence diagrams
-
+
-
To create a new
contour MVC
@@ -122,23 +181,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.
-
Cutter
-
+
Cutter
+
-
Component diagrams
-
+
-
+
-
Class diagrams
- -
+
-
Plotter and data representation
+
Plotter and data representation
-
-Class diagrams
-
+
+
Class diagrams
