Documentation of the vtkLibrary

[bbtkGEditor.git] / lib / EditorGraphicBBS / bbsVtkGUIEditorGraphic / vtkGObjectView.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