Documentation of the wxLibrary

[bbtkGEditor.git] / lib / EditorGraphicBBS / bbsKernelEditorGraphic / GObjectModel.h

diff --git a/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GObjectModel.h b/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GObjectModel.h
index 39648f9fc3dd712ea5c20dec019e400ec93c0bee..bfebe6b05a96e4f29a62b4a484ee0899f4fe3343 100644 (file)
--- a/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GObjectModel.h
+++ b/lib/EditorGraphicBBS/bbsKernelEditorGraphic/GObjectModel.h
@@ -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