Documentation of the vtkLibrary

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBlackBoxController.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBlackBoxController.h
index 39f8274ddff6910fee21801015024795dd3c882f..5a97e90f02b7a012e261f4382adfd3f96977df91 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBlackBoxController.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBlackBoxController.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GBlackBoxController : 
 */
 
-/**
-* \class bbtk::GBlackBoxController
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GBlackBoxController_h__
 #define __GBlackBoxController_h__
@@ -77,6 +78,8 @@ namespace bbtk
                //Private Methods
 
        protected:
+
+               // Methods from InteractorStyleMaracas
                virtual bool  OnMouseMove();
                virtual bool  OnLeftButtonDown(); 
                virtual bool  OnLeftButtonUp();

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBoxController.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBoxController.h
index 80826684acfdb66e3a76152b31f0a8d8ae997e43..ec875627e91fe32b555d61b336e8d74ac9916fb7 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBoxController.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GBoxController.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GBoxController : 
 */
 
-/**
-* \class bbtk::GBoxController
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GBoxController_h__
 #define __GBoxController_h__
@@ -77,6 +78,8 @@ namespace bbtk
                //Private Methods
 
        protected:
+
+               // Methods from InteractorStyleMaracas
                virtual bool  OnMouseMove();
                virtual bool  OnLeftButtonDown(); 
                virtual bool  OnLeftButtonUp();

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GConnectorController.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GConnectorController.h
index 00aeb03258a2d4d85a6d20e7c0e98765986d7122..679c3ce017ab6253665d794776a192e03c53fbaf 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GConnectorController.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GConnectorController.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GConnectorController : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::GConnectorController
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GConnectorController_h__
 #define __GConnectorController_h__
@@ -67,7 +68,9 @@ namespace bbtk
                GConnectorController();
                ~GConnectorController();
                
-               //Public methods                
+               //Public methods
+
+               // Methods from InteractorStyleMaracas
                virtual bool  OnMouseMove();
                virtual bool  OnLeftButtonDown(); 
                virtual bool  OnLeftButtonUp();
@@ -77,15 +80,20 @@ namespace bbtk
                virtual bool  OnMiddleButtonDown();
                virtual bool  OnMiddleButtonUp();
 
+               // Implementation of the creaMaracasVisu controller
                manualConnectorContourController* getManualContourController();
                void setManualContourController(manualConnectorContourController* controller);
 
                virtual void removeFromScene();
+
+               // Reports the end in the contour creation
                void endContourCreation();
 
        private:
 
                //Attributes
+
+               // Implementation of the creaMaracasVisu contour (manualContourControler) controller
                manualConnectorContourController* _controller;
 
                //Private Methods

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GObjectController.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GObjectController.h
index 915ffc8cd2215636465397459c148a8265040cef..519248c57b26288721802c8288fb1aed6757a4d1 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GObjectController.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GObjectController.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GObjectController : 
 */
 
-/**
-* \class bbtk::GObjectController
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GObjectController_h__
 #define __GObjectController_h__
@@ -69,11 +70,16 @@ namespace bbtk
                //Public methods
 
                void setModelAndView(GObjectModel* model, vtkGObjectView* view);
+
+               // Same type of the saved in the model of the graphical objects
                int getGObjectType();
+
                GObjectModel* getModel();
                vtkGObjectView* getView();
+
                std::string getStatusText();
 
+               // Same ObjectID from the model
                int getId();
                void setId(int id);
                
@@ -90,11 +96,15 @@ namespace bbtk
        protected:
 
                //Protected Attributes 
+
                GObjectModel* _model;
                vtkGObjectView* _view;
+
                bool _isLeftClickDown;
 
                //Protected Methods
+
+               // Methods from InteractorStyleMaracas
                virtual bool  OnMouseMove();
                virtual bool  OnLeftButtonDown(); 
                virtual bool  OnLeftButtonUp();
@@ -103,8 +113,6 @@ namespace bbtk
 
                virtual void moveObject(int X,int Y);
 
-
-
        };
 
 

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GPortController.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GPortController.h
index e3911b1d988586ff19f60653ca84e47218f05a69..86cee210457479914c5e68af9fb622d049e835d0 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GPortController.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/GPortController.h
@@ -35,10 +35,12 @@ Version:   $Revision$
 *  \brief Class bbtk::GPortController : 
 */
 
-/**
-* \class bbtk::GPortController
-* \brief 
-*/
+
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GPortController_h__
 #define __GPortController_h__

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourController.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourController.h
index f7919a45893d1f86585ce4c34f3f0a3f76a48ab5..fd309276e588c1df2f3db7f756802ef266efbb0d 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourController.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourController.h
@@ -35,10 +35,12 @@ Version:   $Revision$
 *  \brief Class bbtk::manualConnectorContourController : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::manualConnectorContourController
-* \brief 
-*/
+
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __manualConnectorContourController_h__
 #define __manualConnectorContourController_h__

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.cxx b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.cxx
index 6fb868581188b0391d8eb385c434df33829f24a3..e5b4a422f6413ea1a5fe43bc47beae711034a5de 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.cxx
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.cxx
@@ -41,18 +41,22 @@ namespace bbtk
 
 
        //=========================================================================
+
        manualConnectorContourView::manualConnectorContourView()
        {
        }
 
        //=========================================================================
+
        manualConnectorContourView::~manualConnectorContourView()
        {
        }
+
        //=========================================================================
 
        void manualConnectorContourView::TransfromCoordViewWorld(double &X, double &Y, double &Z, int type)
        {
+               // Make the conversion using the system of creaMaracasVisu
                _wxvtkbaseview->TransCoordScreenToWorld(X,Y,Z,type);
        }
 
@@ -60,6 +64,7 @@ namespace bbtk
 
        void manualConnectorContourView::updateStartAndEnd(double* start , double* end)
        {
+               // Update contour first and last point
                _manContModel->MovePoint(0,start[0],start[1],start[2]);
                _manContModel->MovePoint(_manContModel->GetSizeLstPoints()-1,end[0],end[1],end[2]);
                
@@ -75,6 +80,7 @@ namespace bbtk
                 if( _viewControlPoints )
                 {
                        int i,size=_lstViewPoints.size();
+                       //The first and last points are avoided
                        for (i=1;i<size-1; i++)
                        {
                                vtkActor * pointActor = _lstViewPoints[i]->GetVtkActor();
@@ -87,7 +93,7 @@ namespace bbtk
 
        void manualConnectorContourView::RefreshText()  // virtual
        {
-
+               // The text that goes with the contour is not shown
        }
 
 

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.h
index 7ef4521ab093724fed48062ff0229fb3c6893fb9..c1bf17897787fe4b07f85e516547ea8bb4c4f5f7 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/manualConnectorContourView.h
@@ -35,10 +35,12 @@ Version:   $Revision$
 *  \brief Class bbtk::manualConnectorContourView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::manualConnectorContourView
-* \brief 
-*/
+
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __manualConnectorContourView_h__
 #define __manualConnectorContourView_h__
@@ -65,10 +67,14 @@ namespace bbtk
                manualConnectorContourView();
                ~manualConnectorContourView();
                
-               //Public methods                
+               //Public methods
+
                virtual void TransfromCoordViewWorld(double &X, double &Y, double &Z, int type=2);
+               
                void updateStartAndEnd(double* start , double* end);
+               
                virtual void AddControlPoints();
+                               
                virtual void RefreshText();
 
        private:

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBlackBoxView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBlackBoxView.h
index 90494d9ac3976b2ce1130eedd6febb16e33f29de..b17f19dbeca1e6274d8734885ef7f15d41f3a7ab 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBlackBoxView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBlackBoxView.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::vtkGBlackBoxView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::vtkGBlackBoxView
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __vtkGBlackBoxView_h__
 #define __vtkGBlackBoxView_h__
@@ -98,6 +99,7 @@ namespace bbtk
                virtual void addVtkActors();
                virtual void removeVtkActors();
                virtual void createVtkObjects();
+
                virtual void update(int idController,int command);
                virtual void updateColors();
        };

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBoxView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBoxView.h
index 268ec9a3bea0a725e3ea4f8238a7b4448924762b..ea1de60851f039a54c8489b7d49a0332e905260a 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBoxView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGBoxView.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::vtkGBoxView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::vtkGBoxView
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __vtkGBoxView_h__
 #define __vtkGBoxView_h__
@@ -96,6 +97,7 @@ namespace bbtk
                virtual void addVtkActors();
                virtual void removeVtkActors();
                virtual void createVtkObjects();
+
                virtual void update(int idController,int command);
                virtual void updateColors();
                void updatePorts();

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGComplexBoxPortView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGComplexBoxPortView.h
index aa08812a26d76e4d05e7ca69162f1fa896b1b56f..0b9ce1a0fd1c7aec89c5a639eb47fbef0ce6a13b 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGComplexBoxPortView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGComplexBoxPortView.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::vtkGComplexBoxPortView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::vtkGComplexBoxPortView
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __vtkGComplexBoxPortView_h__
 #define __vtkGComplexBoxPortView_h__
@@ -93,6 +94,7 @@ namespace bbtk
                virtual void addVtkActors();
                virtual void removeVtkActors();
                virtual void createVtkObjects();
+
                virtual void update(int idController,int command);
                virtual void updateColors();
        };

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGConnectorView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGConnectorView.h
index 7f4cc1888784e1948fb7e65f19399489aba1fefd..f80334fd34a1fcb73dd898c1030503290101c7a5 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGConnectorView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGConnectorView.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::vtkGConnectorView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::vtkGConnectorView
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __vtkGConnectorView_h__
 #define __vtkGConnectorView_h__

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGObjectView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGObjectView.h
index 5c42d0e7e791a7c9491538f2fbb7a1c3829a0b3b..f502df6232e3f1c712fa439329de352c69b07f38 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGObjectView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGObjectView.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::vtkGObjectView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::vtkGObjectView
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __vtkGObjectView_h__
 #define __vtkGObjectView_h__
@@ -76,26 +77,32 @@ namespace bbtk
                ~vtkGObjectView();
                
                //Public methods
+
                void setModel(GObjectModel *model);
                void setBaseView(wxVtkBaseView* baseView);
                void initVtkObjects();
                
-               virtual bool isPointInside(int X,int Y);
-               virtual void moveObject(int X, int Y);
-
-               virtual void update(int idController,int command);
                void setStartDragging(bool param);
 
                void setState(int state);
                int getState();
+
+               // Method to force a vtk refresh to the list of controllers of the wxVtkBaseView
                void setRefreshWaiting();
+               
+               virtual bool isPointInside(int X,int Y);
+               virtual void moveObject(int X, int Y);
 
                virtual void removeFromScene();
 
+               virtual void update(int idController,int command);              
+               
        private:
 
                //Private Attributes
                bool _isStartDragging;
+
+               //Makes a difference between the first point clicked and the new position, in order to move the selected objects
                double dragDifX;
                double dragDifY;
 
@@ -105,13 +112,20 @@ namespace bbtk
        protected:
 
                //Protected Attributes
+               
                wxVtkBaseView *_baseView;
+
                GObjectModel *_model;
+
                vtkActor *_borderObjectActor;
                vtkActor *_fillObjectActor;
+
                vtkPolyDataMapper* _fillPolyMapper;
                vtkPolyDataMapper* _borderPolyMapper;
+
                vtkPoints *_pts;
+
+               // State of the object (See GlobalConstants.h)
                int  _state;
                
                //Protected Methods

diff --git a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGPortView.h b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGPortView.h
index 2c854c6eddbf0becabe68aa89e2b4dd59e438aef..cb1734a7741a23034bfa3a71d7cd97433f3c60c3 100644 (file)
--- a/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGPortView.h
+++ b/lib/EditorGraphicBBS/bbsVtkGUIEditorGraphic/vtkGPortView.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::vtkGPortView : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::vtkGPortView
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __vtkGPortView_h__
 #define __vtkGPortView_h__