Menu
▾
▴
wxmodeler-svn — SVN commit mailing list
You can subscribe to this list here.
| 2007 |
Jan
|
Feb
|
Mar
(2) |
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
|---|
|
From: <dar...@us...> - 2007-03-18 12:04:36
|
Revision: 39
http://wxmodeler.svn.sourceforge.net/wxmodeler/?rev=39&view=rev
Author: darkdevil_38
Date: 2007-03-17 02:44:37 -0700 (Sat, 17 Mar 2007)
Log Message:
-----------
Initial release of a scons script for wxmodeler building purposes
Next to come : Visual support
Added Paths:
-----------
trunk/wxModeler/SConstruct
trunk/wxModeler/src/SConscript
Added: trunk/wxModeler/SConstruct
===================================================================
--- trunk/wxModeler/SConstruct (rev 0)
+++ trunk/wxModeler/SConstruct 2007-03-17 09:44:37 UTC (rev 39)
@@ -0,0 +1,118 @@
+##################################################
+# File : SConstruct
+# Date : 17/03/2007
+# Author : Philippe Poupardin
+# Scons script for wxmodeler project
+#
+# Initial release tested on linux and with
+# wxWidgets-2.8
+##################################################
+
+import sys
+
+##################################################
+# Definitions...
+
+# Some files
+BINARYFILE = 'wxmodeler'
+SOURCEFILES = [
+ 'AboutBox.cpp',
+ 'Application.cpp',
+ 'Color.cpp',
+ 'Configuration.cpp',
+ 'GraphicCtrl.cpp',
+ 'GraphicGLCtrl.cpp',
+ 'GraphicItem.cpp',
+ 'GraphicTool.cpp',
+ 'Language.cpp',
+ 'MainFrame.cpp',
+ 'ToolBezier.cpp',
+ 'ToolBox.cpp',
+ 'ToolPoint.cpp',
+ 'ToolPolygon.cpp',
+ 'ToolSegment.cpp',
+ 'Trackball.cpp'
+ ];
+
+# Some paths
+BINARYLOCALPATH = '#bin'
+INCLUDELOCALPATH = '#include'
+OBJECTLOCALPATH = '#obj'
+SOURCELOCALPATH = '#src'
+
+# The system on which we are running
+PLATFORM = sys.platform
+
+# Headers required for compilation
+HEADERSSYSTEM = [
+ 'cmath',
+ 'math.h'
+ ];
+
+##################################################
+
+if ARGUMENTS.get('debug', 0):
+ CCFLAGS = '-g'
+else:
+ CCFLAGS = []
+
+##################################################
+# We fetch...
+
+# ... our initial environment variables...
+env = Environment()
+
+# ... some tests for dependances
+conf = Configure(env)
+isdependancesok = True
+for header in HEADERSSYSTEM:
+ if not conf.CheckCXXHeader(header):
+ print 'Did not find '+header+' header !'
+ isdependancesok = False
+if not isdependancesok:
+ print 'A dependance is missing !'
+ Exit(1)
+env = conf.Finish()
+
+env.Append(BINARYFILE = [BINARYFILE])
+env.Append(SOURCEFILES = SOURCEFILES)
+env.Append(BINARYLOCALPATH = [BINARYLOCALPATH])
+env.Append(INCLUDELOCALPATH = [INCLUDELOCALPATH])
+env.Append(OBJECTLOCALPATH = [OBJECTLOCALPATH])
+env.Append(SOURCELOCALPATH = [SOURCELOCALPATH])
+env.Append(PLATFORM = [PLATFORM])
+
+# ... the configuration needed to compile wx applications...
+env.ParseConfig('wx-config --cflags --libs gl adv core base')
+
+##################################################
+
+##################################################
+# We set...
+
+# ... include directory path...
+env.Append(CPPPATH = [INCLUDELOCALPATH])
+
+# ... some project definitions...
+env.Append(CCFLAGS = '-DWXMODELER_APP_IDENT=\\"wxmodeler\\"')
+env.Append(CCFLAGS = '-DWXMODELER_INSTALL_TARGET=\\"/usr/local\\"')
+
+# ... the build mode. Files, which MD5 signature is different from the
+# previous one, will be compiled again...
+SourceSignatures('MD5')
+
+##################################################
+
+##################################################
+# Then we just export our new environment...
+
+Export('env')
+
+##################################################
+
+##################################################
+# Then we call the subscript of the source directory...
+
+SConscript(SOURCELOCALPATH+'/SConscript', build_dir=OBJECTLOCALPATH+'/'+PLATFORM, duplicate = 0)
+
+##################################################
Added: trunk/wxModeler/src/SConscript
===================================================================
--- trunk/wxModeler/src/SConscript (rev 0)
+++ trunk/wxModeler/src/SConscript 2007-03-17 09:44:37 UTC (rev 39)
@@ -0,0 +1,32 @@
+##################################################
+# File : SConscript
+# Date : 17/03/2007
+# Author : Philippe Poupardin
+# Scons script for wxmodeler project
+#
+# Initial release tested on linux and with
+# wxWidgets-2.8
+##################################################
+
+##################################################
+# We fetch our root environment...
+
+Import('env')
+
+##################################################
+
+##################################################
+
+##################################################
+# We compile...
+
+binary = env.Program(env['BINARYFILE'], env['SOURCEFILES']);
+
+##################################################
+
+##################################################
+# We put our binary file on the right place...
+
+env.Install(env['BINARYLOCALPATH'], binary);
+
+##################################################
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <cor...@us...> - 2007-03-07 01:17:32
|
Revision: 38
http://wxmodeler.svn.sourceforge.net/wxmodeler/?rev=38&view=rev
Author: corrosifpirate
Date: 2007-03-06 17:17:28 -0800 (Tue, 06 Mar 2007)
Log Message:
-----------
Big code refactoring.
Modified Paths:
--------------
trunk/wxModeler/include/AboutBox.hpp
trunk/wxModeler/include/Application.hpp
trunk/wxModeler/include/Color.hpp
trunk/wxModeler/include/Configuration.hpp
trunk/wxModeler/include/GraphicCtrl.hpp
trunk/wxModeler/include/GraphicGLCtrl.hpp
trunk/wxModeler/include/GraphicItem.hpp
trunk/wxModeler/include/GraphicTool.hpp
trunk/wxModeler/include/Language.hpp
trunk/wxModeler/include/MainFrame.hpp
trunk/wxModeler/include/Matrix.hpp
trunk/wxModeler/include/Point.hpp
trunk/wxModeler/include/ToolBezier.hpp
trunk/wxModeler/include/ToolBox.hpp
trunk/wxModeler/include/ToolPoint.hpp
trunk/wxModeler/include/ToolPolygon.hpp
trunk/wxModeler/include/ToolSegment.hpp
trunk/wxModeler/include/Vector.hpp
trunk/wxModeler/include/Window.hpp
trunk/wxModeler/src/AboutBox.cpp
trunk/wxModeler/src/Application.cpp
trunk/wxModeler/src/Color.cpp
trunk/wxModeler/src/Configuration.cpp
trunk/wxModeler/src/GraphicCtrl.cpp
trunk/wxModeler/src/GraphicGLCtrl.cpp
trunk/wxModeler/src/GraphicItem.cpp
trunk/wxModeler/src/GraphicTool.cpp
trunk/wxModeler/src/Language.cpp
trunk/wxModeler/src/MainFrame.cpp
trunk/wxModeler/src/ToolBezier.cpp
trunk/wxModeler/src/ToolBox.cpp
trunk/wxModeler/src/ToolPoint.cpp
trunk/wxModeler/src/ToolPolygon.cpp
trunk/wxModeler/src/ToolSegment.cpp
Modified: trunk/wxModeler/include/AboutBox.hpp
===================================================================
--- trunk/wxModeler/include/AboutBox.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/AboutBox.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -15,9 +15,9 @@
/**
* The constructor.
* It defines the dialog itself.
- * @param pParent Pointer to a parent window.
+ * @param ipParent Pointer to a parent window.
*/
- AboutBox(wxWindow * pParent);
+ AboutBox(wxWindow * ipParent);
};
}
Modified: trunk/wxModeler/include/Application.hpp
===================================================================
--- trunk/wxModeler/include/Application.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/Application.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -35,19 +35,19 @@
* Get a pointer to the configuration module.
* @return The pointer to the object representing the configuration module
*/
- Configuration* GetConfiguration(void);
+ Configuration * GetConfiguration(void) const;
/**
* Get a pointer to the language module.
* @return The pointer to the object representing the language module
*/
- Language* GetLanguage(void);
+ Language * GetLanguage(void) const;
/**
* Get a pointer to the main frame.
* @return The pointer to the object representing the main frame
*/
- MainFrame* GetMainFrame(void);
+ MainFrame * GetMainFrame(void) const;
/**
* Processing which needs to be done as the application is about to exit.
@@ -64,9 +64,9 @@
private:
- Configuration* m_pConfiguration; /**< Pointer to configuration object. Permits to access the overall configuration environment. */
- Language* m_pLanguage; /**< Pointer to the language object. Permit to change de current language and access text labels. */
- MainFrame * m_pMainFrame; /**< Pointer to the object representing the main frame. Permits to modify its attributes. */
+ Configuration * m_pConfiguration; /**< Pointer to configuration object. Permits to access the overall configuration environment. */
+ Language * m_pLanguage; /**< Pointer to the language object. Permit to change de current language and access text labels. */
+ MainFrame * m_pMainFrame; /**< Pointer to the object representing the main frame. Permits to modify its attributes. */
};
}
Modified: trunk/wxModeler/include/Color.hpp
===================================================================
--- trunk/wxModeler/include/Color.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/Color.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -14,36 +14,36 @@
/**
* The constructor.
- * @param red The red component.
- * @param green The green component.
- * @param blue The blue component.
- * @param alpha The transparency component.
+ * @param iRed The red component.
+ * @param iGreen The green component.
+ * @param iBlue The blue component.
+ * @param iAlpha The transparency component.
*/
- Color(const unsigned char red = 0, const unsigned char green = 0, const unsigned char blue = 0, const unsigned char alpha = 0);
+ Color(const unsigned char iRed = 0, const unsigned char iGreen = 0, const unsigned char iBlue = 0, const unsigned char iAlpha = 0);
/**
* Get the red component.
* @return The red component.
*/
- unsigned char GetRed(void);
+ unsigned char GetRed(void) const;
/**
* Get the green component.
* @return The green component.
*/
- unsigned char GetGreen(void);
+ unsigned char GetGreen(void) const;
/**
* Get the blue component.
* @return The blue component.
*/
- unsigned char GetBlue(void);
+ unsigned char GetBlue(void) const;
/**
* Get the transparency component.
* @return The transparency component.
*/
- unsigned char GetAlpha(void);
+ unsigned char GetAlpha(void) const;
private:
Modified: trunk/wxModeler/include/Configuration.hpp
===================================================================
--- trunk/wxModeler/include/Configuration.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/Configuration.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -33,9 +33,9 @@
/**
* Change the language in the configuration.
* It has no direct effect on the labels and strings occuring in the program.
- * @param language An index corresponding to a language.
+ * @param iIndexLanguage An index corresponding to a language.
*/
- void ChangeLanguage(const int nLanguage);
+ void ChangeLanguage(const int iIndexLanguage);
/**
* Get the data path.
@@ -51,8 +51,8 @@
private:
- wxConfigBase* m_pConfig; /**< Pointer to the wxConfigBase object. It is the abstraction that permits to store/restore configurations within any platform. */
- int m_nLanguage; /**< Index of the current language. It is the language attribute that will be used as a reference for the whole program */
+ wxConfigBase * m_pConfig; /**< Pointer to the wxConfigBase object. It is the abstraction that permits to store/restore configurations within any platform. */
+ int m_indexLanguage; /**< Index of the current language. It is the language attribute that will be used as a reference for the whole program */
};
}
Modified: trunk/wxModeler/include/GraphicCtrl.hpp
===================================================================
--- trunk/wxModeler/include/GraphicCtrl.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/GraphicCtrl.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -36,25 +36,25 @@
/**
* Add a graphic item.
* It will then redraw the scene.
- * @param pItem Pointer to the new item to add.
+ * @param ipItem Pointer to the new item to add.
*/
- void AddItem(GraphicItem * pItem);
+ void AddItem(GraphicItem * ipItem);
/**
* Remove a graphic item.
* It will then redraw the scene.
* It does not delete the object itself.
- * @param pItem Pointer to the item to remove.
+ * @param iopItem Pointer to the item to remove.
*/
- void RemoveItem(GraphicItem * pItem);
+ void RemoveItem(GraphicItem * iopItem);
/**
* Delete a graphic item.
* It will then redraw the scene.
* It removes and deletes the item.
- * @param pItem Pointer to the item to delete.
+ * @param iopItem Pointer to the item to delete.
*/
- void DeleteItem(GraphicItem * pItem);
+ void DeleteItem(GraphicItem * iopItem);
/**
* Delete all graphic items.
@@ -65,81 +65,81 @@
/**
* Get a graphic item.
- * @param index The index of the desired item.
+ * @param iIndex The index of the desired item.
* @return A pointer to the item.
*/
- GraphicItem * GetItem(unsigned int index);
+ GraphicItem * GetItem(const unsigned int iIndex) const;
/**
* Update an item.
* It will update the tree data associated to that item.
- * @param pOldItem Pointer to the old item.
- * @param pNewItem Pointer to the new item.
+ * @param ipOldItem Pointer to the old item.
+ * @param ipNewItem Pointer to the new item.
*/
- void UpdateItem(GraphicItem * pOldItem, GraphicItem * pNewItem);
+ void UpdateItem(GraphicItem * ipOldItem, GraphicItem * ipNewItem);
/**
* Overloading of the operator [].
* Permits to gain access to graphic items.
- * @param index The index of the desired item.
+ * @param iIndex The index of the desired item.
* @return A pointer to the item.
*/
- GraphicItem * operator[](unsigned int index);
+ GraphicItem * operator[](const unsigned int iIndex);
/**
* Manage and encapsulate the drawing of a point.
* It is used to draw a point corresponding to the given coordinates.
- * @param point The coordinates of the point.
- * @param color The color.
+ * @param iPoint The coordinates of the point.
+ * @param iColor The color.
*/
- virtual void DrawPoint(DoublePoint point, Color color = Color(0, 0, 0, 0)) = 0;
+ virtual void DrawPoint(const DoublePoint iPoint, const Color iColor = Color(0, 0, 0, 0)) const = 0;
/**
* Manage and encapsulate the drawing of a segment.
* It is used to draw a segment corresponding to the given coordinates.
- * @param firstPoint The coordinates of the first point.
- * @param lastPoint The coordinates of the last point.
- * @param color The color.
+ * @param iFirstPoint The coordinates of the first point.
+ * @param iLastPoint The coordinates of the last point.
+ * @param iColor The color.
*/
- virtual void DrawSegment(DoublePoint firstPoint, DoublePoint lastPoint, Color color = Color(0, 0, 0, 0)) = 0;
+ virtual void DrawSegment(const DoublePoint iFirstPoint, const DoublePoint iLastPoint, const Color iColor = Color(0, 0, 0, 0)) const = 0;
/**
* Manage and encapsulate the drawing of a triangle.
* It is used to draw a triangle corresponding to the given coordinates.
- * @param point1 The coordinates of the first point.
- * @param point2 The coordinates of the second point.
- * @param point3 The coordinates of the fird point.
- * @param color The color.
+ * @param iPoint1 The coordinates of the first point.
+ * @param iPoint2 The coordinates of the second point.
+ * @param iPoint3 The coordinates of the fird point.
+ * @param iColor The color.
*/
- virtual void DrawTriangle(DoublePoint point1, DoublePoint point2, DoublePoint point3, Color color = Color(0, 0, 0, 0)) = 0;
+ virtual void DrawTriangle(const DoublePoint iPoint1, const DoublePoint iPoint2, const DoublePoint iPoint3, const Color iColor = Color(0, 0, 0, 0)) const = 0;
/**
* Manage and encapsulate the drawing of a polygon.
* It is used to draw a polygon corresponding to the given coordinates and fill choice.
- * @param pointArray The points defining the polygon.
- * @param fill The fill status.
- * @param color The color.
+ * @param iPointArray The points defining the polygon.
+ * @param iFill The fill status.
+ * @param iColor The color.
*/
- virtual void DrawPolygon(const GIPtrPointArray & pointArray, bool fill = true, Color color = Color(0, 0, 0, 0)) = 0;
+ virtual void DrawPolygon(const GIPtrPointArray & pointArray, const bool iFill = true, const Color iColor = Color(0, 0, 0, 0)) const = 0;
/**
* Manage and encapsulate the drawing of a pyramid.
* It is used to draw a pyramid corresponding to the given coordinates and base length.
- * @param basePoint The central point of the base.
- * @param topPoint The point marking the top.
- * @param baseLength The length of the base.
- * @param color The color.
+ * @param iBasePoint The central point of the base.
+ * @param iBaseWidth The width of the base.
+ * @param iHeight The length of the pyramid.
+ * @param iColor The color.
*/
- virtual void DrawPyramid(DoublePoint basePoint, double baseWidth, double length, Color color = Color(0, 0, 0, 0)) = 0;
+ virtual void DrawPyramid(const DoublePoint iBasePoint, const double iBaseWidth, const double iHeight, const Color iColor = Color(0, 0, 0, 0)) const = 0;
/**
* Manage and encapsulate the drawing of a string.
* It is used to draw a string for labelling purpose at the given coordinate.
- * @param point The coordinate from where the label should be written.
- * @param string The string to display.
- * @param color The color.
+ * @param iPoint The coordinate from where the label should be written.
+ * @param iString The string to display.
+ * @param iColor The color.
*/
- virtual void DrawString(DoublePoint point, wxString string, Color color = Color(0, 0, 0, 0)) = 0;
+ virtual void DrawString(const DoublePoint iPoint, const wxString iString, const Color iColor = Color(0, 0, 0, 0)) const = 0;
protected:
Modified: trunk/wxModeler/include/GraphicGLCtrl.hpp
===================================================================
--- trunk/wxModeler/include/GraphicGLCtrl.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/GraphicGLCtrl.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -23,21 +23,23 @@
/**
* The constructor.
* It displays an empty workset.
- * @param pParent Pointer to a parent window.
- * @param id Identificator of this graphic control.
- * @param pos Window position.
- * @param size Window size.
- * @param style Window style.
- * @param Window name.
- * @param Array of device context attributes associated to this window.
- * @param Window palette.
+ * @param ipParent Pointer to a parent window.
+ * @param iId Identificator of this graphic control.
+ * @param iPos Window position.
+ * @param iSize Window size.
+ * @param iStyle Window style.
+ * @param iName Window name.
+ * @param iAttribList Array of device context attributes associated to this window.
+ * @param iPalette Window palette.
*/
- GraphicGLCtrl(wxWindow *pParent, wxWindowID id = -1,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = 0, const wxString& name = wxGLCanvasName,
- int *attribList = (int*) NULL,
- const wxPalette& palette = wxNullPalette);
+ GraphicGLCtrl(wxWindow * ipParent,
+ wxWindowID iId = -1,
+ const wxPoint & iPos = wxDefaultPosition,
+ const wxSize & iSize = wxDefaultSize,
+ long iStyle = 0,
+ const wxString & iName = wxGLCanvasName,
+ int * iAttribList = (int *) NULL,
+ const wxPalette & iPalette = wxNullPalette);
/**
* The destructor.
@@ -47,19 +49,19 @@
/**
* Draw a point.
* It is used to draw a point corresponding to the given coordinates.
- * @param point The coordinates of the point.
- * @param color The color of the point.
+ * @param iPoint The coordinates of the point.
+ * @param iColor The color of the point.
*/
- virtual void DrawPoint(DoublePoint point, Color color = Color(0, 0, 0, 0));
+ virtual void DrawPoint(const DoublePoint iPoint, const Color iColor = Color(0, 0, 0, 0)) const;
/**
* Draw a segment.
* It is used to draw a segment corresponding to the given coordinates.
- * @param firstPoint The coordinates of the first point.
- * @param lastPoint The coordinates of the last point.
- * @param color The color of the segment.
+ * @param iFirstPoint The coordinates of the first point.
+ * @param iLastPoint The coordinates of the last point.
+ * @param iColor The color of the segment.
*/
- virtual void DrawSegment(DoublePoint firstPoint, DoublePoint lastPoint, Color color = Color(0, 0, 0, 0));
+ virtual void DrawSegment(const DoublePoint iFirstPoint, const DoublePoint iLastPoint, const Color iColor = Color(0, 0, 0, 0)) const;
/**
* Draw a triangle.
@@ -69,35 +71,35 @@
* @param point3 The coordinates of the third point.
* @param color The color of the triangle.
*/
- virtual void DrawTriangle(DoublePoint point1, DoublePoint point2, DoublePoint point3, Color color = Color(0, 0, 0, 0));
+ virtual void DrawTriangle(const DoublePoint iPoint1, const DoublePoint iPoint2, const DoublePoint iPoint3, const Color iColor = Color(0, 0, 0, 0)) const;
/**
* Manage and encapsulate the drawing of a polygon.
* It is used to draw a polygon corresponding to the given coordinates and fill choice.
- * @param pointArray The points defining the polygon.
- * @param fill The fill status.
- * @param color The color.
+ * @param iPointArray The points defining the polygon.
+ * @param iFill The fill status.
+ * @param iColor The color.
*/
- virtual void DrawPolygon(const GIPtrPointArray & pointArray, bool fill = true, Color color = Color(0, 0, 0, 0));
+ virtual void DrawPolygon(const GIPtrPointArray & iPointArray, const bool iFill = true, const Color iColor = Color(0, 0, 0, 0)) const;
/**
* Draw a pyramid.
* It is used to draw a pyramid corresponding to the given coordinates and base length.
- * @param basePoint The central point of the base.
- * @param topPoint The point marking the top.
- * @param baseLength The length of the base.
- * @param color The Color.
+ * @param iBasePoint The central point of the base.
+ * @param iBaseWidth The width of the base.
+ * @param iHeight The length of the pyramid.
+ * @param iColor The color.
*/
- virtual void DrawPyramid(DoublePoint basePoint, double baseWidth, double length, Color color = Color(0, 0, 0, 0));
+ virtual void DrawPyramid(const DoublePoint iBasePoint, const double iBaseWidth, const double iHeight, const Color iColor = Color(0, 0, 0, 0)) const;
/**
* Draw a string.
* It is used to draw a string for labelling purpose at the given coordinate.
- * @param point The coordinate from where the label should be written.
- * @param string The string to display.
- * @param color The color.
+ * @param iPoint The coordinate from where the label should be written.
+ * @param iString The string to display.
+ * @param iColor The color.
*/
- virtual void DrawString(DoublePoint point, wxString string, Color color = Color(0, 0, 0, 0));
+ virtual void DrawString(const DoublePoint iPoint, const wxString iString, const Color iColor = Color(0, 0, 0, 0)) const;
/**
* Remove last selection.
@@ -120,58 +122,58 @@
/**
* Define the camera.
- * @param aspect Aspect ratio of the window.
+ * @param iAspect Aspect ratio of the window.
*/
- void DefineCamera(float aspect);
+ void DefineCamera(const float iAspect);
/**
* Place the camera.
- * @param rx Rotation angle on the x-axis.
- * @param ry Rotation angle on the y-axis.
- * @param rz Rotation angle on the z-axis.
- * @param x Position on the x-axis.
- * @param y Position on the y-axis.
- * @param z Position on the z-axis.
+ * @param iRx Rotation angle on the x-axis.
+ * @param iRy Rotation angle on the y-axis.
+ * @param iRz Rotation angle on the z-axis.
+ * @param iX Position on the x-axis.
+ * @param iY Position on the y-axis.
+ * @param iZ Position on the z-axis.
*/
- void PlaceCamera(double rx, double ry, double rz, double x, double y, double z);
+ void PlaceCamera(const double iRx, const double iRy, const double iRz, const double iX, const double iY, const double iZ) const;
/**
* Rotate the scene globally.
- * @param oldMousePos The previous mouse coordinates.
- * @param newMousePos The new mouse coordinates.
- * @param globalCenter The global center for the rotation.
+ * @param iOldMousePos The previous mouse coordinates.
+ * @param iNewMousePos The new mouse coordinates.
+ * @param iGlobalCenter The global center for the rotation.
*/
- void RotateSceneGlobally(IntPoint oldMousePos, IntPoint newMousePos, DoublePoint globalCenter = DoublePoint(3));
+ void RotateSceneGlobally(const IntPoint iOldMousePos, const IntPoint iNewMousePos, const DoublePoint iGlobalCenter = DoublePoint(3)) const;
/**
* Rotate the scene locally.
- * @param oldMousePos The previous mouse coordinates.
- * @param newMousePos The new mouse coordinates.
- * @param localCenter The local center for the rotation.
+ * @param iOldMousePos The previous mouse coordinates.
+ * @param iNewMousePos The new mouse coordinates.
+ * @param iLocalCenter The local center for the rotation.
*/
- void RotateSceneLocally(IntPoint oldMousePos, IntPoint newMousePos, DoublePoint localCenter = DoublePoint(3));
+ void RotateSceneLocally(const IntPoint iOldMousePos, const IntPoint iNewMousePos, const DoublePoint iLocalCenter = DoublePoint(3)) const;
/**
* Zoom the scene.
- * @param oldMousePos The previous mouse coordinates.
- * @param newMousePos The new mouse coordinates.
+ * @param iOldMousePos The previous mouse coordinates.
+ * @param iNewMousePos The new mouse coordinates.
*/
- void ZoomScene(IntPoint oldMousePos, IntPoint newMousePos);
+ void ZoomScene(const IntPoint iOldMousePos, const IntPoint iNewMousePos);
/**
* Pan the scene.
- * @param oldMousePos The previous mouse coordinates.
- * @param newMousePos The new mouse coordinates.
+ * @param iOldMousePos The previous mouse coordinates.
+ * @param iNewMousePos The new mouse coordinates.
*/
- void PanScene(IntPoint oldMousePos, IntPoint newMousePos);
+ void PanScene(const IntPoint iOldMousePos, const IntPoint iNewMousePos) const;
/**
* Get the projection of a 2D point.
* @param iPoint The 2D point.
- * @param ioNearPoint The projected 3D point on the near plane.
- * @param ioFarPoint The projected 3D point of the far plane.
+ * @param oNearPoint The projected 3D point on the near plane.
+ * @param oFarPoint The projected 3D point of the far plane.
*/
- void GetPointProjection(const IntPoint & iPoint, DoublePoint & ioNearPoint, DoublePoint & ioFarPoint);
+ void GetPointProjection(const IntPoint & iPoint, DoublePoint & oNearPoint, DoublePoint & oFarPoint) const;
/**
* Get the intersection of a line and a plane.
@@ -183,7 +185,7 @@
* @param oIntersectPoint The intersection point.
* @return TRUE if there was only one intersection, FALSE if there were more intersections and no intersection point could be computed.
*/
- bool GetLinePlaneIntersection(const DoublePoint & iLineFirstPoint, const DoublePoint & iLineSecondPoint, const DoublePoint & iPlaneFirstPoint, const DoublePoint & iPlaneSecondPoint, const DoublePoint & iPlaneThirdPoint, DoublePoint & oIntersectPoint);
+ bool GetLinePlaneIntersection(const DoublePoint & iLineFirstPoint, const DoublePoint & iLineSecondPoint, const DoublePoint & iPlaneFirstPoint, const DoublePoint & iPlaneSecondPoint, const DoublePoint & iPlaneThirdPoint, DoublePoint & oIntersectPoint) const;
/**
* Get the active plane normal.
@@ -195,33 +197,33 @@
/**
* Process mouse event.
- * @param event The mouse event.
+ * @param iEvent The mouse event.
*/
- void OnMouse(wxMouseEvent& event);
+ void OnMouse(wxMouseEvent & iEvent);
/**
* Process size event.
- * @param event The size event.
+ * @param iEvent The size event.
*/
- void OnSize(wxSizeEvent& event);
+ void OnSize(wxSizeEvent & iEvent);
/**
* Process paint event.
- * @param event The paint event.
+ * @param iEvent The paint event.
*/
- void OnPaint(wxPaintEvent& event);
+ void OnPaint(wxPaintEvent & iEvent);
/**
* Process erase background event.
- * @param event The erase event.
+ * @param iEvent The erase event.
*/
- void OnEraseBackground(wxEraseEvent& event);
+ void OnEraseBackground(wxEraseEvent & iEvent);
/**
* Process window enter event.
* @param event The mouse event.
*/
- void OnEnterWindow(wxMouseEvent& event);
+ void OnEnterWindow(wxMouseEvent & iEvent);
bool m_init; /**< Flag to know if the OpenGL scene has been initialized. */
double m_distance; /**< Distance from the scene. */
@@ -242,7 +244,7 @@
IntPoint m_mousePos; /**< Mouse position in pixels. */
GIAxis * m_pAxis; /**< Pointer to the axis. */
- double m_xmin, m_xmax, m_ymin, m_ymax;
+ double m_xMin, m_xMax, m_yMin, m_yMax;
};
}
Modified: trunk/wxModeler/include/GraphicItem.hpp
===================================================================
--- trunk/wxModeler/include/GraphicItem.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/GraphicItem.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -21,10 +21,10 @@
/**
* The constructor.
* It allocates a graphic item with its properties.
- * @param visible true for visible, else false.
- * @param color The color of the item.
+ * @param iVisible true for visible, else false.
+ * @param iColor The color of the item.
*/
- GraphicItem(bool visible, Color color);
+ GraphicItem(const bool iVisible, const Color iColor);
/**
* The destructor.
@@ -35,20 +35,23 @@
/**
* Draw the object.
* It displays the object on the given graphic control.
- * @param pGraphicCtrl Graphic control to draw in.
+ * @param ipGraphicCtrl Graphic control to draw in.
*/
- virtual void Draw(GraphicCtrl * pGraphicControl) = 0;
+ virtual void Draw(GraphicCtrl * ipGraphicControl) = 0;
/**
* Add to tree control.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true) = 0;
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true) = 0;
/**
* Get tree item identificator.
* @return The identificator of the tree item.
*/
- wxTreeItemId GetTreeItemId(void);
+ wxTreeItemId GetTreeItemId(void) const;
/**
* Return the bounding window.
@@ -59,36 +62,36 @@
/**
* Set the visibility status.
* It allows to mask/unmask the graphic item.
- * @param visible true for visible, else false.
+ * @param iVisible true for visible, else false.
*/
- virtual void SetVisibility(bool visible);
+ virtual void SetVisibility(const bool iVisible);
/**
* Get the visibility status.
* It returns information on the masking/unmasking state of the item.
* @return true if the item is visible, else false.
*/
- virtual bool GetVisibility(void);
+ virtual bool GetVisibility(void) const;
/**
* Set the color.
* It changes the color for this graphic item.
- * @param color The chosen color.
+ * @param iColor The chosen color.
*/
- void SetColor(Color color);
+ void SetColor(const Color iColor);
/**
* Get the color.
* It returns the color of the item.
* @return The color;
*/
- Color GetColor(void);
+ Color GetColor(void) const;
protected:
- bool m_visible; /**< The visibility status. */
- Color m_color; /**< The color. */
- wxTreeItemId m_treeItemId; /**< Tree item identificator. */
+ bool m_visible; /**< The visibility status. */
+ Color m_color; /**< The color. */
+ wxTreeItemId m_treeItemId; /**< Tree item identificator. */
};
WX_DEFINE_ARRAY(GraphicItem *, GraphicItemArray);
@@ -104,11 +107,11 @@
/**
* The constructor.
* It allocates a point with all its properties.
- * @param point The coordinates of the point.
- * @param visible The visibility status.
- * @param color The color of the point.
+ * @param iPoint The coordinates of the point.
+ * @param iVisible The visibility status.
+ * @param iColor The color of the point.
*/
- GIPoint(DoublePoint point, bool visible = true, Color color = Color(0, 0, 0, 0));
+ GIPoint(const DoublePoint iPoint, const bool iVisible = true, const Color iColor = Color(0, 0, 0, 0));
/**
* The destructor.
@@ -118,30 +121,30 @@
/**
* Set the the point.
- * @param point The new coordinates of the point.
+ * @param iPoint The new coordinates of the point.
*/
- void Set(DoublePoint point);
+ void Set(const DoublePoint iPoint);
/**
* Get the point.
* @return The coordinates of the point.
*/
- DoublePoint Get(void);
+ DoublePoint Get(void) const;
/**
* Draw the item.
* It will draw the point, by matching its properties.
- * pGraphicCtrl Pointer to the graphic control.
+ * @param ipGraphicCtrl Pointer to the graphic control.
*/
- virtual void Draw(GraphicCtrl * pGraphicCtrl);
+ virtual void Draw(GraphicCtrl * ipGraphicCtrl);
/**
* Add to tree control.
- * @param pTreeCtrl Pointer to the tree control.
- * @param parent Pointer to the parent tree item.
- * @para visible Set if we should ensure item visibility.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true);
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true);
/**
* Get the bounding window.
@@ -166,12 +169,12 @@
/**
* The constructor.
* It allocates a segment with all its properties.
- * @param firstPoint The first point.
- * @param lastPoint The last point.
- * @param visible The visibility status.
- * @param color The color.
+ * @param iFirstPoint The first point.
+ * @param iLastPoint The last point.
+ * @param iVisible The visibility status.
+ * @param iColor The color.
*/
- GISegment(DoublePoint firstPoint, DoublePoint lastPoint, bool visible = true, Color color = Color(0, 0, 0, 0));
+ GISegment(const DoublePoint iFirstPoint, const DoublePoint iLastPoint, const bool iVisible = true, const Color iColor = Color(0, 0, 0, 0));
/**
* The destructor.
@@ -189,7 +192,7 @@
* Get the first point.
* @return A pointer to the first point.
*/
- GIPoint * GetFirstPoint(void);
+ GIPoint * GetFirstPoint(void) const;
/**
* Set the last point.
@@ -201,19 +204,22 @@
* Get the last point.
* @return A pointer to the last point.
*/
- GIPoint * GetLastPoint(void);
+ GIPoint * GetLastPoint(void) const;
/**
* Draw the item.
* It will draw the segment, by matching its properties.
- * @param pGraphicCtrl Pointer to the graphic control.
+ * @param ipGraphicCtrl Pointer to the graphic control.
*/
- virtual void Draw(GraphicCtrl * pGraphicCtrl);
+ virtual void Draw(GraphicCtrl * ipGraphicCtrl);
/**
* Add to tree control.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true);
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true);
/**
* Get the bounding window.
@@ -238,12 +244,12 @@
/**
* The constructor.
* It allocates a polygon with all its properties.
- * @param pointArray The points defining the polygon.
- * @param fill The fill status.
- * @param visible The visibility status.
- * @param color The color.
+ * @param iPointArray The points defining the polygon.
+ * @param iFill The fill status.
+ * @param iVisible The visibility status.
+ * @param iColor The color.
*/
- GIPolygon(const GIPtrPointArray & pointArray, bool fill = true, bool visible = true, Color color = Color(0, 0, 0, 0));
+ GIPolygon(const GIPtrPointArray & iPointArray, const bool iFill = true, const bool iVisible = true, const Color iColor = Color(0, 0, 0, 0));
/**
* The destructor.
@@ -255,45 +261,48 @@
* Get the number of points.
* @return The number of points.
*/
- unsigned int GetNbPoints(void);
+ unsigned int GetNbPoints(void) const;
/**
* Get a point.
- * @param index The index of the point.
+ * @param iIndex The index of the point.
* @return A pointer to the point.
*/
- GIPoint * GetPoint(unsigned int index);
+ GIPoint * GetPoint(const unsigned int iIndex) const;
/**
* Add a point.
- * @param index The index of the new point.
+ * @param iIndex The index of the new point.
* @param ipCtrlPoint A pointer to the new point.
*/
- void AddPoint(unsigned int index, GIPoint * ipPoint);
+ void AddPoint(unsigned int iIndex, GIPoint * ipPoint);
/**
* Remove a point.
- * @param index The index of the point.
+ * @param iIndex The index of the point.
*/
- void DeletePoint(unsigned int index);
+ void DeletePoint(const unsigned int iIndex);
/**
* Change the fill status.
- * @param status The fill status.
+ * @param iStatus The fill status.
*/
- void Fill(bool status = true);
+ void Fill(const bool iStatus = true);
/**
* Draw the item.
* It will draw the polygon, by matching its properties.
- * @param pGraphicCtrl Pointer to the graphic control.
+ * @param ipGraphicCtrl Pointer to the graphic control.
*/
- virtual void Draw(GraphicCtrl * pGraphicCtrl);
+ virtual void Draw(GraphicCtrl * ipGraphicCtrl);
/**
* Add to tree control.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true);
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true);
/**
* Get the bounding window.
@@ -318,12 +327,12 @@
/**
* The constructor.
* It allocates a Bezier curve with all its properties.
- * @param ctrlPointArray The control points.
- * @param fill The fill status.
- * @param visible The visibility status.
- * @param color The color.
+ * @param iCtrlPointArray The control points.
+ * @param iFill The fill status.
+ * @param iVisible The visibility status.
+ * @param iColor The color.
*/
- GIBezier(const GIPtrPointArray & ctrlPointArray, bool visible = true, Color color = Color(0, 0, 0, 0));
+ GIBezier(const GIPtrPointArray & iCtrlPointArray, const bool iVisible = true, const Color iColor = Color(0, 0, 0, 0));
/**
* The destructor.
@@ -335,29 +344,29 @@
* Get the number of control points.
* @return The number of control points.
*/
- unsigned int GetNbCtrlPoints(void);
+ unsigned int GetNbCtrlPoints(void) const;
/**
* Get a control point.
- * @param index The index of the control point.
+ * @param iIndex The index of the control point.
* @return A pointer to the control point.
*/
- GIPoint * GetCtrlPoint(unsigned int index);
+ GIPoint * GetCtrlPoint(unsigned int iIndex) const;
/**
* Add a control point.
- * @param index The index of the new control point.
+ * @param iIndex The index of the new control point.
* @param ipCtrlPoint A pointer to the new control point.
* @param iSubdivide Regenerate subdivision?
*/
- void AddCtrlPoint(unsigned int index, GIPoint * ipCtrlPoint, bool iSubdivide = true);
+ void AddCtrlPoint(const unsigned int iIndex, GIPoint * ipCtrlPoint, const bool iSubdivide = true);
/**
* Remove a control point.
- * @param index The index of the control point.
+ * @param iIndex The index of the control point.
* @param iSubdivide Regenerate subdivision?
*/
- void DeleteCtrlPoint(unsigned int index, bool iSubdivide = true);
+ void DeleteCtrlPoint(const unsigned int iIndex, const bool iSubdivide = true);
/**
* Compute sub-points.
@@ -368,14 +377,17 @@
/**
* Draw the item.
* It will draw the polygon, by matching its properties.
- * @param pGraphicCtrl Pointer to the graphic control.
+ * @param ipGraphicCtrl Pointer to the graphic control.
*/
- virtual void Draw(GraphicCtrl * pGraphicCtrl);
+ virtual void Draw(GraphicCtrl * ipGraphicCtrl);
/**
* Add to tree control.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true);
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true);
/**
* Get the bounding window.
@@ -387,20 +399,20 @@
/**
* Compute De Casteljau algorithm.
- * @param ctrlPoints The control points.
- * @param t The parameter.
+ * @param iCtrlPoints The control points.
+ * @param iT The parameter.
* @return The diagonals of the points pyramid.
*/
- DoublePointArray DeCasteljau(const DoublePointArray & ctrlPoints, const double t) const;
+ DoublePointArray DeCasteljau(const DoublePointArray & iCtrlPoints, const double iT) const;
/**
* Apply subdivisions.
* It will subdivide the Bezier curve.
- * @param nbSub Number of subdivisions.
- * @param t The parameter.
+ * @param iNbSub Number of subdivisions.
+ * @param iT The parameter.
* @return The new list of control points.
*/
- DoublePointArray Subdivide(const unsigned int nbSub, const double t) const;
+ DoublePointArray Subdivide(const unsigned int iNbSub, const double iT) const;
GIPtrPointArray m_ctrlPointArray;
DoublePointArray m_subPointArray;
@@ -426,12 +438,12 @@
/**
* The constructor.
* It allocates a mesh with all its properties.
- * @param strip The points in the triangle strip representation.
- * @param fill The fill status.
- * @param visible The visibility status.
- * @param color The color.
+ * @param iStrip The points in the triangle strip representation.
+ * @param iFill The fill status.
+ * @param iVisible The visibility status.
+ * @param iColor The color.
*/
- GIMesh(const DoublePointArray & stripArray, bool fill = false, bool visible = true, Color color = Color(0, 0, 0, 0));
+ GIMesh(const DoublePointArray & iStripArray, const bool iFill = false, const bool iVisible = true, const Color iColor = Color(0, 0, 0, 0));
/**
* The destructor.
@@ -441,35 +453,38 @@
/**
* Set a point.
- * @param index The index of the point.
- * @param point The new coordinates of the point.
+ * @param iIndex The index of the point.
+ * @param iPoint The new coordinates of the point.
*/
- void SetPoint(unsigned int index, DoublePoint point);
+ void SetPoint(const unsigned int iIndex, const DoublePoint iPoint);
/**
* Get a point.
- * @param index The index of the point.
+ * @param iIndex The index of the point.
* @return The point.
*/
- DoublePoint GetPoint(unsigned int index);
+ DoublePoint GetPoint(unsigned int iIndex) const;
/**
* Change the fill status.
- * @param status The fill status.
+ * @param iStatus The fill status.
*/
- void Fill(bool status = true);
+ void Fill(const bool iStatus = true);
/**
* Draw the item.
* It will draw the polygon, by matching its properties.
- * @param pGraphicCtrl Pointer to the graphic control.
+ * @param ipGraphicCtrl Pointer to the graphic control.
*/
- virtual void Draw(GraphicCtrl * pGraphicCtrl);
+ virtual void Draw(GraphicCtrl * ipGraphicCtrl);
/**
* Add to tree control.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true);
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true);
/**
* Get the bounding window.
@@ -494,13 +509,13 @@
/**
* The constructor.
* It allocates an axis with all its properties.
- * @param center The point defining the center of the axis.
+ * @param iCenter The point defining the center of the axis.
* @param iNormal The normal axis of the active plane.
- * @param size The size of the axis.
- * @param visible The visibility status.
- * @param color The color.
+ * @param iSize The size of the axis.
+ * @param iVisible The visibility status.
+ * @param iColor The color.
*/
- GIAxis(DoublePoint center, axis iNormal, double size, bool visible = true, Color color = Color(0, 0, 0, 0));
+ GIAxis(const DoublePoint iCenter, const axis iNormal, const double iSize, const bool iVisible = true, const Color iColor = Color(0, 0, 0, 0));
/**
* The destructor.
@@ -510,19 +525,19 @@
/**
* Set the center.
- * @param center The new coordinates of the center.
+ * @param iCenter The new coordinates of the center.
*/
- void SetCenter(DoublePoint center);
+ void SetCenter(const DoublePoint iCenter);
/**
* Get the center.
* @return The center.
*/
- const DoublePoint & GetCenter(void) const;
+ DoublePoint GetCenter(void) const;
/**
* Set the normal axis of the active plane.
- * @param The normal axis.
+ * @param iNormal The normal axis.
*/
void SetNormal(axis iNormal);
@@ -546,33 +561,36 @@
/**
* Set the size.
- * @param size the new size of the axis.
+ * @param iSize the new size of the axis.
*/
- void SetSize(double size);
+ void SetSize(const double iSize);
/**
* Get the size.
* @return The size.
*/
- double GetSize(void);
+ double GetSize(void) const;
/**
* Translate along the normal vector.
- * @param displacement The displacement.
+ * @param iDisplacement The displacement.
*/
- void Translate(double displacement);
+ void Translate(const double iDisplacement);
/**
* Draw the item.
* It will draw the line, by matching its properties.
- * @param pGraphicCtrl Pointer to the graphic control.
+ * @param ipGraphicCtrl Pointer to the graphic control.
*/
- virtual void Draw(GraphicCtrl * pGraphicCtrl);
+ virtual void Draw(GraphicCtrl * ipGraphicCtrl);
/**
* Add to tree control.
+ * @param iopTreeCtrl Pointer to the tree control.
+ * @param iParent Pointer to the parent tree item.
+ * @param iVisible Set if we should ensure item visibility.
*/
- virtual void AddToTreeCtrl(wxTreeCtrl * pTreeCtrl, wxTreeItemId parent, bool visible = true);
+ virtual void AddToTreeCtrl(wxTreeCtrl * iopTreeCtrl, const wxTreeItemId iParent, const bool iVisible = true);
/**
* Get the bounding window.
Modified: trunk/wxModeler/include/GraphicTool.hpp
===================================================================
--- trunk/wxModeler/include/GraphicTool.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/GraphicTool.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -31,25 +31,25 @@
* Process left button down event.
* @param iPoint The selected point.
*/
- virtual void OnMouseLeftDown(DoublePoint & iPoint) = 0;
+ virtual void OnMouseLeftDown(const DoublePoint & iPoint) = 0;
/**
* Process left button is down and dragging event.
* @param iPoint The selected point.
*/
- virtual void OnMouseLeftIsDownDragging(DoublePoint & iPoint) = 0;
+ virtual void OnMouseLeftIsDownDragging(const DoublePoint & iPoint) = 0;
/**
* Process left button up event.
* @param iPoint The selected point.
*/
- virtual void OnMouseLeftUp(DoublePoint & iPoint) = 0;
+ virtual void OnMouseLeftUp(const DoublePoint & iPoint) = 0;
/**
* Process right button down event.
* @param iPoint The selected point.
*/
- virtual void OnMouseRightDown(DoublePoint & iPoint) = 0;
+ virtual void OnMouseRightDown(const DoublePoint & iPoint) = 0;
protected:
Modified: trunk/wxModeler/include/Language.hpp
===================================================================
--- trunk/wxModeler/include/Language.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/Language.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -20,9 +20,9 @@
/**
* Translates all strings to the given language.
- * @param language An index corresponding to a language.
+ * @param iIndexLanguage An index corresponding to a language.
*/
- void ChangeLanguage(unsigned int nLanguage);
+ void ChangeLanguage(const unsigned int iIndexLanguage);
wxString STR_PROGRAM_NAME, STR_VENDOR_NAME,
STR_WELCOME,
Modified: trunk/wxModeler/include/MainFrame.hpp
===================================================================
--- trunk/wxModeler/include/MainFrame.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/MainFrame.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -22,38 +22,39 @@
/**
* The constructor.
- * @param pGraphicItem The graphic item.
+ * @param ipGraphicItem The graphic item.
+ * @param iGraphicItemID The graphic item identifier.
*/
- TreeGraphicItem(GraphicItem * pGraphicItem, GeomItemId itemID);
+ TreeGraphicItem(GraphicItem * ipGraphicItem, const GeomItemId iGraphicItemID);
/**
* Get the graphic item.
* @return A pointer to the graphic item.
*/
- GraphicItem * GetGraphicItem(void);
+ GraphicItem * GetGraphicItem(void) const;
/**
* Set the graphic item.
- * @param pGraphicItem A pointer to the graphic item.
+ * @param ipGraphicItem A pointer to the graphic item.
*/
- void SetGraphicItem(GraphicItem * pGraphicItem);
+ void SetGraphicItem(GraphicItem * ipGraphicItem);
/**
* Get the graphic item identity.
* @return The graphic item identity.
*/
- GeomItemId GetGraphicItemId(void);
+ GeomItemId GetGraphicItemId(void) const;
/**
* Set the graphic item identity.
- * @param graphicItemId The graphic item identity.
+ * @param iGraphicItemId The graphic item identity.
*/
- void SetGraphicItemId(const GeomItemId graphicItemId);
+ void SetGraphicItemId(const GeomItemId iGraphicItemId);
private:
GraphicItem * m_pGraphicItem; /**< Graphic item. */
- GeomItemId m_itemId; /**< The graphic item identity. */
+ GeomItemId m_itemId; /**< The graphic item identity. */
};
/**
@@ -80,13 +81,13 @@
* Graphic control accessor.
* @return A pointer to the graphic control.
*/
- GraphicGLCtrl * GetGraphicGLCtrl(void);
+ GraphicGLCtrl * GetGraphicGLCtrl(void) const;
/**
* Tree control accessor.
* @Return A pointer to the tree control.
*/
- wxTreeCtrl * GetTreeCtrl(void);
+ wxTreeCtrl * GetTreeCtrl(void) const;
/**
* Get the number of subdivisions for Bezier curves.
@@ -171,130 +172,151 @@
DECLARE_EVENT_TABLE()
/**
- * Quit the applicatio via the menu.
+ * Quit the application via the menu event handler.
* It has to handle correctly the active document, and prompt the user if one is not saved.
+ * @param iEvent The event.
*/
- void OnMenuFileQuit(wxCommandEvent & event);
+ void OnMenuFileQuit(wxCommandEvent & iEvent);
/**
- * Translate the application into english.
+ * Translate the application into english event handler.
* It will modify every label in the application to the specified language.
+ * @param iEvent The event.
*/
- void OnMenuLanguageEnglish(wxCommandEvent & event);
+ void OnMenuLanguageEnglish(wxCommandEvent & iEvent);
/**
- * Translate the application into french.
+ * Translate the application into french event handler.
* It will modify every label in the application to the specified language.
+ * @param iEvent The event.
*/
- void OnMenuLanguageFrench(wxCommandEvent & event);
+ void OnMenuLanguageFrench(wxCommandEvent & iEvent);
/**
- * Set the number of subdivisions.
+ * Set the number of subdivisions event handler.
* It will set the number of subdivisons for Bezier curves.
+ * @param iEvent The event.
*/
- void OnMenuOptionsSubdivisions(wxCommandEvent & event);
+ void OnMenuOptionsSubdivisions(wxCommandEvent & iEvent);
/**
- * Call the about box.
+ * Call the about box event handler.
* It displays informations about the program and its author.
+ * @param iEvent The event.
*/
- void OnMenuHelpAbout(wxCommandEvent & event);
+ void OnMenuHelpAbout(wxCommandEvent & iEvent);
/**
- * Change projection mode.
+ * Change projection mode event handler.
* It switches between perspective and orthogonal projection.
+ * @param iEvent The event.
*/
- void OnToolBarPerspective(wxCommandEvent & event);
+ void OnToolBarPerspective(wxCommandEvent & iEvent);
/**
* Global view control event handler.
* It allows to activate/deactivate the ability to move the view globally.
+ * @param iEvent The event.
*/
- void OnToolBarGlobalViewControl(wxCommandEvent & event);
+ void OnToolBarGlobalViewControl(wxCommandEvent & iEvent);
/**
* Local view control event handler.
* It allows to activate/deactivate the ability to move the view locally.
+ * @param iEvent The event.
*/
- void OnToolBarLocalViewControl(wxCommandEvent & event);
+ void OnToolBarLocalViewControl(wxCommandEvent & iEvent);
/**
* Activate plane normal to the x-axis control event handler.
* It allows to activate the activate plane normal to the x-axis.
+ * @param iEvent The event.
*/
- void OnToolBarX(wxCommandEvent & event);
+ void OnToolBarX(wxCommandEvent & iEvent);
/**
* Activate plane normal to the y-axis control event handler.
* It allows to activate the activate plane normal to the y-axis.
+ * @param iEvent The event.
*/
- void OnToolBarY(wxCommandEvent & event);
+ void OnToolBarY(wxCommandEvent & iEvent);
/**
* Activate plane normal to the z-axis control event handler.
* It allows to activate the activate plane normal to the z-axis.
+ * @param iEvent The event.
*/
- void OnToolBarZ(wxCommandEvent & event);
+ void OnToolBarZ(wxCommandEvent & iEvent);
/**
* Point tool event handler.
* It allows to activate/deactivate the ability to trace points.
+ * @param iEvent The event.
*/
- void OnToolBarPoint(wxCommandEvent & event);
+ void OnToolBarPoint(wxCommandEvent & iEvent);
/**
* Segment tool event handler.
* It allows to activate/deactivate the ability to trace segments.
+ * @param iEvent The event.
*/
- void OnToolBarSegment(wxCommandEvent & event);
+ void OnToolBarSegment(wxCommandEvent & iEvent);
/**
* Bezier tool event handler.
* It allows to activate/deactivate the ability to trace Bezier curves.
+ * @param iEvent The event.
*/
- void OnToolBarBezier(wxCommandEvent & event);
+ void OnToolBarBezier(wxCommandEvent & iEvent);
/**
* Polygon tool event handler.
* It allows to activate/deactive the ability to trace polygons.
+ * @param iEvent The event.
*/
- void OnToolBarPolygon(wxCommandEvent & event);
+ void OnToolBarPolygon(wxCommandEvent & iEvent);
/**
* Box tool event handler.
* It allows to activate/deactivate the ability to trace boxes.
+ * @param iEvent The event.
*/
- void OnToolBarBox(wxCommandEvent & event);
+ void OnToolBarBox(wxCommandEvent & iEvent);
/**
* Right click tree event handler.
* It allows to display the relative context menu.
+ * @param iEvent The event.
*/
- void OnTreeContextMenu(wxTreeEvent & event);
+ void OnTreeContextMenu(wxTreeEvent & iEvent);
/**
* Edit tree item event handler.
* It allows to set new content for the item.
+ * @param iEvent The event.
*/
- void OnTreeEdit(wxCommandEvent & event);
+ void OnTreeEdit(wxCommandEvent & iEvent);
/**
* Visibility tree item event handler.
* It allows to set the visibility status for the item.
+ * @param iEvent The event.
*/
- void OnTreeVisibility(wxCommandEvent & event);
+ void OnTreeVisibility(wxCommandEvent & iEvent);
/**
* Start edit tree item.
* It allows to keep the current content for later validation.
+ * @param iEvent The event.
*/
- void OnTreeBeginEdit(wxTreeEvent & event);
+ void OnTreeBeginEdit(wxTreeEvent & iEvent);
/**
* End edit tree item.
* It allows to validate the new text content.
+ * @param iEvent The event.
*/
- void OnTreeEndEdit(wxTreeEvent & event);
+ void OnTreeEndEdit(wxTreeEvent & iEvent);
/**
* Build the application menu.
@@ -304,11 +326,12 @@
/**
* Load a bitmap from file.
- * @param filePath Path to the file.
- * @param fileName File name.
+ * @param iFilePath Path to the file.
+ * @param iFileName File name.
+ * @param iType Bitmap file type.
* @return The loaded bitmap, or a bitmap if the file was not found.
*/
- wxBitmap LoadBitmap(wxString filePath, wxString fileName, wxBitmapType style);
+ wxBitmap LoadBitmap(const wxString iFilePath, const wxString iFileName, const wxBitmapType iType) const;
/**
* Build the tool bars.
Modified: trunk/wxModeler/include/Matrix.hpp
===================================================================
--- trunk/wxModeler/include/Matrix.hpp 2007-03-04 17:34:19 UTC (rev 37)
+++ trunk/wxModeler/include/Matrix.hpp 2007-03-07 01:17:28 UTC (rev 38)
@@ -49,25 +49,25 @@
/**
* The constructor.
- * @param rows Number of rows.
- * @param cols Number of columns.
+ * @param iRows Number of rows.
+ * @param iCols Number of columns.
*/
- Matrix(const unsigned rows = 0, const unsigned int cols = 0);
+ Matrix(const unsigned iRows = 0, const unsigned int iCols = 0);
/**
* The constructor.
- * @param matrix Matrix array.
- * @param rows Number of rows.
- * @param cols Number of columns.
+ * @param ipMatrix Matrix array.
+ * @param iRows Number of rows.
+ * @param iCols Number of columns.
*/
- Matrix(const T * matrix, unsigned int rows, unsigned int cols);
+ Matrix(const T * ipMatrix, unsigned int iRows, unsigned int iCols);
/**
* Resize matrix.
- * @param rows Number of rows.
- * @param cols Number of columns.
+ * @param iRows Number of rows.
+ * @param iCols Number of columns.
*/
- void Resize(const unsigned int rows, const unsigned int cols);
+ void Resize(const unsigned int iRows, const unsigned int iCols);
/**
* Get row count.
@@ -88,10 +88,10 @@
/**
* Overloading of operator []
- * @param i The index.
+ * @param iIndex The index.
* @return A writable reference to the vector corresponding to the given index.
*/
- Vector<T> & operator[](const unsigned int i);
+ Vector<T> & operator[](const unsigned int iIndex);
/**
* Overloading of operator -
@@ -101,59 +101,59 @@
/**
* Overloading of operator +=
- * @param m A matrix.
+ * @param iM A matrix.
* @return The left hand side matrix equals itself plus the right one.
*/
- Matrix<T> & operator+=(Matrix<T> m);
+ Matrix<T> & operator+=(Matrix<T> iM);
/**
* Overloading of operator -=
- * @param m A matrix.
+ * @param iM A matrix.
* @return The left hand side matrix equals itself minus the right one.
*/
- Matrix<T> & operator-=(Matrix<T> m);
+ Matrix<T> & operator-=(Matrix<T> iM);
/**
* Overloading of operator *=
- * @param m A matrix.
+ * @param iM A matrix.
* @return The left hand side matrix equals itself multiplied by the right one.
*/
- Matrix<T> & operator*=(Matrix<T> m);
+ Matrix<T> & operator*=(Matrix<T> iM);
/**
* Overloading of operator /=
- * @param m A matrix.
+ * @param iM A matrix.
* @return The left hand side matrix equals itself divided by the right one.
*/
- Matrix<T> & operator/=(Matrix<T> m);
+ Matrix<T> & operator/=(Matrix<T> iM);
/**
* Overloading of operator +
- * @param m A matrix.
+ * @param iM A matrix.
* @return The addition of the left hand side matrix by the right one.
*/
- Matrix<T> operator+(Matrix<T> m);
+ Matrix<T> operator+(Matrix<T> iM);
/**
* Overloading of operator -
- * @param m A matrix.
+ * @param iM A matrix.
* @return The substraction of the left hand side matrix by the right one.
*/
- Matrix<T> operator-(Matrix<T> m);
+ Matrix<T> operator-(Matrix<T> iM);
/**
* Overloading of operator *
- * @param m A matrix.
+ * @param iM A matrix.
* @return The multiplication of the left hand side matrix by the right one.
*/
- Matrix<T> operator*(Matrix<T> m);
+ Matrix<T> operator*(Matrix<T> iM);
/**
* Overloading of operator *
- * @param v A vector.
+ * @param iV A vector.
* @return The multiplication of the left hand side matrix by the right hand side vector.
*/
- Vector<T> operator*(Vector<T> v);
+ Vector<T> operator*(Vector<T> iV);
/**
* Transpose matrix.
@@ -177,10 +177,10 @@
/**
* Solve A*x=b using LUP decomposition, where A is the current matrix.
- * @param b Right hand side vector.
+ * @param iB Right hand side vector.
* @return Solution vector.
*/
- Vector<double> SolveLU...
[truncated message content] |