Global Class Reference
[Server]
#include <Global.hh>
Detailed Description
Class to hold global attributes Theparam:Global tag is used to specify certain global parameters for the server. Set these parameters as needed in the world file E.g.:
<param:Global>
<pause>true</pause>
</param:Global>
The parameters are as follows:
- pause (bool)
- Set to true to start the simulator in paused mode.
- Default: false
Static Public Member Functions | |
| static bool | GetUserQuit () |
| static void | SetUserQuit (bool quit) |
| static bool | GetUserPause () |
| static void | SetUserPause (bool pause) |
| static bool | GetUserStep () |
| static void | SetUserStep (bool step) |
| static bool | GetUserStepInc () |
| static void | SetUserStepInc (bool step) |
| static bool | GetShowBoundingBoxes () |
| static void | SetShowBoundingBoxes (bool show) |
| static unsigned long | GetIterations () |
| static void | SetIterations (unsigned long count) |
| static void | IncIterations () |
Static Public Attributes | |
| static boost::recursive_mutex | mutex |
| static Gui * | gui |
| static std::list < std::string > | gazeboPaths |
| static std::list < std::string > | ogrePaths |
| static Pose3d | poseOffset |
Member Function Documentation
| static bool GetUserQuit | ( | ) | [static] |
Return true if the user has quit
| static void SetUserQuit | ( | bool | quit | ) | [static] |
Set whether the user has quit
| static bool GetUserPause | ( | ) | [static] |
Return true if the user has pased
| static void SetUserPause | ( | bool | pause | ) | [static] |
Set whether the user has paused
| static bool GetUserStep | ( | ) | [static] |
Return true if the user has stepped the simulation
| static void SetUserStep | ( | bool | step | ) | [static] |
Set whether the user has stepped the simulation
| static bool GetUserStepInc | ( | ) | [static] |
Return true if the step has incremented
| static void SetUserStepInc | ( | bool | step | ) | [static] |
Set whether the step has incremented
| static bool GetShowBoundingBoxes | ( | ) | [static] |
Return true if the bounding boxes should be shown
| static void SetShowBoundingBoxes | ( | bool | show | ) | [static] |
Set if the bounding boxes should be shown
| static unsigned long GetIterations | ( | ) | [static] |
Get the number of iterations
| static void SetIterations | ( | unsigned long | count | ) | [static] |
Set the number of iterations
| static void IncIterations | ( | ) | [static] |
Increment the number of iterations
Member Data Documentation
boost::recursive_mutex mutex [static] |
Boost recursive mutex
std::list<std::string> gazeboPaths [static] |
Paths gazebo install
std::list<std::string> ogrePaths [static] |
Paths to the ogre install
Pose3d poseOffset [static] |
Global pose offset
The documentation for this class was generated from the following file: