]> Creatis software - bbtkGEditor.git/commitdiff
Documentation of the wxLibrary
authorcorredor <>
Tue, 22 Jun 2010 09:17:29 +0000 (09:17 +0000)
committercorredor <>
Tue, 22 Jun 2010 09:17:29 +0000 (09:17 +0000)
16 files changed:
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBlackBoxModel.cxx
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBlackBoxModel.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GBoxModel.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GComplexBoxPortModel.cxx
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GComplexBoxPortModel.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GConnectorModel.cxx
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GConnectorModel.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GObjectModel.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GPortModel.cxx
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GPortModel.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/GlobalConstants.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/Observable.h
lib/EditorGraphicBBS/bbsKernelEditorGraphic/Observer.h
lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxGEditorTabPanel.cxx
lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxVtkSceneManager.cxx
lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxVtkSceneManager.h

index 4d69b64c579ed5b931e20b8ee3a05f42142de4df..6a51858a5a263142c66e8fb9b7ce4155c1ff24b9 100644 (file)
@@ -28,12 +28,14 @@ Version:   $Revision$
 *  knowledge of the CeCILL-B license and that you accept its terms.
 * ------------------------------------------------------------------------ */                                                                         
 
-/**
-*  \file 
-*  \brief Class bbtk::GBlackBox 
-*/
 
 
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
+
 #include "GBlackBoxModel.h"
 
 namespace bbtk
@@ -223,9 +225,7 @@ namespace bbtk
        }
 
        //=========================================================================
-
-
-}  // EO namespace bbtk
+}   // EO namespace bbtk
 
 // EOF
 
index a45910235a0d3fd33297bff3310c030f343be1b9..f6ad73bd883d053a4a6a45edebdbbcc6fd8317ee 100644 (file)
@@ -9,7 +9,7 @@ Version:   $Revision$
 /* ---------------------------------------------------------------------
 
 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
-* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+* Authors : Ricardo A Corredor, Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
 *
 *  This software is governed by the CeCILL-B license under French law and 
 *  abiding by the rules of distribution of free software. You can  use, 
@@ -28,17 +28,11 @@ Version:   $Revision$
 *  knowledge of the CeCILL-B license and that you accept its terms.
 * ------------------------------------------------------------------------ */                                                                         
 
-
-
-/**
-*  \file 
-*  \brief Class bbtk::GBlackBox : abstract black-box interface. 
-*/
-
-/**
-* \class bbtk::GBlackBox
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GBlackBoxModel_h__
 #define __GBlackBoxModel_h__
@@ -65,23 +59,37 @@ namespace bbtk
                GBlackBoxModel();
                ~GBlackBoxModel();
                
-               //Public methods                
+               //Public methods
+
+               // The black box has an specific package (important to search in the list with the BBTK Interpreter)
                std::string getBBTKPackage();
                void setBBTKPackage(std::string obpackage);
 
+               // Text in the status bar
                virtual std::string getStatusText();
+
+               // Method to write the information of the black box to be saved in the parameter string
                virtual void save(std::string &content);
 
+               // Is the black box executable or not
                bool isExecutable();
                void setExecutable(bool executable);
 
+               // Set 'value' to the port in position 'pos'
                void setValueToInputPort(int pos,std::string value);
+               
+               // Set 'value' to the port with name 'name'
                void setValueToInput(std::string name,std::string value);
 
+               // Get the value of the port in position 'pos'
                std::string getValueInputPort(int pos);
+
+               // Get the value of the port with name 'name'
                std::string getValueInput(std::string name);
 
+               // Get id's of the connected inputs 
                std::vector<int> getConnectedInputs();
+               // Get id's of the connected outputs
                std::vector<int> getConnectedOutputs();
 
        private:
index 05cb6bcc6d7141c98e6517a0ccda82f4a020ac4e..8c05ad7ed48f358007c49895b6e042ea68a3edaa 100644 (file)
@@ -28,17 +28,11 @@ Version:   $Revision$
 *  knowledge of the CeCILL-B license and that you accept its terms.
 * ------------------------------------------------------------------------ */                                                                         
 
-
-
-/**
-*  \file 
-*  \brief Class bbtk::GBoxModel : abstract black-box interface. 
-*/
-
-/**
-* \class bbtk::GBoxModel
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GBoxModel_h__
 #define __GBoxModel_h__
@@ -57,6 +51,7 @@ Version:   $Revision$
 namespace bbtk
 {
 
+       // Mandatory when exists a bidirectional relation: GPortModel includes GBoxModel and viceversa
        class GPortModel;
 
        class GBoxModel : public GObjectModel 
@@ -70,24 +65,35 @@ namespace bbtk
                
                //Public methods                
                virtual void setInicPoint(double& x, double& y, double& z);
+
                void addInputPort(GPortModel *inputport);
                void addOutputPort(GPortModel *outputport);
+
                int getNumInputPorts();
                int getNumOutputPorts();
+
+               // Change the position of the box and its ports
                virtual void move(double xx,double yy,double zz);
 
+               // Text in the status bar
                virtual std::string getStatusText();
+
+               // Method to write the information of the black box to be saved in the parameter string
                virtual void save(std::string &content);
 
+               // Returns a vector with inputs or outputs
                std::vector<GPortModel*> getInputPorts();
                std::vector<GPortModel*> getOutputPorts();
 
+               // Get input with the name given by parameter
                GPortModel* getInputPort(std::string name);
-               GPortModel* getOutputPort(std::string name);
-
                GPortModel* getInputPort(int pos);
-               GPortModel* getOutputPort(int pos);
 
+               // Get output with the name given by parameter
+               GPortModel* getOutputPort(std::string name);
+               GPortModel* getOutputPort(int pos);
+               
+               // Updates the position and finally the view of inputs and outputs
                void updatePorts();
 
        private:
@@ -98,6 +104,7 @@ namespace bbtk
 
        protected:
                //Protected Attributes
+
                std::vector<GPortModel*> _inputs;
                std::vector<GPortModel*> _outputs;
 
index e5a604c292f793eb6fb995e1bfa74c96c7bf418f..dc9003b3a3bf1fae5b09eeed637a062b9216c8e1 100644 (file)
@@ -28,11 +28,11 @@ Version:   $Revision$
 *  knowledge of the CeCILL-B license and that you accept its terms.
 * ------------------------------------------------------------------------ */                                                                         
 
-/**
-*  \file 
-*  \brief Class bbtk::GBlackBox 
-*/
-
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #include "GComplexBoxPortModel.h"
 
index 74703ac773619b281223e97224c431714f690a67..6a30ea444557ad77607603c84d565a9ce2326359 100644 (file)
@@ -30,15 +30,11 @@ Version:   $Revision$
 
 
 
-/**
-*  \file 
-*  \brief Class bbtk::GBlackBox : abstract black-box interface. 
-*/
-
-/**
-* \class bbtk::GBlackBox
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GComplexBoxPortModel_h__
 #define __GComplexBoxPortModel_h__
@@ -65,8 +61,10 @@ namespace bbtk
                GComplexBoxPortModel();
                ~GComplexBoxPortModel();
                
-               //Public methods        
+               //Public methods
+
                virtual void setInicPoint(double& x, double& y, double& z);
+               
                int getComplexPortType();
                void setComplexPortType(int pType);
 
@@ -76,6 +74,8 @@ namespace bbtk
        private:
 
                //Private Attributes
+
+               // According to the constants in GlobalConstants.h, the complex port can be an input or an output
                int _complexPortType;
 
                //Private Methods
index 84cc58d2e669b06db574dbffd9bd9c59306fe8cc..ebdf3715aeb5d46cc7854e77ed81c671fb2ded28 100644 (file)
@@ -82,6 +82,7 @@ namespace bbtk
 
                setFinalPoint(xCenter,yIport,zCenter);
 
+               // Sets the last point of the contour model in the position of the end input port
                manualPoint* point = _model->GetManualPoint(_model->GetSizeLstPoints()-1);
                point->SetPoint(xCenter,yIport,zCenter);
        }
@@ -124,6 +125,7 @@ namespace bbtk
                double xport,yport,zport;
                _startPort->getFinalPoint(xport,yport,zport);
 
+               // Refresh the position of the contourModel first point with the data of the connector model
                manualPoint* point = _model->GetManualPoint(0);
                point->SetPoint(xCenter,yport,zCenter);
 
@@ -131,6 +133,7 @@ namespace bbtk
                _endPort->getCenter(xCenter,yCenter,zCenter);
                _endPort->getInicPoint(xport,yport,zport);
 
+               // Refresh the position of the contourModel last point with the data of the connector model
                point = _model->GetManualPoint(_model->GetSizeLstPoints()-1);
                point->SetPoint(xCenter,yport,zCenter);
        }
@@ -152,13 +155,6 @@ namespace bbtk
 
        //=========================================================================
 
-       bool GConnectorModel::isPointInside(double x,double y, double z)//virtual
-       {
-               return false;
-       }
-
-       //=========================================================================
-
        void GConnectorModel::save(std::string &content)
        {
                content+="CONNECTION\n";
index d590b849aae30daf7553a206b15ca8ad2a35466d..9a79ad4fcc39e3d3710b81876e612ea66fa03b33 100644 (file)
@@ -29,16 +29,11 @@ Version:   $Revision$
 * ------------------------------------------------------------------------ */                                                                         
 
 
-
-/**
-*  \file 
-*  \brief Class bbtk::GConnectorModel : abstract black-box interface. 
-*/
-
-/**
-* \class bbtk::GConnectorModel
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GConnectorModel_h__
 #define __GConnectorModel_h__
@@ -67,29 +62,44 @@ namespace bbtk
                GConnectorModel();
                ~GConnectorModel();
                
-               //Public methods                
+               //Public methods
+
+               // Sets the start port of the connection that will be used in the manualContourModel
                void setStartPort(GPortModel* startPort);
+
+               // Sets the end port in the BBTKGEditor connector model and also in the contour model
                void setEndPort(GPortModel* endPort);
+
+               // Assigns the creaMaracasVisu model
                void setManualContourModel(manualContourModel* model);
+               manualContourModel* getManualContourModel();
 
                GPortModel* getStartPort();
                GPortModel* getEndPort();               
-               manualContourModel* getManualContourModel();
+
+               // Refresh the position of the contourModel first and last points with the data of the connector model
                void updateStartEndPoints();
+
+               // Set the ports as NO connected
                void disconnectConnection();
-               virtual bool isPointInside(double x,double y, double z);
+
                virtual void save(std::string &content);
                
        private:
 
-               //Attributes
+               //Private Attributes
+
                GPortModel* _startPort;
                GPortModel* _endPort;
+
                manualContourModel* _model;
 
                //Private Methods
 
        protected:
+
+               //Protected Attributes
+
                //Protected methods
                
        };
index 39648f9fc3dd712ea5c20dec019e400ec93c0bee..bfebe6b05a96e4f29a62b4a484ee0899f4fe3343 100644 (file)
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GObjectModel : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::GObjectModel
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GObjectModel_h__
 #define __GObjectModel_h__
@@ -69,29 +70,42 @@ namespace bbtk
                
                //Public methods
                
+               // Method to get the values of Inic or Final point passed as references in the parameters
                void getInicPoint(double& x, double& y, double& z);
                void getFinalPoint(double& x, double& y, double& z);
+
+               // Returns the center of the enclosing rectangle
                void getCenter(double& x, double& y, double& z);
+
+               // Method to set the values of Inic or Final point 
                virtual void setInicPoint(double& x, double& y, double& z);
                virtual void setFinalPoint(double& x, double& y, double& z);
                
+               // Changes the inic(top-left point) point of the rectangle
                virtual void move(double xx,double yy,double zz);
 
+               // Returns true if (x,y,z) is inside the rectangle 
                virtual bool isPointInside(double x,double y, double z);
 
+               // Get the type of the graphical objects (See the GlobalConstants.h file)
                int getGObjectType();
                void setGObjectType(int obtype);
 
+               // The type in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), LoadHola is the type
                std::string getBBTKType();
                void setBBTKType(std::string obtype);
-               
+
+               // The name in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), abcd is the name
                std::string getBBTKName();
                void setBBTKName(std::string obname);
 
+               // Object ID
                int getObjectId();
                void setObjectId(int id);
 
+               // Status bar message
                virtual std::string getStatusText();
+
                virtual void save(std::string &content);
                
        private:
@@ -111,10 +125,15 @@ namespace bbtk
                double _yFin;
                double _zFin;
 
-               int  _gObjectType;
                int _objectId;
 
+               // The type of the graphical objects (See the GlobalConstants.h file)
+               int  _gObjectType;
+
+               // The type in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), LoadHola is the type
                std::string _bbtkType;
+
+               // The name in BBTK, for boxes for example in a BBS line like (new LoadHola abcd), abcd is the name
                std::string _bbtkName;
 
                //Protected methods
index 69c41e3a3d550be324a31b03128a7bd1cca5161c..1d16dc16988d41150d7a499e7217cb98458cb364 100644 (file)
@@ -33,7 +33,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GPortModel 
 */
 
-
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 #include "GPortModel.h"
 
 namespace bbtk
index 474ebb3e109fe60cec33348411f498c66566d6a0..d82b8850deae461c2b2f131c37db73757d8b83d7 100644 (file)
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::GPortModel : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::GPortModel
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GPortModel_h__
 #define __GPortModel_h__
@@ -57,6 +58,7 @@ Version:   $Revision$
 namespace bbtk
 {
 
+       // Mandatory when exists a bidirectional relation: GPortModel includes GBoxModel and viceversa
        class GBoxModel;
 
        class GPortModel : public GObjectModel 
@@ -68,29 +70,48 @@ namespace bbtk
                GPortModel();
                virtual ~GPortModel();
                
-               //Public methods                
+               //Public methods
+
+               // Register the input or output in a position of the black box, depending in the portType(INPUT/OUTPUT).
                void registerInBox(GBoxModel *blackBox,int portType, int pos);
+
+               // Update the port position based in the parent box initial point
                void updatePortPosition();
+
+               // Port type (INPUT/OUTPUT)
                int getPortType();
+
                GBoxModel* getParentBox();
-               virtual std::string getStatusText();
+
+               // Returns the position of the port in the box
+               int getPosInBox();
+
                bool isConnected();
                void setConnected(bool value);
+
                bool isValueSet();
                void setValue(std::string value);
+
                std::string getValue();
+
+               virtual std::string getStatusText();
                virtual void save(std::string &content);
-               int getPosInBox();
+               
 
        private:
 
-               //Attributes
+               //Private Attributes
                
                GBoxModel *_parentBox;
-
+               
+               // Port type (INPUT/OUTPUT)
                int _portType;
+
+               // The position of the port in the box
                int _posInBox;
+
                bool _isConnected;
+
                std::string _value;
                bool _isValueSet;
 
index ce68e60aee82b185bbbc3426074e42e63251dc8e..43677d4f13b9dde22b6d40c8f4d060211c4e1eff 100644 (file)
@@ -29,13 +29,11 @@ Version:   $Revision$
 * ------------------------------------------------------------------------ */                                                                         
 
 
-
-/**
-*  \file 
-*  \brief  bbtk::GlobalConstants
-*/
-
-
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __GlobalConstants_h__
 #define __GlobalConstants_h__
@@ -151,7 +149,7 @@ namespace bbtk
        const double BOXTEXT_SELECTED_G                 =       0.35;
        const double BOXTEXT_SELECTED_B                 =       0.05;
 
-       // Id's
+       // GUI Id's
        const int ID_NEW                                                =       1000;
        const int ID_SAVE_AS_DIAGRAM                    =       1001;
        const int ID_OPEN                                               =       1002;
index 7adc257324cdefa61408c1c0d48f814a7ab40d4b..0377134cbcbd753b8519a9f2b10693a2088ee59d 100644 (file)
@@ -40,6 +40,12 @@ Version:   $Revision$
 * \brief 
 */
 
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
+
 #ifndef __Observable_h__
 #define __Observable_h__
 
@@ -69,6 +75,8 @@ namespace bbtk
                //Public methods
                void addObserver(Observer *observer);
 
+               // It is possible to notify the observers with an specific command (See GlobalConstants.h), for example, 
+               // to initialize the contour creation INIT_CREATION_CONTOUR
                void notifyObservers(int idCaller,int command=NO_COMMAND);
 
        private:
index f5c10e9bf853c2941a77c7a30b003d152b1e426b..3cb8b057e1e16c1498b07b12f5a0c89b2762de8a 100644 (file)
@@ -40,6 +40,12 @@ Version:   $Revision$
 * \brief 
 */
 
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
+
 #ifndef __Observer_h__
 #define __Observer_h__
 
@@ -59,6 +65,9 @@ namespace bbtk
                ~Observer();
                
                //Public methods
+
+               // It is possible to notify the observers with an specific command (See GlobalConstants.h), for example, 
+               // to initialize the contour creation INIT_CREATION_CONTOUR
                virtual void update(int idController,int command);
                
                
index 7b9736e259d56fb183f6a5952a1b6b9c840ee1ed..25eccdf1136519911d20d2be65c6aa2b9859ac0a 100644 (file)
@@ -69,6 +69,8 @@ printf ("EED %p ~wxGEditorTabPanel()\n" , this );
                wxVtk3DBaseView *baseview = new wxVtk3DBaseView(this);
                baseview->Configure();
                _sceneManager=new wxVtkSceneManager(this,baseview,_id);
+
+               printf("RaC-EED 21-06-2010 wxGEditorTabPanel::initWxVtkCanvas Remove the panelAUIMgr, and change to a normal sizer inside the wxGEditorTabPanel\n");
                _panelAUIMgr->AddPane((wxWindow*)baseview->GetWxVTKRenderWindowInteractor(),wxAuiPaneInfo().Fixed().CenterPane());
 //EED02JUIN2010
 
index c4f2c5d4c9432fe5edf5a42b42548c397f9ade89..dae6833dea58c02ae75a5e1959ac2fef70f076f2 100644 (file)
@@ -54,6 +54,7 @@ namespace bbtk
                if( _baseView!=NULL )
                {
 //EED02JUIN2010        
+                       printf ("RaC-EED 21-06-2010 %p wxVtkSceneManager::wxVtkSceneManager If you comment this line, the drag and drop functionnality is not initialized.\n" , this );
                        _baseView->GetWxVTKRenderWindowInteractor()->SetDropTarget((wxDropTarget*)parent);                      
                        configureBaseView();
                        _worldState=NOTHING_HAPPENS;
index 8e8a7aa67355e955380c1955a0b415dcc3d72cb6..362c677785a72ff27951672eeb086a14be508ea0 100644 (file)
@@ -170,23 +170,7 @@ namespace bbtk
                void centerView();
 
                //-------
-               //Get a collection of object ids
-               std::vector<int> getBlackBoxes();
-               std::vector<int> getConnections();
-               std::vector<int> getComplexInputPorts();
-               std::vector<int> getComplexOutputPorts();
-
-               //Get the map of selected objects (id, controller)
-               std::map<int,GObjectController*> getSelectedObjects();
-
-               //Get size of selected objects map
-               int getNumSelectedObjects();
-
-               //Complex box edition mode
-               bool isComplexBox();
-               void setComplexBox(bool val);
-
-
+               
 
        private: