All messages and helper functions. More...

Namespaces
	gazebo::msgs
	Messages namespace.

Classes
class	GazeboGenerator
	Google protobuf message generator for gazebo::msgs. More...

class	MsgFactory
	A factory that generates protobuf message based on a string type. More...

Macros
#define	GZ_REGISTER_STATIC_MSG(_msgtype, _classname)
	Static message registration macro. More...

Functions
GAZEBO_VISIBLE void	AddBoxLink (msgs::Model &_model, const double _mass, const ignition::math::Vector3d &_size)
	Add a simple box link to a Model message. More...

GAZEBO_VISIBLE void	AddCylinderLink (msgs::Model &_model, const double _mass, const double _radius, const double _length)
	Add a simple cylinder link to a Model message. More...

GAZEBO_VISIBLE void	AddLinkGeom (Model &_msg, const Geometry &_geom)
	Add a link with a collision and visual of specified geometry to a model message. More...

GAZEBO_VISIBLE void	AddSphereLink (msgs::Model &_model, const double _mass, const double _radius)
	Add a simple sphere link to a Model message. More...

GAZEBO_VISIBLE msgs::Axis	AxisFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Axis from an axis SDF element. More...

GAZEBO_VISIBLE msgs::CameraSensor	CameraSensorFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::CameraSensor from a camera sensor SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	CameraSensorToSDF (const msgs::CameraSensor &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::CameraSensor. More...

GAZEBO_VISIBLE msgs::Collision	CollisionFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Collision from a collision SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	CollisionToSDF (const msgs::Collision &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Collision. More...

GAZEBO_VISIBLE msgs::ContactSensor	ContactSensorFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::ContactSensor from a contact sensor SDF element. More...

GAZEBO_VISIBLE msgs::Vector3d	Convert (const ignition::math::Vector3d &_v)
	Convert a ignition::math::Vector3 to a msgs::Vector3d. More...

GAZEBO_VISIBLE msgs::Vector2d	Convert (const ignition::math::Vector2d &_v)
	Convert a ignition::math::Vector2d to a msgs::Vector2d. More...

GAZEBO_VISIBLE msgs::Quaternion	Convert (const ignition::math::Quaterniond &_q)
	Convert a ignition::math::Quaternion to a msgs::Quaternion. More...

GAZEBO_VISIBLE msgs::Pose	Convert (const ignition::math::Pose3d &_p)
	Convert a ignition::math::Pose to a msgs::Pose. More...

GAZEBO_VISIBLE msgs::Color	Convert (const common::Color &_c)
	Convert a common::Color to a msgs::Color. More...

GAZEBO_VISIBLE msgs::Time	Convert (const common::Time &_t)
	Convert a common::Time to a msgs::Time. More...

GAZEBO_VISIBLE msgs::PlaneGeom	Convert (const ignition::math::Planed &_p)
	Convert a ignition::math::Planed to a msgs::PlaneGeom. More...

GAZEBO_VISIBLE common::Color	Convert (const msgs::Color &_c)
	Convert a msgs::Color to a common::Color. More...

GAZEBO_VISIBLE common::Time	Convert (const msgs::Time &_t)
	Convert a msgs::Time to a common::Time. More...

GAZEBO_VISIBLE msgs::Geometry::Type	ConvertGeometryType (const std::string &_str)
	Convert a string to a msgs::Geometry::Type enum. More...

GAZEBO_VISIBLE std::string	ConvertGeometryType (const msgs::Geometry::Type _type)
	Convert a msgs::Geometry::Type to a string. More...

GAZEBO_VISIBLE ignition::math::Vector3d	ConvertIgn (const msgs::Vector3d &_v)
	Convert a msgs::Vector3d to an ignition::math::Vector. More...

GAZEBO_VISIBLE ignition::math::Vector2d	ConvertIgn (const msgs::Vector2d &_v)
	Convert a msgs::Vector2d to an ignition::math::Vector2d. More...

GAZEBO_VISIBLE ignition::math::Quaterniond	ConvertIgn (const msgs::Quaternion &_q)
	Convert a msgs::Quaternion to an ignition::math::Quaternion. More...

GAZEBO_VISIBLE ignition::math::Pose3d	ConvertIgn (const msgs::Pose &_p)
	Convert a msgs::Pose to an ignition::math::Pose. More...

GAZEBO_VISIBLE ignition::math::Planed	ConvertIgn (const msgs::PlaneGeom &_p)
	Convert a msgs::PlaneGeom to an ignition::math::Planed. More...

GAZEBO_VISIBLE msgs::Joint::Type	ConvertJointType (const std::string &_str)
	Convert a string to a msgs::Joint::Type enum. More...

GAZEBO_VISIBLE std::string	ConvertJointType (const msgs::Joint::Type &_type)
	Convert a msgs::Joint::Type to a string. More...

GAZEBO_VISIBLE msgs::Material::ShaderType	ConvertShaderType (const std::string &_str)
	Convert a string to a msgs::Material::ShaderType enum. More...

GAZEBO_VISIBLE std::string	ConvertShaderType (const msgs::Material::ShaderType &_type)
	Convert a msgs::ShaderType to a string. More...

GAZEBO_VISIBLE msgs::Request *	CreateRequest (const std::string &_request, const std::string &_data="")
	Create a request message. More...

GAZEBO_VISIBLE msgs::Fog	FogFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Fog from a fog SDF element. More...

GAZEBO_VISIBLE msgs::Friction	FrictionFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Friction from a friction SDF element. More...

GAZEBO_VISIBLE msgs::Geometry	GeometryFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Geometry from a geometry SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	GeometryToSDF (const msgs::Geometry &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Geometry If _sdf is supplied and the _msg has non-empty repeated elements, any existing sdf elements will be removed from _sdf prior to adding the new elements from _msg. More...

GAZEBO_VISIBLE msgs::Header *	GetHeader (google::protobuf::Message &_message)
	Get the header from a protobuf message. More...

GAZEBO_VISIBLE msgs::GUI	GUIFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::GUI from a GUI SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	InertialToSDF (const msgs::Inertial &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Inertial. More...

GAZEBO_VISIBLE void	Init (google::protobuf::Message &_message, const std::string &_id="")
	Initialize a message. More...

GAZEBO_VISIBLE msgs::Joint	JointFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Joint from a joint SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	JointToSDF (const msgs::Joint &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from msgs::Joint. More...

GAZEBO_VISIBLE msgs::Light	LightFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Light from a light SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	LightToSDF (const msgs::Light &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Light. More...

GAZEBO_VISIBLE sdf::ElementPtr	LinkToSDF (const msgs::Link &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Link. More...

GAZEBO_VISIBLE sdf::ElementPtr	MaterialToSDF (const msgs::Material &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Material If _sdf is supplied and _msg has script uri's the <uri> elements will be removed from _sdf. More...

GAZEBO_VISIBLE msgs::MeshGeom	MeshFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::MeshGeom from a mesh SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	MeshToSDF (const msgs::MeshGeom &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Mesh. More...

GAZEBO_VISIBLE sdf::ElementPtr	ModelToSDF (const msgs::Model &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from msgs::Model. More...

GAZEBO_VISIBLE msgs::Plugin	PluginFromSDF (const sdf::ElementPtr _sdf)
	Create a msgs::Plugin from a plugin SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	PluginToSDF (const msgs::Plugin &_plugin, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Plugin. More...

GAZEBO_VISIBLE msgs::RaySensor	RaySensorFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::RaySensor from a ray sensor SDF element. More...

GAZEBO_VISIBLE msgs::Scene	SceneFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Scene from a scene SDF element. More...

GAZEBO_VISIBLE msgs::Sensor	SensorFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Sensor from a sensor SDF element. More...

GAZEBO_VISIBLE void	Set (common::Image &_img, const msgs::Image &_msg)
	Convert a msgs::Image to a common::Image. More...

GAZEBO_VISIBLE void	Set (msgs::Image *_msg, const common::Image &_i)
	Set a msgs::Image from a common::Image. More...

GAZEBO_VISIBLE void	Set (msgs::Vector3d *_pt, const ignition::math::Vector3d &_v)
	Set a msgs::Vector3d from an ignition::math::Vector3d. More...

GAZEBO_VISIBLE void	Set (msgs::Vector2d *_pt, const ignition::math::Vector2d &_v)
	Set a msgs::Vector2d from an ignition::math::Vector2d. More...

GAZEBO_VISIBLE void	Set (msgs::Quaternion *_q, const ignition::math::Quaterniond &_v)
	Set a msgs::Quaternion from an ignition::math::Quaterniond. More...

GAZEBO_VISIBLE void	Set (msgs::Pose *_p, const ignition::math::Pose3d &_v)
	Set a msgs::Pose from an ignition::math::Pose3d. More...

GAZEBO_VISIBLE void	Set (msgs::Color *_c, const common::Color &_v)
	Set a msgs::Color from a common::Color. More...

GAZEBO_VISIBLE void	Set (msgs::Time *_t, const common::Time &_v)
	Set a msgs::Time from a common::Time. More...

GAZEBO_VISIBLE void	Set (msgs::SphericalCoordinates *_s, const common::SphericalCoordinates &_v)
	Set a msgs::SphericalCoordinates from a common::SphericalCoordinates object. More...

GAZEBO_VISIBLE void	Set (msgs::PlaneGeom *_p, const ignition::math::Planed &_v)
	Set a msgs::Plane from an ignition::math::Planed. More...

GAZEBO_VISIBLE void	Stamp (msgs::Header *_header)
	Time stamp a header. More...

GAZEBO_VISIBLE void	Stamp (msgs::Time *_time)
	Set the time in a time message. More...

GAZEBO_VISIBLE msgs::Surface	SurfaceFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Surface from a surface SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	SurfaceToSDF (const msgs::Surface &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Surface. More...

GAZEBO_VISIBLE msgs::TrackVisual	TrackVisualFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::TrackVisual from a track visual SDF element. More...

GAZEBO_VISIBLE msgs::Visual	VisualFromSDF (sdf::ElementPtr _sdf)
	Create a msgs::Visual from a visual SDF element. More...

GAZEBO_VISIBLE sdf::ElementPtr	VisualToSDF (const msgs::Visual &_msg, sdf::ElementPtr _sdf=sdf::ElementPtr())
	Create or update an SDF element from a msgs::Visual. More...

Detailed Description

All messages and helper functions.

Macro Definition Documentation

§ GZ_REGISTER_STATIC_MSG

#define GZ_REGISTER_STATIC_MSG	(	_msgtype,
		_classname
	)

Value:

GAZEBO_VISIBLE \
    boost::shared_ptr<google::protobuf::Message> New##_classname() \
    { \
      return boost::shared_ptr<gazebo::msgs::_classname>(\
          new gazebo::msgs::_classname); \
    } \
    class GAZEBO_VISIBLE Msg##_classname \
    { \
      public: Msg##_classname() \
      { \
        gazebo::msgs::MsgFactory::RegisterMsg(_msgtype, New##_classname);\
      } \
    }; \
    static Msg##_classname GzMsgInitializer;

Static message registration macro.

Use this macro to register messages.

Parameters

[in]	_msgtype	Message type name.
[in]	_classname	Class name for message.

Function Documentation

§ AddBoxLink()

GAZEBO_VISIBLE void gazebo::msgs::AddBoxLink	(	msgs::Model &	_model,
		const double	_mass,
		const ignition::math::Vector3d &	_size
	)

Add a simple box link to a Model message.

The size and mass of the box are specified, and a single collision is added, along with an inertial block corresponding to a box of uniform density.

Parameters

[out]	_model	The msgs::Model to which the link is added.
[in]	_mass	Mass of the box.
[in]	_size	Size of the box.

§ AddCylinderLink()

GAZEBO_VISIBLE void gazebo::msgs::AddCylinderLink	(	msgs::Model &	_model,
		const double	_mass,
		const double	_radius,
		const double	_length
	)

Add a simple cylinder link to a Model message.

The radius, length, and mass of the cylinder are specified, and a single collision is added, along with an inertial block corresponding to a cylinder of uniform density with an axis of symmetry along the Z axis.

Parameters

[out]	_model	The msgs::Model to which the link is added.
[in]	_mass	Mass of the cylinder.
[in]	_radius	Radius of the cylinder.
[in]	_length	Length of the cylinder.

§ AddLinkGeom()

GAZEBO_VISIBLE void gazebo::msgs::AddLinkGeom	(	Model &	_msg,
		const Geometry &	_geom
	)

Add a link with a collision and visual of specified geometry to a model message.

It does not set any inertial values.

Parameters

[out]	_model	The msgs::Model object to receive a new link.
[in]	_geom	Geometry to be added to collision and visual.

§ AddSphereLink()

GAZEBO_VISIBLE void gazebo::msgs::AddSphereLink	(	msgs::Model &	_model,
		const double	_mass,
		const double	_radius
	)

Add a simple sphere link to a Model message.

The size and mass of the sphere are specified, and a single collision is added, along with an inertial block corresponding to a sphere of uniform density.

Parameters

[out]	_model	The msgs::Model to which the link is added.
[in]	_mass	Mass of the sphere.
[in]	_radius	Radius of the sphere.

§ AxisFromSDF()

GAZEBO_VISIBLE msgs::Axis gazebo::msgs::AxisFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Axis from an axis SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Axis object

§ CameraSensorFromSDF()

GAZEBO_VISIBLE msgs::CameraSensor gazebo::msgs::CameraSensorFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::CameraSensor from a camera sensor SDF element.

Parameters

[in] _sdf The camera sensor sdf element

Returns: The new msgs::CameraSensor object

See also: SensorFromSDF

§ CameraSensorToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::CameraSensorToSDF	(	const msgs::CameraSensor &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::CameraSensor.

Parameters

[in]	_msg	CameraSensor messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ CollisionFromSDF()

GAZEBO_VISIBLE msgs::Collision gazebo::msgs::CollisionFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Collision from a collision SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Collision object

§ CollisionToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::CollisionToSDF	(	const msgs::Collision &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Collision.

Parameters

[in]	_msg	Collision messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ ContactSensorFromSDF()

GAZEBO_VISIBLE msgs::ContactSensor gazebo::msgs::ContactSensorFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::ContactSensor from a contact sensor SDF element.

Parameters

[in] _sdf The contact sensor sdf element

Returns: The new msgs::ContactSensor object

See also: SensorFromSDF

§ Convert() [1/9]

GAZEBO_VISIBLE msgs::Vector3d gazebo::msgs::Convert ( const ignition::math::Vector3d & _v )

Convert a ignition::math::Vector3 to a msgs::Vector3d.

Parameters

[in] _v The vector to convert

Returns: A msgs::Vector3d object

§ Convert() [2/9]

GAZEBO_VISIBLE msgs::Vector2d gazebo::msgs::Convert ( const ignition::math::Vector2d & _v )

Convert a ignition::math::Vector2d to a msgs::Vector2d.

Parameters

[in] _v The vector to convert

Returns: A msgs::Vector2d object

§ Convert() [3/9]

GAZEBO_VISIBLE msgs::Quaternion gazebo::msgs::Convert ( const ignition::math::Quaterniond & _q )

Convert a ignition::math::Quaternion to a msgs::Quaternion.

Parameters

[in] _q The quaternion to convert

Returns: A msgs::Quaternion object

§ Convert() [4/9]

GAZEBO_VISIBLE msgs::Pose gazebo::msgs::Convert ( const ignition::math::Pose3d & _p )

Convert a ignition::math::Pose to a msgs::Pose.

Parameters

[in] _p The pose to convert

Returns: A msgs::Pose object

§ Convert() [5/9]

GAZEBO_VISIBLE msgs::Color gazebo::msgs::Convert ( const common::Color & _c )

Convert a common::Color to a msgs::Color.

Parameters

[in] _c The color to convert

Returns: A msgs::Color object

§ Convert() [6/9]

GAZEBO_VISIBLE msgs::Time gazebo::msgs::Convert ( const common::Time & _t )

Convert a common::Time to a msgs::Time.

Parameters

[in] _t The time to convert

Returns: A msgs::Time object

§ Convert() [7/9]

GAZEBO_VISIBLE msgs::PlaneGeom gazebo::msgs::Convert ( const ignition::math::Planed & _p )

Convert a ignition::math::Planed to a msgs::PlaneGeom.

Parameters

[in] _p The plane to convert

Returns: A msgs::PlaneGeom object

§ Convert() [8/9]

GAZEBO_VISIBLE common::Color gazebo::msgs::Convert ( const msgs::Color & _c )

Convert a msgs::Color to a common::Color.

Parameters

[in] _c The color to convert

Returns: A common::Color object

§ Convert() [9/9]

GAZEBO_VISIBLE common::Time gazebo::msgs::Convert ( const msgs::Time & _t )

Convert a msgs::Time to a common::Time.

Parameters

[in] _t The time to convert

Returns: A common::Time object

§ ConvertGeometryType() [1/2]

GAZEBO_VISIBLE msgs::Geometry::Type gazebo::msgs::ConvertGeometryType ( const std::string & _str )

Convert a string to a msgs::Geometry::Type enum.

Parameters

[in] _str Geometry type string.

Returns: A msgs::Geometry::Type enum.

§ ConvertGeometryType() [2/2]

GAZEBO_VISIBLE std::string gazebo::msgs::ConvertGeometryType ( const msgs::Geometry::Type _type )

Convert a msgs::Geometry::Type to a string.

Parameters

[in] _type A msgs::Geometry::Type enum.

Returns: Geometry type string.

§ ConvertIgn() [1/5]

GAZEBO_VISIBLE ignition::math::Vector3d gazebo::msgs::ConvertIgn ( const msgs::Vector3d & _v )

Convert a msgs::Vector3d to an ignition::math::Vector.

Parameters

[in] _v The plane to convert

Returns: An ignition::math::Vector3 object

§ ConvertIgn() [2/5]

GAZEBO_VISIBLE ignition::math::Vector2d gazebo::msgs::ConvertIgn ( const msgs::Vector2d & _v )

Convert a msgs::Vector2d to an ignition::math::Vector2d.

Parameters

[in] _v The vector2 to convert

Returns: An ignition::math::Vector2d object

§ ConvertIgn() [3/5]

GAZEBO_VISIBLE ignition::math::Quaterniond gazebo::msgs::ConvertIgn ( const msgs::Quaternion & _q )

Convert a msgs::Quaternion to an ignition::math::Quaternion.

Parameters

[in] _q The quaternion to convert

Returns: An ignition::math::Quaternion object

§ ConvertIgn() [4/5]

GAZEBO_VISIBLE ignition::math::Pose3d gazebo::msgs::ConvertIgn ( const msgs::Pose & _p )

Convert a msgs::Pose to an ignition::math::Pose.

Parameters

[in] _q The pose to convert

Returns: An ignition::math::Pose object

§ ConvertIgn() [5/5]

GAZEBO_VISIBLE ignition::math::Planed gazebo::msgs::ConvertIgn ( const msgs::PlaneGeom & _p )

Convert a msgs::PlaneGeom to an ignition::math::Planed.

Parameters

[in] _p The plane to convert

Returns: An ignition::math::Planed object

§ ConvertJointType() [1/2]

GAZEBO_VISIBLE msgs::Joint::Type gazebo::msgs::ConvertJointType ( const std::string & _str )

Convert a string to a msgs::Joint::Type enum.

Parameters

[in] _str Joint type string.

Returns: A msgs::Joint::Type enum. Defaults to REVOLUTE if _str is unrecognized.

§ ConvertJointType() [2/2]

GAZEBO_VISIBLE std::string gazebo::msgs::ConvertJointType ( const msgs::Joint::Type & _type )

Convert a msgs::Joint::Type to a string.

Parameters

[in] _type A msgs::Joint::Type enum.

Returns: Joint type string. Returns "unknown" if _type is unrecognized.

§ ConvertShaderType() [1/2]

GAZEBO_VISIBLE msgs::Material::ShaderType gazebo::msgs::ConvertShaderType ( const std::string & _str )

Convert a string to a msgs::Material::ShaderType enum.

Parameters

[in] _str Shader type string.

Returns: A msgs::Material::ShaderType enum. Defaults to VERTEX if _str is unrecognized.

§ ConvertShaderType() [2/2]

GAZEBO_VISIBLE std::string gazebo::msgs::ConvertShaderType ( const msgs::Material::ShaderType & _type )

Convert a msgs::ShaderType to a string.

Parameters

[in] _type A msgs::ShaderType enum.

Returns: Shader type string. Returns "unknown" if _type is unrecognized.

§ CreateRequest()

GAZEBO_VISIBLE msgs::Request* gazebo::msgs::CreateRequest	(	const std::string &	_request,
		const std::string &	_data = `""`
	)

Create a request message.

Parameters

[in]	_request	Request string
[in]	_data	Optional data string

Returns: A Request message

§ FogFromSDF()

GAZEBO_VISIBLE msgs::Fog gazebo::msgs::FogFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Fog from a fog SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Fog object

§ FrictionFromSDF()

GAZEBO_VISIBLE msgs::Friction gazebo::msgs::FrictionFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Friction from a friction SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Friction object

§ GeometryFromSDF()

GAZEBO_VISIBLE msgs::Geometry gazebo::msgs::GeometryFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Geometry from a geometry SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Geometry object

§ GeometryToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::GeometryToSDF	(	const msgs::Geometry &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Geometry If _sdf is supplied and the _msg has non-empty repeated elements, any existing sdf elements will be removed from _sdf prior to adding the new elements from _msg.

Parameters

[in]	_msg	Geometry messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ GetHeader()

GAZEBO_VISIBLE msgs::Header* gazebo::msgs::GetHeader ( google::protobuf::Message & _message )

Get the header from a protobuf message.

Parameters

[in] _message A google protobuf message

Returns: A pointer to the message's header

§ GUIFromSDF()

GAZEBO_VISIBLE msgs::GUI gazebo::msgs::GUIFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::GUI from a GUI SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::GUI object

§ InertialToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::InertialToSDF	(	const msgs::Inertial &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Inertial.

Parameters

[in]	_msg	Inertial messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ Init()

GAZEBO_VISIBLE void gazebo::msgs::Init	(	google::protobuf::Message &	_message,
		const std::string &	_id = `""`
	)

Initialize a message.

Parameters

[in]	_message	Message to initialize
[in]	_id	Optional string id

Referenced by FixedJoint< BulletJoint >::Init(), HingeJoint< BulletJoint >::Init(), BallJoint< BulletJoint >::Init(), UniversalJoint< BulletJoint >::Init(), GearboxJoint< ODEJoint >::Init(), and ScrewJoint< BulletJoint >::Init().

§ JointFromSDF()

GAZEBO_VISIBLE msgs::Joint gazebo::msgs::JointFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Joint from a joint SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Joint object

§ JointToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::JointToSDF	(	const msgs::Joint &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from msgs::Joint.

Parameters

[in]	_msg	The msgs::Joint object.
[in]	_sdf	if supplied, performs an update from _sdf instead of creating a new sdf element.

Returns: The new SDF element.

§ LightFromSDF()

GAZEBO_VISIBLE msgs::Light gazebo::msgs::LightFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Light from a light SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Light object

§ LightToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::LightToSDF	(	const msgs::Light &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Light.

Parameters

[in]	_msg	Light messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ LinkToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::LinkToSDF	(	const msgs::Link &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Link.

If _sdf is supplied and _msg has any collisions or visuals, the <collision> and <visual> elements will be removed from _sdf.

Parameters

[in]	_msg	Link messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ MaterialToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::MaterialToSDF	(	const msgs::Material &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Material If _sdf is supplied and _msg has script uri's the <uri> elements will be removed from _sdf.

Parameters

[in]	_msg	Material messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ MeshFromSDF()

GAZEBO_VISIBLE msgs::MeshGeom gazebo::msgs::MeshFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::MeshGeom from a mesh SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::MeshGeom object

§ MeshToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::MeshToSDF	(	const msgs::MeshGeom &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Mesh.

Parameters

[in]	_msg	Mesh messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ ModelToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::ModelToSDF	(	const msgs::Model &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from msgs::Model.

If _sdf is supplied and _msg has any links or joints, the <link> and <joint> elements will be removed from _sdf.

Parameters

[in]	_msg	The msgs::Model object.
[in]	_sdf	if supplied, performs an update from _sdf instead of creating a new sdf element.

Returns: The new SDF element.

§ PluginFromSDF()

GAZEBO_VISIBLE msgs::Plugin gazebo::msgs::PluginFromSDF ( const sdf::ElementPtr _sdf )

Create a msgs::Plugin from a plugin SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Plugin object

§ PluginToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::PluginToSDF	(	const msgs::Plugin &	_plugin,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Plugin.

Parameters

[in]	_msg	Plugin messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ RaySensorFromSDF()

GAZEBO_VISIBLE msgs::RaySensor gazebo::msgs::RaySensorFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::RaySensor from a ray sensor SDF element.

Parameters

[in] _sdf The ray sensor sdf element

Returns: The new msgs::RaySensor object

See also: SensorFromSDF

§ SceneFromSDF()

GAZEBO_VISIBLE msgs::Scene gazebo::msgs::SceneFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Scene from a scene SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Scene object

§ SensorFromSDF()

GAZEBO_VISIBLE msgs::Sensor gazebo::msgs::SensorFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Sensor from a sensor SDF element.

Parameters

[in] _sdf The sensor sdf element

Returns: The new msgs::Sensor object

See also: CameraSensorFromSDF; RaySensorFromSDF; ContactSensorFromSDF

§ Set() [1/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	common::Image &	_img,
		const msgs::Image &	_msg
	)

Convert a msgs::Image to a common::Image.

Parameters

[out]	_img	The common::Image container
[in]	_msg	The Image message to convert

§ Set() [2/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Image *	_msg,
		const common::Image &	_i
	)

Set a msgs::Image from a common::Image.

Parameters

[out]	_msg	A msgs::Image pointer
[in]	_i	A common::Image reference

§ Set() [3/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Vector3d *	_pt,
		const ignition::math::Vector3d &	_v
	)

Set a msgs::Vector3d from an ignition::math::Vector3d.

Parameters

[out]	_pt	A msgs::Vector3d pointer
[in]	_v	An ignition::math::Vector3d reference

§ Set() [4/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Vector2d *	_pt,
		const ignition::math::Vector2d &	_v
	)

Set a msgs::Vector2d from an ignition::math::Vector2d.

Parameters

[out]	_pt	A msgs::Vector2d pointer
[in]	_v	An ignition::math::Vector2d reference

§ Set() [5/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Quaternion *	_q,
		const ignition::math::Quaterniond &	_v
	)

Set a msgs::Quaternion from an ignition::math::Quaterniond.

Parameters

[out]	_q	A msgs::Quaternion pointer
[in]	_v	An ignition::math::Quaterniond reference

§ Set() [6/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Pose *	_p,
		const ignition::math::Pose3d &	_v
	)

Set a msgs::Pose from an ignition::math::Pose3d.

Parameters

[out]	_p	A msgs::Pose pointer
[in]	_v	An ignition::math::Pose3d reference

§ Set() [7/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Color *	_c,
		const common::Color &	_v
	)

Set a msgs::Color from a common::Color.

Parameters

[out]	_p	A msgs::Color pointer
[in]	_v	A common::Color reference

§ Set() [8/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::Time *	_t,
		const common::Time &	_v
	)

Set a msgs::Time from a common::Time.

Parameters

[out]	_p	A msgs::Time pointer
[in]	_v	A common::Time reference

§ Set() [9/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::SphericalCoordinates *	_s,
		const common::SphericalCoordinates &	_v
	)

Set a msgs::SphericalCoordinates from a common::SphericalCoordinates object.

Parameters

[out]	_p	A msgs::SphericalCoordinates pointer.
[in]	_v	A common::SphericalCoordinates reference

§ Set() [10/10]

GAZEBO_VISIBLE void gazebo::msgs::Set	(	msgs::PlaneGeom *	_p,
		const ignition::math::Planed &	_v
	)

Set a msgs::Plane from an ignition::math::Planed.

Parameters

[out]	_p	A msgs::Plane pointer
[in]	_v	An ignition::math::Planed reference

§ Stamp() [1/2]

GAZEBO_VISIBLE void gazebo::msgs::Stamp ( msgs::Header * _header )

Time stamp a header.

Parameters

[in] _header Header to stamp

§ Stamp() [2/2]

GAZEBO_VISIBLE void gazebo::msgs::Stamp ( msgs::Time * _time )

Set the time in a time message.

Parameters

[in] _time A Time message

§ SurfaceFromSDF()

GAZEBO_VISIBLE msgs::Surface gazebo::msgs::SurfaceFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Surface from a surface SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Surface object

§ SurfaceToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::SurfaceToSDF	(	const msgs::Surface &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Surface.

Parameters

[in]	_msg	Surface messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

§ TrackVisualFromSDF()

GAZEBO_VISIBLE msgs::TrackVisual gazebo::msgs::TrackVisualFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::TrackVisual from a track visual SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::TrackVisual object

§ VisualFromSDF()

GAZEBO_VISIBLE msgs::Visual gazebo::msgs::VisualFromSDF ( sdf::ElementPtr _sdf )

Create a msgs::Visual from a visual SDF element.

Parameters

[in] _sdf The sdf element

Returns: The new msgs::Visual object

§ VisualToSDF()

GAZEBO_VISIBLE sdf::ElementPtr gazebo::msgs::VisualToSDF	(	const msgs::Visual &	_msg,
		sdf::ElementPtr	_sdf = `sdf::ElementPtr()`
	)

Create or update an SDF element from a msgs::Visual.

Parameters

[in]	_msg	Visual messsage
[in]	_sdf	if supplied, performs an update from _msg instead of creating a new sdf element.

Returns: The new SDF element.

Namespaces

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

§ GZ_REGISTER_STATIC_MSG

Function Documentation

§ AddBoxLink()

§ AddCylinderLink()

§ AddLinkGeom()

§ AddSphereLink()

§ AxisFromSDF()

§ CameraSensorFromSDF()

§ CameraSensorToSDF()

§ CollisionFromSDF()

§ CollisionToSDF()

§ ContactSensorFromSDF()

§ Convert() [1/9]

§ Convert() [2/9]

§ Convert() [3/9]

§ Convert() [4/9]

§ Convert() [5/9]

§ Convert() [6/9]

§ Convert() [7/9]

§ Convert() [8/9]

§ Convert() [9/9]

§ ConvertGeometryType() [1/2]

§ ConvertGeometryType() [2/2]

§ ConvertIgn() [1/5]

§ ConvertIgn() [2/5]

§ ConvertIgn() [3/5]

§ ConvertIgn() [4/5]

§ ConvertIgn() [5/5]

§ ConvertJointType() [1/2]

§ ConvertJointType() [2/2]

§ ConvertShaderType() [1/2]

§ ConvertShaderType() [2/2]

§ CreateRequest()

§ FogFromSDF()

§ FrictionFromSDF()

§ GeometryFromSDF()

§ GeometryToSDF()

§ GetHeader()

§ GUIFromSDF()

§ InertialToSDF()

§ Init()

§ JointFromSDF()

§ JointToSDF()

§ LightFromSDF()

§ LightToSDF()

§ LinkToSDF()

§ MaterialToSDF()

§ MeshFromSDF()

§ MeshToSDF()

§ ModelToSDF()

§ PluginFromSDF()

§ PluginToSDF()

§ RaySensorFromSDF()

§ SceneFromSDF()

§ SensorFromSDF()

§ Set() [1/10]

§ Set() [2/10]

§ Set() [3/10]

§ Set() [4/10]

§ Set() [5/10]

§ Set() [6/10]

§ Set() [7/10]

§ Set() [8/10]

§ Set() [9/10]

§ Set() [10/10]

§ Stamp() [1/2]

§ Stamp() [2/2]

§ SurfaceFromSDF()

§ SurfaceToSDF()

§ TrackVisualFromSDF()

§ VisualFromSDF()

§ VisualToSDF()