Gazebo

World Class Reference
[Server]

#include <World.hh>

Inheritance diagram for World:

SingletonT List of all members.

Detailed Description

The World.


Public Member Functions

void Close ()
 Closes the present world, frees the resources and closes the interfaces.
void Load (XMLConfigNode *rootNode, unsigned int serverId)
 Load the world.
void Save (XMLConfigNode *node)
 Save the world.
int Init ()
 Initialize the world.
int Update ()
 Update the world.
int Fini ()
 Finilize the world.
ServerGetGzServer () const
 Retun the libgazebo server.
PhysicsEngineGetPhysicsEngine () const
 Return the physics engine.
int LoadEntities (XMLConfigNode *node, Model *parent)
 Load all entities.
void DeleteEntity (const char *name)
 Delete an entity by name.
ModelGetModelByName (std::string modelName)
 Get a pointer to a model based on a name.
std::vector< Model * > & GetModels ()
 Get an iterator over the models.
void Reset ()
 Reset the simulation to the initial settings.
void RegisterGeom (Geom *geom)
 register a geom This method is no more than a manually-done signal system
bool GetShowBoundingBoxes ()
 Return true if the bounding boxes should be shown.
void SetShowBoundingBoxes (bool show)
 Set if the bounding boxes should be shown.
bool GetShowJoints ()
 Get wheter to show the joints.
void SetShowJoints (bool show)
 Set whether to show the joints.
void SetWireframe (bool wire)
 Set to view as wireframe.
bool GetWireframe ()
 Get whether to view as wireframe.
void SetShowPhysics (bool show)
 Set to view as wireframe.
bool GetShowPhysics ()
 Get whether to view as wireframe.


Member Function Documentation

void Load ( XMLConfigNode rootNode,
unsigned int  serverId 
)

Load the world.

Parameters:
node XMLConfig node point
serverId Id of the gazebo server

void Save ( XMLConfigNode node  ) 

Save the world.

Parameters:
node XMLConfig node writer pointer

int Init (  ) 

Initialize the world.

Returns:
0 on success

int Update (  ) 

Update the world.

Returns:
0 on success

int Fini (  ) 

Finilize the world.

Returns:
0 on success

Server* GetGzServer (  )  const

Retun the libgazebo server.

Returns:
Pointer the the libgazebo server

PhysicsEngine* GetPhysicsEngine (  )  const

Return the physics engine.

Returns:
Pointer to the physics engine

int LoadEntities ( XMLConfigNode node,
Model parent 
)

Load all entities.

Parameters:
node XMLConfg node pointer
parent Parent of the model to load
Returns:
0 on success

void DeleteEntity ( const char *  name  ) 

Delete an entity by name.

Parameters:
name The name of the entity to delete


The documentation for this class was generated from the following file:

Last updated Aug 04 2007