Forward declarations for the common classes. More...

Namespaces
	common
	Common namespace.

	event
	Event namespace.

	gui
	gui namespace

	math
	Math namespace.

	msgs
	Messages namespace.

	physics
	namespace for physics

	rendering
	Rendering namespace.

	sensors
	Sensors namespace.

	transport

	util

Classes
class	GUIPlugin
	A plugin loaded within the gzclient on startup. More...

class	Master
	A manager that directs topic connections, enables each gazebo network client to locate one another for peer-to-peer communication. More...

class	ModelPlugin
	A plugin with access to physics::Model. More...

class	PluginT
	A class which all plugins must inherit from. More...

class	SensorPlugin
	A plugin with access to physics::Sensor. More...

class	Server

class	SystemPlugin
	A plugin loaded within the gzserver on startup. More...

class	VisualPlugin
	A plugin loaded within the gzserver on startup. More...

class	WorldPlugin
	A plugin with access to physics::World. More...

Typedefs
typedef boost::shared_ptr < GUIPlugin >	GUIPluginPtr

typedef boost::shared_ptr < ModelPlugin >	ModelPluginPtr

typedef boost::shared_ptr < SensorPlugin >	SensorPluginPtr

typedef boost::shared_ptr < SystemPlugin >	SystemPluginPtr

typedef boost::shared_ptr < VisualPlugin >	VisualPluginPtr

typedef boost::shared_ptr < WorldPlugin >	WorldPluginPtr

Enumerations
enum	PluginType { WORLD_PLUGIN, MODEL_PLUGIN, SENSOR_PLUGIN, SYSTEM_PLUGIN, VISUAL_PLUGIN, GUI_PLUGIN }
	Used to specify the type of plugin. More...

Functions
GAZEBO_VISIBLE void	addPlugin (const std::string &_filename)
	Add a system plugin. More...

GAZEBO_VISIBLE gazebo::physics::WorldPtr	loadWorld (const std::string &_worldFile)
	Create and load a new world from an SDF world file. More...

GAZEBO_VISIBLE void	printVersion ()
	Output version information to the terminal. More...

GAZEBO_VISIBLE void	runWorld (gazebo::physics::WorldPtr _world, unsigned int _iterations)
	Run a world for a specific number of iterations. More...

GAZEBO_VISIBLE bool	setupClient (int _argc=0, char **_argv=0)
	Start a gazebo client. More...

GAZEBO_VISIBLE bool	setupClient (const std::vector< std::string > &_args)
	Start a gazebo client. More...

GAZEBO_VISIBLE bool	setupServer (int _argc=0, char **_argv=0)
	Start a gazebo server. More...

GAZEBO_VISIBLE bool	setupServer (const std::vector< std::string > &_args)
	Start a gazebo server. More...

GAZEBO_VISIBLE bool	shutdown ()
	Stop and cleanup simulation. More...

Detailed Description

Forward declarations for the common classes.

Forward declarations for the util classes.

Typedef Documentation

typedef boost::shared_ptr<GUIPlugin> gazebo::GUIPluginPtr

typedef boost::shared_ptr<ModelPlugin> gazebo::ModelPluginPtr

typedef boost::shared_ptr<SensorPlugin> gazebo::SensorPluginPtr

typedef boost::shared_ptr<SystemPlugin> gazebo::SystemPluginPtr

typedef boost::shared_ptr<VisualPlugin> gazebo::VisualPluginPtr

typedef boost::shared_ptr<WorldPlugin> gazebo::WorldPluginPtr

Function Documentation

GAZEBO_VISIBLE void gazebo::addPlugin ( const std::string & _filename )

Add a system plugin.

Parameters

[in] _filename Path to the plugin.

GAZEBO_VISIBLE gazebo::physics::WorldPtr gazebo::loadWorld ( const std::string & _worldFile )

Create and load a new world from an SDF world file.

Parameters

[in] _worldFile The world file to load from.

Returns: Pointer to the created world. NULL on error.

GAZEBO_VISIBLE void gazebo::printVersion ( )

Output version information to the terminal.

GAZEBO_VISIBLE void gazebo::runWorld	(	gazebo::physics::WorldPtr	_world,
		unsigned int	_iterations
	)

Run a world for a specific number of iterations.

Parameters

[in]	_world	Pointer to a world.
[in]	_iterations	Number of iterations to execute.

GAZEBO_VISIBLE bool gazebo::setupClient	(	int	_argc = `0`,
		char **	_argv = `0`
	)

Start a gazebo client.

This starts transportation, and makes it possible to connect to a running simulation.

Parameters

[in]	_argc	Number of commandline arguments.
[in]	_argv	The commandline arguments.

Returns: True on success.

GAZEBO_VISIBLE bool gazebo::setupClient ( const std::vector< std::string > & _args )

Start a gazebo client.

This starts transportation, and makes it possible to connect to a running simulation.

Parameters

[in] _args Vector of arguments only parsed by the system plugins. Note that when you run gazebo/gzserver, all the options (–version, –server-plugin, etc.) are parsed but when using Gazebo as a library, the arguments are only parsed by the system plugins.

See Also: gazebo::SystemPlugin::Load()

Returns: True on success.

GAZEBO_VISIBLE bool gazebo::setupServer	(	int	_argc = `0`,
		char **	_argv = `0`
	)

Start a gazebo server.

This starts transportation, and makes it possible to create worlds.

Parameters

[in]	_argc	Number of commandline arguments.
[in]	_argv	The commandline arguments.

Returns: True on success.

GAZEBO_VISIBLE bool gazebo::setupServer ( const std::vector< std::string > & _args )

Start a gazebo server.

This starts transportation, and makes it possible to create worlds.

Parameters

[in] _args Vector of arguments only parsed by the system plugins. Note that when you run gazebo/gzserver, all the options (–version, –server-plugin, etc.) are parsed but when using Gazebo as a library, the arguments are only parsed by the system plugins.

See Also: gazebo::SystemPlugin::Load()

Returns: True on success.

GAZEBO_VISIBLE bool gazebo::shutdown ( )

Stop and cleanup simulation.

Returns: True if the simulation is shutdown; false otherwise.

Referenced by gazebo::transport::Connection::ConnectToShutdown(), and gazebo::transport::Connection::DisconnectShutdown().

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Function Documentation