From: Ricardo Corredor Date: Tue, 23 Mar 2010 09:16:25 +0000 (+0000) Subject: Additional description in the creaMaracasVisu Documentation X-Git-Tag: CREATOOLS.2-0-3~48 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=2e390e22a960a1a85c9bbbc5437429ecadbf37ff;p=creaMaracasVisu.git Additional description in the creaMaracasVisu Documentation --- diff --git a/lib/doxygen/DoxyMainPage.txt.in b/lib/doxygen/DoxyMainPage.txt.in index c34ebc5..306fc37 100644 --- a/lib/doxygen/DoxyMainPage.txt.in +++ b/lib/doxygen/DoxyMainPage.txt.in @@ -3,6 +3,12 @@ \htmlonly + + + + + + -

General Description

+ + + + +

General Description

First of all, creaMaracasVisu is a C++ library developed by Creatools @@ -54,7 +79,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:
@@ -72,39 +97,62 @@ 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

- Class diagrams
+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

-
   - wxVtkViewer Class Diagram 1
         - wxVtkViewer Class Diagram 2
 
-
Contours
+ +
+Contours
+

- Class diagrams

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

-
- -Sequence diagrams
+
+
+Sequence diagrams

-          +          - To create a new contour MVC @@ -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.
-
Cutter
- +
Cutter
+
- Component diagrams

-
          +
          - Cutter module components
- +
- Class diagrams

-
          - +
          - Cutter module integration
          - @@ -141,18 +187,20 @@ When a new           - Kernel

-
Plotter and data representation
+
Plotter and data representation

- -Class diagrams
-
+ +Class diagrams

          - pPlotter Class Diagram
+ + + \endhtmlonly diff --git a/lib/doxygen/TemplateHomeLibDoxygen.html b/lib/doxygen/TemplateHomeLibDoxygen.html index a947860..ba3c758 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,62 @@ 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.

- Class diagrams
+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

-
   - wxVtkViewer Class Diagram 1
         - wxVtkViewer Class Diagram 2
 
-
Contours
+ +
+Contours
+

- Class diagrams

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

-
- -Sequence diagrams
+
+
+Sequence diagrams

-          +          - To create a new contour MVC @@ -122,23 +160,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

-
          +
          - Cutter module components
- +
- Class diagrams

-
          - +
          - Cutter module integration
          - @@ -146,12 +182,11 @@ When a new           - Kernel

-
Plotter and data representation
+
Plotter and data representation

- -Class diagrams
-
+ +Class diagrams

          - pPlotter Class Diagram
diff --git a/lib/doxygen/bouml/manualContour/manualContour/129561.diagram b/lib/doxygen/bouml/manualContour/manualContour/129561.diagram index 8e4bebe..7688c49 100644 --- a/lib/doxygen/bouml/manualContour/manualContour/129561.diagram +++ b/lib/doxygen/bouml/manualContour/manualContour/129561.diagram @@ -2,61 +2,73 @@ format 67 classcanvas 128025 class_ref 129177 // manualCircleControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 80 477.1 2000 + xyz 251 476.1 2000 +end +classcanvas 128125 class_ref 141309 // InteractorStyleMaracas + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default + xyz 37 328 2010 end classcanvas 128153 class_ref 129305 // manualContour3DControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 524.7 469.8 2000 + xyz 695.7 468.8 2000 end classcanvas 128281 class_ref 129433 // manualContour3V3DControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 438.9 614.3 2000 + xyz 609.9 613.3 2000 end classcanvas 128409 class_ref 129561 // manualContour3VControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 300.2 693 2000 + xyz 471.2 692 2000 end +note 128509 "The InteractorStyle is managed by the wxVtkBaseView where the contours will be painted" + xyzwh 15 393 2000 200 64 classcanvas 128537 class_ref 129689 // manualContourBaseControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 30.6 278.3 2005 + xyz 201.6 277.3 2005 end classcanvas 128665 class_ref 129817 // manualContourControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 306.8 278.2 2000 + xyz 477.8 277.2 2000 end classcanvas 128793 class_ref 130713 // manualLineControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 83.8 419.7 2000 + xyz 254.8 418.7 2000 end classcanvas 128921 class_ref 130841 // manualContourPerpPlaneControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 119.6 565.1 2000 + xyz 290.6 564.1 2000 end classcanvas 129049 class_ref 130969 // manualRoiControler draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 85.1 363.5 2000 + xyz 256.1 362.5 2000 end -classcanvas 129177 class_ref 129945 // manualContourModel +classcanvas 129177 class_ref 129945 // manualBaseModel draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 53.3 148.4 2005 + xyz 233.3 144.4 2005 end classcanvas 129305 class_ref 131353 // manualViewBaseContour draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 254.3 149.3 2000 + xyz 429.3 114.3 2000 end classcanvas 129561 class_ref 131097 // manualView3DContour draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 750.1 472.6 2000 + xyz 921.1 471.6 2000 end note 132377 "See the Model Diagram for more information" - xyzwh 42.1 89.7 2000 160 47 + xyzwh 213.1 88.7 2000 160 47 note 132505 "See the View Diagram for more information" - xyzwh 254.8 88.1 2000 155 48 + xyzwh 615.8 144.1 2000 155 48 note 132633 "See the View Diagram for more information" - xyzwh 739.1 402.7 2000 163 47 + xyzwh 910.1 401.7 2000 163 47 classcanvas 132761 class_ref 132505 // wxVTKRenderWindowInteractor draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default show_attribute_modifiers default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_relation_modifiers default show_infonote default shadow default show_stereotype_properties default - xyz 523.1 278 2000 + xyz 694.1 277 2000 +end +relationcanvas 128253 relation_ref 128125 // + from ref 128537 z 2011 to point 107 294 + line 128381 z 2011 to ref 128125 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b end relationcanvas 129817 relation_ref 130457 // from ref 129049 z 2001 to ref 128665 @@ -64,13 +76,13 @@ relationcanvas 129817 relation_ref 130457 // no_multiplicity_a no_multiplicity_b end relationcanvas 129945 relation_ref 130585 // - from ref 128793 z 2001 to point 237 399 + from ref 128793 z 2001 to point 408 398 line 128326 z 2001 to ref 128665 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 130073 relation_ref 130713 // - from ref 128025 z 2001 to point 250 449 + from ref 128025 z 2001 to point 421 448 line 128454 z 2001 to ref 128665 no_role_a no_role_b no_multiplicity_a no_multiplicity_b @@ -106,8 +118,9 @@ relationcanvas 130841 relation_ref 131481 // no_multiplicity_a no_multiplicity_b end relationcanvas 131353 relation_ref 131737 // - from ref 128537 z 2006 to point 172 234 - line 128198 z 2006 to point 330 234 + decenter_begin 883 + from ref 128537 z 2006 to point 358 234 + line 128198 z 2006 to point 505 234 line 128070 z 2006 to ref 129305 no_role_a no_role_b no_multiplicity_a no_multiplicity_b @@ -118,13 +131,13 @@ relationcanvas 131609 relation_ref 131993 // no_multiplicity_a no_multiplicity_b end relationcanvas 131737 relation_ref 132121 // - from ref 128281 z 2001 to point 605 581 + from ref 128281 z 2001 to point 776 580 line 128838 z 2001 to ref 128153 no_role_a no_role_b no_multiplicity_a no_multiplicity_b end relationcanvas 131865 relation_ref 132249 // - from ref 128281 z 2001 to point 527 709 + from ref 128281 z 2001 to point 698 708 line 128710 z 2001 to ref 128409 no_role_a no_role_b no_multiplicity_a no_multiplicity_b @@ -135,7 +148,7 @@ relationcanvas 131993 relation_ref 132377 // no_multiplicity_a no_multiplicity_b end relationcanvas 132249 relation_ref 133785 // - from ref 128921 z 2001 to point 222 710 + from ref 128921 z 2001 to point 393 709 line 128582 z 2001 to ref 128409 no_role_a no_role_b no_multiplicity_a no_multiplicity_b @@ -145,6 +158,8 @@ relationcanvas 133017 relation_ref 134425 // no_role_a no_role_b no_multiplicity_a no_multiplicity_b end +line 128893 -_-_ + from ref 128125 z 2011 to ref 128509 line 133145 -_-_ from ref 129177 z 2006 to ref 132377 line 133273 -_-_ diff --git a/lib/doxygen/bouml/manualContour/manualContour/manualContour.prj b/lib/doxygen/bouml/manualContour/manualContour/manualContour.prj index c25c72e..a5749e3 100644 --- a/lib/doxygen/bouml/manualContour/manualContour/manualContour.prj +++ b/lib/doxygen/bouml/manualContour/manualContour/manualContour.prj @@ -1,6 +1,6 @@ format 67 "manualContour" - revision 10 + revision 12 modified_by 125 "corredor" @@ -204,6 +204,13 @@ format 67 classrelation_ref 133529 // b parent class_ref 131353 // manualViewBaseContour end + + classrelation 128125 // + relation 128125 ---|> + a public + classrelation_ref 128125 // + b parent class_ref 141309 // InteractorStyleMaracas + end end class 129817 "manualContourControler" @@ -965,6 +972,17 @@ format 67 //activity diagram settings package_name_in_tab default show_context default show_opaque_action_definition default auto_label_position default write_flow_label_horizontally default draw_all_relations default shadow default show_infonote default drawing_language default show_stereotype_properties default + class 141309 "InteractorStyleMaracas" + visibility package + cpp_decl "" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + end + class 132505 "wxVTKRenderWindowInteractor" visibility package cpp_decl "" diff --git a/lib/doxygen/bouml/manualContour/manualContour_Controler_HTML/fig129561.png b/lib/doxygen/bouml/manualContour/manualContour_Controler_HTML/fig129561.png index 4b9bd04..aaf7a5b 100644 Binary files a/lib/doxygen/bouml/manualContour/manualContour_Controler_HTML/fig129561.png and b/lib/doxygen/bouml/manualContour/manualContour_Controler_HTML/fig129561.png differ