libstage API reference
Data Structures | |
struct | stg_dio_cmd_t |
struct | stg_indicator_config_t |
struct | stg_indicator_data_t |
Modules | |
Measurement Types | |
Points | |
Polylines | |
Polygons | |
Worlds | |
Models | |
Utilities | |
Internals | |
Defines | |
#define | FiducialNone 0 |
#define | STG_TOKEN_MAX 64 |
Typedefs | |
typedef struct _stg_model | stg_model_t |
typedef struct _stg_world | stg_world_t |
Functions | |
int | stg_init (int argc, char **argv) |
void | stg_quit_request (void) |
int | stg_quit_test (void) |
stg_msec_t | stg_timenow (void) |
const char * | stg_version_string (void) |
Detailed Description
libstage (The Stage Library) provides a C code library for simulating a population of mobile robots and sensors. It is usually used as a plugin driver for Player, but it can also be used directly to build custom simulations.libstage is modular and fairly simple to use. The following code is enough to get a complete robot simulation running:
#include "stage.h" int main( int argc, char* argv[] ) { stg_init( argc, argv ); stg_world_t* world = stg_world_create_from_file( argv[1] ); while( (stg_world_update( world,TRUE )==0) ) {} stg_world_destroy( world ); return 0; }
- Contact and support
Define Documentation
#define FiducialNone 0 |
any integer value other than this is a valid fiducial ID
Referenced by model_fiducial_check_neighbor().
#define STG_TOKEN_MAX 64 |
Limit the length of the character strings that identify models
Referenced by stg_model_create(), and stg_model_load().
Typedef Documentation
typedef struct _stg_model stg_model_t |
typedef struct _stg_world stg_world_t |
Function Documentation
int stg_init | ( | int | argc, | |
char ** | argv | |||
) |
Initialize the stage library. Optionally pass in the arguments from main(), so Stage can read cmdline options. Stage then passes the arguments to GTK+ and Xlib so they can read their own options.
References _stg_disable_gui, and gui_startup().
Referenced by stg_world_create().
void stg_quit_request | ( | void | ) |
set stage's quit flag. Stage will quit cleanly very soon after this function is called.
References _stg_quit.
Referenced by gui_action_exit(), gui_poll(), signal_delete(), signal_destroy(), and stg_world_update().
int stg_quit_test | ( | void | ) |
stg_msec_t stg_timenow | ( | void | ) |
Returns the real (wall-clock) time in milliseconds since the simulation started.
Referenced by stg_world_update().
const char* stg_version_string | ( | void | ) |
Get a string identifying the version of stage. The string is generated by autoconf
Generated on Wed Jun 3 23:12:29 2009 for Stage by
