X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FEditorGraphicBBS%2FbbsWxGUIEditorGraphic%2FwxGEditorTabPanel.h;h=0f3b3bf3d1fbbdfc92089da6d0567a4626231fbd;hb=8c6d29c9d753d55b8bc04e9ff95d0617ded15f13;hp=336552366fddcd5604a0a54990b4bf8a6a887c21;hpb=66d85963bdb3dea88f7d8e8931855d092629b37c;p=bbtkGEditor.git

diff --git a/lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxGEditorTabPanel.h b/lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxGEditorTabPanel.h
index 3365523..0f3b3bf 100644
--- a/lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxGEditorTabPanel.h
+++ b/lib/EditorGraphicBBS/bbsWxGUIEditorGraphic/wxGEditorTabPanel.h
@@ -35,10 +35,11 @@ Version:   $Revision$
 *  \brief Class bbtk::BlackBox : abstract black-box interface. 
 */
 
-/**
-* \class bbtk::wxGEditorTabPanel
-* \brief 
-*/
+/****
+* Design and Developpement of BBTK GEditor
+* Ricardo A Corredor J <ra.corredor67@uniandes.edu.co>
+* RaC - 2010
+****/
 
 #ifndef __wxGEditorTabPanel_h__
 #define __wxGEditorTabPanel_h__
@@ -71,11 +72,12 @@ namespace bbtk
 	};
 
 
-
+	//RaC: It is important if it exists a double relation 
+	//e.g. wxGEditorTabPanel includes wxVtkSceneManager, and wxVtkSceneManager includes wxGEditorTabPanel
 	class wxVtkSceneManager;
-
 	class wxTabPanelsManager;
 
+	// RaC Be careful with the double heritance
 	class wxGEditorTabPanel :  public wxPanel, public wxTextDropTarget
 	{
 	public: 
@@ -84,36 +86,65 @@ namespace bbtk
 		~wxGEditorTabPanel();
 
 		void initWxVtkCanvas();
-		virtual bool OnDropText(wxCoord x, wxCoord y, const wxString& data);
+		
+		// Sets the parent manager
 		void setPanelsManager(wxTabPanelsManager* panelsManager);
 
-		void displayBlackBoxInfo(std::string packageName, std::string boxName);
-		void updateStatusBar(std::string textStatus);
+		// Get the BBS script of the pipeline diagram included in the panel
 		std::string getDiagramBBS();
+
+		// Saves the actual BBS as complex box
+		// RaC TOFIX It must be included the package of the complex box
 		std::string saveComplexBoxBBS(std::string cbName,std::string cbAuthor="",std::string cbCategory="",std::string cbDescription="");
+
+		// Shows the dialog to edit black box parameters
 		void editBlackBox(GBlackBoxModel *bbmodel);
-		void editDiagramParameters(wxVtkSceneManager* scene);
-		void deleteAllBoxes();
-		void centerView();
+
+		// Save diagram as BBG
 		void saveDiagram(std::string &content);
+		
+		// Load BBG diagram
 		void loadDiagram(ifstream &inputStream);
+
+		// Add a new complex input object to the scene
+		void addComplexInputPort(std::string portName);
+
+		// Add a new complex output object to the scene
+		void addComplexOutputPort(std::string portName);
+
+		// Delete all boxes in the diagram
+		void deleteAllBoxes();
+
+		// Center the camera in the initial position
+		void centerView();
+
+		// Display feedback info in the GUI
+		void displayBlackBoxInfo(std::string packageName, std::string boxName);
+		void updateStatusBar(std::string textStatus);
+
 		int getPanelId();
 		bool isComplexBox();
 		void setComplexBox(bool val);
-		void addComplexInputPort(std::string portName);
-		void addComplexOutputPort(std::string portName);
+
+		// Returns a map with the id,controller of all the objects selected		
 		std::map<int,GObjectController*> getSelectedObjects();
+
 		void addObjects(std::map<int,GObjectController*> objectsMap);
 		int getNumSelectedObjects();
 
+		// Receives the string from a drag and drop source as for example the BBTK Package Browser
+		virtual bool OnDropText(wxCoord x, wxCoord y, const wxString& data);
+
+		
+		wxVtkSceneManager* getSceneManager();
 	//=========================================================================
 		
 	private:
 
-		int _id;
-		wxAuiManager *_panelAUIMgr;
-		wxVtkSceneManager *_sceneManager;
-		wxTabPanelsManager* _panelsManager;
+		int						_id;
+		wxAuiManager			*_panelAUIMgr;
+		wxVtkSceneManager		*_sceneManager;
+		wxTabPanelsManager		* _panelsManager;
 
 	protected: