From 2c3b2ddf1ab812d3788724fd69d187112770f681 Mon Sep 17 00:00:00 2001 From: Ricardo Corredor Date: Tue, 6 Apr 2010 08:43:27 +0000 Subject: [PATCH] Changes in the main doxygen doc --- lib/doxygen/DoxyMainPage.txt.in | 35 ++++++++++++++++++++----- lib/doxygen/TemplateHomeLibDoxygen.html | 27 ++++++++++++++++--- 2 files changed, 53 insertions(+), 9 deletions(-) diff --git a/lib/doxygen/DoxyMainPage.txt.in b/lib/doxygen/DoxyMainPage.txt.in index 306fc37..0b05ae1 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

          - - MVC (Model View Controler)
+ MVC (Model View Controller)
          - Model
          - View
-          - Controler
-
+          - Controller

Sequence diagrams
@@ -198,6 +218,9 @@ When a new + + + diff --git a/lib/doxygen/TemplateHomeLibDoxygen.html b/lib/doxygen/TemplateHomeLibDoxygen.html index ba3c758..71a8490 100644 --- a/lib/doxygen/TemplateHomeLibDoxygen.html +++ b/lib/doxygen/TemplateHomeLibDoxygen.html @@ -133,16 +133,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

          - - MVC (Model View Controler)
+ MVC (Model View Controller)
          - Model
          - View
-          - Controler
-
+          - Controller

Sequence diagrams
-- 2.45.2