Update of /cvsroot/playerstage/code/stage/libstage
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv492/libstage
Modified Files:
canvas.cc main.cc model.cc model_blobfinder.cc
model_fiducial.cc model_laser.cc model_position.cc
model_ranger.cc world.cc worldgui.cc
Removed Files:
worldgtk.cc
Log Message:
major revisions to documentation, which was very out of date
Index: worldgui.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/worldgui.cc,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** worldgui.cc 21 Feb 2008 23:40:13 -0000 1.7
--- worldgui.cc 24 Feb 2008 23:24:41 -0000 1.8
***************
*** 11,14 ****
--- 11,16 ----
control which data and configurations are rendered.
+ API: Stg::StgWorldGui
+
<h2>Worldfile Properties</h2>
***************
*** 28,31 ****
--- 30,35 ----
@par Details
+ - title [string]
+ - the string displayed in the window title bar. Defaults to the worldfile
file name.
- size [width:int width:int]
- size of the window in pixels
***************
*** 92,95 ****
--- 96,100 ----
*/
+ #include "config.h" // for PACKAGE strings etc
#include "stage_internal.hh"
#include "region.hh"
***************
*** 98,107 ****
#include <FL/Fl_Shared_Image.H>
#include <FL/Fl_PNG_Image.H>
- //#include <FL/Fl_Text_Display.H>
#include <FL/Fl_Output.H>
#include <FL/Fl_Multiline_Output.H>
- #include "config.h" // for PACKAGE strings etc
-
- // some utilities
static const char* MITEM_VIEW_DATA = "View/Data";
--- 103,108 ----
Index: model_laser.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/model_laser.cc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** model_laser.cc 21 Feb 2008 05:57:43 -0000 1.4
--- model_laser.cc 24 Feb 2008 23:24:40 -0000 1.5
***************
*** 41,44 ****
--- 41,46 ----
The laser model simulates a scanning laser rangefinder
+ API: Stg::StgModelLaser
+
<h2>Worldfile properties</h2>
Index: model.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/model.cc,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** model.cc 21 Feb 2008 20:10:40 -0000 1.7
--- model.cc 24 Feb 2008 23:24:40 -0000 1.8
***************
*** 7,10 ****
--- 7,12 ----
the basic model to simulate environmental objects.
+ API: Stg::StgModel
+
<h2>Worldfile properties</h2>
Index: canvas.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/canvas.cc,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** canvas.cc 21 Feb 2008 20:10:40 -0000 1.9
--- canvas.cc 24 Feb 2008 23:24:40 -0000 1.10
***************
*** 1,2 ****
--- 1,8 ----
+ /** canvas.cc
+ Implement the main world viewing area in FLTK and OpenGL.
+ Author: Richard Vaughan ([EMAIL PROTECTED])
+ $Id$
+ */
+
#include "stage_internal.hh"
Index: main.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/main.cc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** main.cc 21 Feb 2008 03:35:05 -0000 1.2
--- main.cc 24 Feb 2008 23:24:40 -0000 1.3
***************
*** 1,2 ****
--- 1,9 ----
+ /**
+ \defgroup stage The Stage standalone robot simulator.
+
+ Here is where I describe the Stage standalone program.
+ */
+
+
#include "config.h"
#include "stage_internal.hh"
Index: world.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/world.cc,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** world.cc 21 Feb 2008 23:40:13 -0000 1.9
--- world.cc 24 Feb 2008 23:24:40 -0000 1.10
***************
*** 5,8 ****
--- 5,10 ----
file'.
+ API: Stg::StgWorld
+
<h2>Worldfile properties</h2>
***************
*** 10,26 ****
@verbatim
! world
! (
! name "[filename of worldfile]"
! interval_real 100
! interval_sim 100
! gui_interval 100
! resolution 0.01
! )
@endverbatim
@par Details
- name [string]
! - the name of the world, as displayed in the window title bar. Defaults to
the worldfile file name.
- interval_sim [milliseconds]
- the length of each simulation update cycle in milliseconds.
--- 12,27 ----
@verbatim
!
! title "[defaults to worldfile filename]"
! interval_real 100
! interval_sim 100
! gui_interval 100
! resolution 0.02
!
@endverbatim
@par Details
- name [string]
! - the name of the world, as displayed in the window title bar. Defaults to
the worldfile file name.
- interval_sim [milliseconds]
- the length of each simulation update cycle in milliseconds.
Index: model_ranger.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/model_ranger.cc,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** model_ranger.cc 18 Feb 2008 03:52:30 -0000 1.3
--- model_ranger.cc 24 Feb 2008 23:24:40 -0000 1.4
***************
*** 17,20 ****
--- 17,22 ----
The ranger model simulates an array of sonar or infra-red (IR) range sensors.
+ API: Stg::StgModelRanger
+
<h2>Worldfile properties</h2>
Index: model_fiducial.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/model_fiducial.cc,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** model_fiducial.cc 18 Feb 2008 03:52:30 -0000 1.3
--- model_fiducial.cc 24 Feb 2008 23:24:40 -0000 1.4
***************
*** 30,33 ****
--- 30,35 ----
The fiducial model simulates a fiducial-detecting device.
+ API: Stg::StgModelFiducial
+
<h2>Worldfile properties</h2>
Index: model_blobfinder.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/model_blobfinder.cc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** model_blobfinder.cc 15 Jan 2008 01:16:49 -0000 1.2
--- model_blobfinder.cc 24 Feb 2008 23:24:40 -0000 1.3
***************
*** 38,41 ****
--- 38,43 ----
with each channel is configurable.
+ API: Stg::StgModelBlobfinder
+
<h2>Worldfile properties</h2>
Index: model_position.cc
===================================================================
RCS file: /cvsroot/playerstage/code/stage/libstage/model_position.cc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** model_position.cc 21 Feb 2008 23:40:13 -0000 1.4
--- model_position.cc 24 Feb 2008 23:24:40 -0000 1.5
***************
*** 31,34 ****
--- 31,36 ----
independently.
+ API: Stg::StgModelPosition
+
<h2>Worldfile properties</h2>
--- worldgtk.cc DELETED ---
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Playerstage-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/playerstage-commit
