Namespaces | Classes | Macros | Functions
Messages

All messages and helper functions. More...

Namespaces

 gazebo::msgs
 Messages namespace.
 

Classes

class  google::protobuf::compiler::cpp::GazeboGenerator
 Google protobuf message generator for gazebo::msgs. More...
 
class  gazebo::msgs::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 gazebo::msgs::AddBoxLink (msgs::Model &_model, const double _mass, const math::Vector3 &_size) GAZEBO_DEPRECATED(6.0)
 Add a simple box link to a Model message. More...
 
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. More...
 
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. More...
 
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. More...
 
GAZEBO_VISIBLE void gazebo::msgs::AddSphereLink (msgs::Model &_model, const double _mass, const double _radius)
 Add a simple sphere link to a Model message. More...
 
GAZEBO_VISIBLE msgs::Axis gazebo::msgs::AxisFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Axis from an axis SDF element. More...
 
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. More...
 
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. More...
 
GAZEBO_VISIBLE msgs::Vector3d gazebo::msgs::Convert (const math::Vector3 &_v) GAZEBO_DEPRECATED(6.0)
 Convert a math::Vector3 to a msgs::Vector3d. More...
 
GAZEBO_VISIBLE msgs::Vector2d gazebo::msgs::Convert (const math::Vector2d &_v) GAZEBO_DEPRECATED(6.0)
 Convert a math::Vector2d to a msgs::Vector2d. More...
 
GAZEBO_VISIBLE msgs::Quaternion gazebo::msgs::Convert (const math::Quaternion &_q) GAZEBO_DEPRECATED(6.0)
 Convert a math::Quaternion to a msgs::Quaternion. More...
 
GAZEBO_VISIBLE msgs::Pose gazebo::msgs::Convert (const math::Pose &_p) GAZEBO_DEPRECATED(6.0)
 Convert a math::Pose to a msgs::Pose. More...
 
GAZEBO_VISIBLE msgs::Vector3d gazebo::msgs::Convert (const ignition::math::Vector3d &_v)
 Convert a ignition::math::Vector3 to a msgs::Vector3d. More...
 
GAZEBO_VISIBLE msgs::Vector2d gazebo::msgs::Convert (const ignition::math::Vector2d &_v)
 Convert a ignition::math::Vector2d to a msgs::Vector2d. More...
 
GAZEBO_VISIBLE msgs::Quaternion gazebo::msgs::Convert (const ignition::math::Quaterniond &_q)
 Convert a ignition::math::Quaternion to a msgs::Quaternion. More...
 
GAZEBO_VISIBLE msgs::Pose gazebo::msgs::Convert (const ignition::math::Pose3d &_p)
 Convert a ignition::math::Pose to a msgs::Pose. More...
 
GAZEBO_VISIBLE msgs::Color gazebo::msgs::Convert (const common::Color &_c)
 Convert a common::Color to a msgs::Color. More...
 
GAZEBO_VISIBLE msgs::Time gazebo::msgs::Convert (const common::Time &_t)
 Convert a common::Time to a msgs::Time. More...
 
GAZEBO_VISIBLE msgs::PlaneGeom gazebo::msgs::Convert (const math::Plane &_p) GAZEBO_DEPRECATED(6.0)
 Convert a math::Plane to a msgs::PlaneGeom. More...
 
GAZEBO_VISIBLE msgs::PlaneGeom gazebo::msgs::Convert (const ignition::math::Planed &_p)
 Convert a ignition::math::Planed to a msgs::PlaneGeom. More...
 
GAZEBO_VISIBLE math::Vector3 gazebo::msgs::Convert (const msgs::Vector3d &_v) GAZEBO_DEPRECATED(6.0)
 Convert a msgs::Vector3d to a math::Vector. More...
 
GAZEBO_VISIBLE math::Vector2d gazebo::msgs::Convert (const msgs::Vector2d &_v) GAZEBO_DEPRECATED(6.0)
 Convert a msgs::Vector2d to a math::Vector2d. More...
 
GAZEBO_VISIBLE math::Quaternion gazebo::msgs::Convert (const msgs::Quaternion &_q) GAZEBO_DEPRECATED(6.0)
 Convert a msgs::Quaternion to a math::Quaternion. More...
 
GAZEBO_VISIBLE math::Pose gazebo::msgs::Convert (const msgs::Pose &_p) GAZEBO_DEPRECATED(6.0)
 Convert a msgs::Pose to a math::Pose. More...
 
GAZEBO_VISIBLE common::Color gazebo::msgs::Convert (const msgs::Color &_c)
 Convert a msgs::Color to a common::Color. More...
 
GAZEBO_VISIBLE common::Time gazebo::msgs::Convert (const msgs::Time &_t)
 Convert a msgs::Time to a common::Time. More...
 
GAZEBO_VISIBLE math::Plane gazebo::msgs::Convert (const msgs::PlaneGeom &_p) GAZEBO_DEPRECATED(6.0)
 Convert a msgs::PlaneGeom to a math::Plane. More...
 
GAZEBO_VISIBLE msgs::Geometry::Type gazebo::msgs::ConvertGeometryType (const std::string &_str)
 Convert a string to a msgs::Geometry::Type enum. More...
 
GAZEBO_VISIBLE std::string gazebo::msgs::ConvertGeometryType (const msgs::Geometry::Type _type)
 Convert a msgs::Geometry::Type to a string. More...
 
GAZEBO_VISIBLE
ignition::math::Vector3d 
gazebo::msgs::ConvertIgn (const msgs::Vector3d &_v)
 Convert a msgs::Vector3d to an ignition::math::Vector. More...
 
GAZEBO_VISIBLE
ignition::math::Vector2d 
gazebo::msgs::ConvertIgn (const msgs::Vector2d &_v)
 Convert a msgs::Vector2d to an ignition::math::Vector2d. More...
 
GAZEBO_VISIBLE
ignition::math::Quaterniond 
gazebo::msgs::ConvertIgn (const msgs::Quaternion &_q)
 Convert a msgs::Quaternion to an ignition::math::Quaternion. More...
 
GAZEBO_VISIBLE
ignition::math::Pose3d 
gazebo::msgs::ConvertIgn (const msgs::Pose &_p)
 Convert a msgs::Pose to an ignition::math::Pose. More...
 
GAZEBO_VISIBLE
ignition::math::Planed 
gazebo::msgs::ConvertIgn (const msgs::PlaneGeom &_p)
 Convert a msgs::PlaneGeom to an ignition::math::Planed. More...
 
GAZEBO_VISIBLE msgs::Joint::Type gazebo::msgs::ConvertJointType (const std::string &_str)
 Convert a string to a msgs::Joint::Type enum. More...
 
GAZEBO_VISIBLE std::string gazebo::msgs::ConvertJointType (const msgs::Joint::Type &_type)
 Convert a msgs::Joint::Type to a string. More...
 
GAZEBO_VISIBLE
msgs::Material::ShaderType 
gazebo::msgs::ConvertShaderType (const std::string &_str)
 Convert a string to a msgs::Material::ShaderType enum. More...
 
GAZEBO_VISIBLE std::string gazebo::msgs::ConvertShaderType (const msgs::Material::ShaderType &_type)
 Convert a msgs::ShaderType to a string. More...
 
GAZEBO_VISIBLE msgs::Request * gazebo::msgs::CreateRequest (const std::string &_request, const std::string &_data="")
 Create a request message. More...
 
GAZEBO_VISIBLE msgs::Fog gazebo::msgs::FogFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Fog from a fog SDF element. More...
 
GAZEBO_VISIBLE msgs::Geometry gazebo::msgs::GeometryFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Geometry from a geometry SDF element. More...
 
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. More...
 
GAZEBO_VISIBLE msgs::Header * gazebo::msgs::GetHeader (google::protobuf::Message &_message)
 Get the header from a protobuf message. More...
 
GAZEBO_VISIBLE msgs::GUI gazebo::msgs::GUIFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::GUI from a GUI SDF element. More...
 
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. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Init (google::protobuf::Message &_message, const std::string &_id="")
 Initialize a message. More...
 
GAZEBO_VISIBLE msgs::Joint gazebo::msgs::JointFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Joint from a joint SDF element. More...
 
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. More...
 
GAZEBO_VISIBLE msgs::Light gazebo::msgs::LightFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Light from a light SDF element. More...
 
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. More...
 
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. More...
 
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. More...
 
GAZEBO_VISIBLE msgs::MeshGeom gazebo::msgs::MeshFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::MeshGeom from a mesh SDF element. More...
 
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. More...
 
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. More...
 
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. More...
 
GAZEBO_VISIBLE msgs::Scene gazebo::msgs::SceneFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Scene from a scene SDF element. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (common::Image &_img, const msgs::Image &_msg)
 Convert a msgs::Image to a common::Image. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Image *_msg, const common::Image &_i)
 Set a msgs::Image from a common::Image. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Vector3d *_pt, const math::Vector3 &_v) GAZEBO_DEPRECATED(6.0)
 Set a msgs::Vector3d from a math::Vector3. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Vector2d *_pt, const math::Vector2d &_v) GAZEBO_DEPRECATED(6.0)
 Set a msgs::Vector2d from a math::Vector3. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Quaternion *_q, const math::Quaternion &_v) GAZEBO_DEPRECATED(6.0)
 Set a msgs::Quaternion from a math::Quaternion. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Pose *_p, const math::Pose &_v) GAZEBO_DEPRECATED(6.0)
 Set a msgs::Pose from a math::Pose. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Vector3d *_pt, const ignition::math::Vector3d &_v)
 Set a msgs::Vector3d from an ignition::math::Vector3d. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Vector2d *_pt, const ignition::math::Vector2d &_v)
 Set a msgs::Vector2d from an ignition::math::Vector2d. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Quaternion *_q, const ignition::math::Quaterniond &_v)
 Set a msgs::Quaternion from an ignition::math::Quaterniond. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Pose *_p, const ignition::math::Pose3d &_v)
 Set a msgs::Pose from an ignition::math::Pose3d. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Color *_c, const common::Color &_v)
 Set a msgs::Color from a common::Color. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::Time *_t, const common::Time &_v)
 Set a msgs::Time from a common::Time. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::SphericalCoordinates *_s, const common::SphericalCoordinates &_v)
 Set a msgs::SphericalCoordinates from a common::SphericalCoordinates object. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::PlaneGeom *_p, const math::Plane &_v) GAZEBO_DEPRECATED(6.0)
 Set a msgs::Plane from a math::Plane. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Set (msgs::PlaneGeom *_p, const ignition::math::Planed &_v)
 Set a msgs::Plane from an ignition::math::Planed. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Stamp (msgs::Header *_header)
 Time stamp a header. More...
 
GAZEBO_VISIBLE void gazebo::msgs::Stamp (msgs::Time *_time)
 Set the time in a time message. More...
 
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. More...
 
GAZEBO_VISIBLE msgs::TrackVisual gazebo::msgs::TrackVisualFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::TrackVisual from a track visual SDF element. More...
 
GAZEBO_VISIBLE msgs::Visual gazebo::msgs::VisualFromSDF (sdf::ElementPtr _sdf)
 Create a msgs::Visual from a visual SDF element. More...
 
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. More...
 

Detailed Description

All messages and helper functions.

Macro Definition Documentation

#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 void RegisterMsg(const std::string &_msgType, MsgFactoryFn _factoryfn)
Register a message.
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system.hh:66

Static message registration macro.

Use this macro to register messages.

Parameters
[in]_msgtypeMessage type name.
[in]_classnameClass name for message.

Function Documentation

GAZEBO_VISIBLE void gazebo::msgs::AddBoxLink ( msgs::Model &  _model,
const double  _mass,
const math::Vector3 &  _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]_modelThe msgs::Model to which the link is added.
[in]_massMass of the box.
[in]_sizeSize of the box.
Deprecated:
See AddBoxLink() function that accepts an ignition::math::Vector3d object.
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]_modelThe msgs::Model to which the link is added.
[in]_massMass of the box.
[in]_sizeSize of the box.
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]_modelThe msgs::Model to which the link is added.
[in]_massMass of the cylinder.
[in]_radiusRadius of the cylinder.
[in]_lengthLength of the cylinder.
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]_modelThe msgs::Model object to receive a new link.
[in]_geomGeometry to be added to collision and visual.
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]_modelThe msgs::Model to which the link is added.
[in]_massMass of the sphere.
[in]_radiusRadius of the sphere.
GAZEBO_VISIBLE msgs::Axis gazebo::msgs::AxisFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Axis object
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]_msgCameraSensor messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
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]_msgCollision messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE msgs::Vector3d gazebo::msgs::Convert ( const math::Vector3 &  _v)

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

Parameters
[in]_vThe vector to convert
Returns
A msgs::Vector3d object
Deprecated:
See function that accepts an ignition::math object.
GAZEBO_VISIBLE msgs::Vector2d gazebo::msgs::Convert ( const math::Vector2d &  _v)

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

Parameters
[in]_vThe vector to convert
Returns
A msgs::Vector2d object
Deprecated:
See function that accepts an ignition::math object.
GAZEBO_VISIBLE msgs::Quaternion gazebo::msgs::Convert ( const math::Quaternion &  _q)

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

Parameters
[in]_qThe quaternion to convert
Returns
A msgs::Quaternion object
Deprecated:
See function that accepts an ignition::math object.
GAZEBO_VISIBLE msgs::Pose gazebo::msgs::Convert ( const math::Pose &  _p)

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

Parameters
[in]_pThe pose to convert
Returns
A msgs::Pose object
Deprecated:
See function that accepts an ignition::math object.
GAZEBO_VISIBLE msgs::Vector3d gazebo::msgs::Convert ( const ignition::math::Vector3d &  _v)

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

Parameters
[in]_vThe vector to convert
Returns
A msgs::Vector3d object
GAZEBO_VISIBLE msgs::Vector2d gazebo::msgs::Convert ( const ignition::math::Vector2d &  _v)

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

Parameters
[in]_vThe vector to convert
Returns
A msgs::Vector2d object
GAZEBO_VISIBLE msgs::Quaternion gazebo::msgs::Convert ( const ignition::math::Quaterniond &  _q)

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

Parameters
[in]_qThe quaternion to convert
Returns
A msgs::Quaternion object
GAZEBO_VISIBLE msgs::Pose gazebo::msgs::Convert ( const ignition::math::Pose3d &  _p)

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

Parameters
[in]_pThe pose to convert
Returns
A msgs::Pose object
GAZEBO_VISIBLE msgs::Color gazebo::msgs::Convert ( const common::Color &  _c)

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

Parameters
[in]_cThe color to convert
Returns
A msgs::Color object
GAZEBO_VISIBLE msgs::Time gazebo::msgs::Convert ( const common::Time &  _t)

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

Parameters
[in]_tThe time to convert
Returns
A msgs::Time object
GAZEBO_VISIBLE msgs::PlaneGeom gazebo::msgs::Convert ( const math::Plane &  _p)

Convert a math::Plane to a msgs::PlaneGeom.

Parameters
[in]_pThe plane to convert
Returns
A msgs::PlaneGeom object
Deprecated:
See function that accepts an ignition::math object.
GAZEBO_VISIBLE msgs::PlaneGeom gazebo::msgs::Convert ( const ignition::math::Planed &  _p)

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

Parameters
[in]_pThe plane to convert
Returns
A msgs::PlaneGeom object
GAZEBO_VISIBLE math::Vector3 gazebo::msgs::Convert ( const msgs::Vector3d &  _v)

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

Parameters
[in]_vThe plane to convert
Returns
A math::Vector3 object
Deprecated:
See ConvertIgn() function that returns an ignition::math object.
GAZEBO_VISIBLE math::Vector2d gazebo::msgs::Convert ( const msgs::Vector2d &  _v)

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

Parameters
[in]_vThe vector2 to convert
Returns
A math::Vector2d object
Deprecated:
See ConvertIgn() function that returns an ignition::math object.
GAZEBO_VISIBLE math::Quaternion gazebo::msgs::Convert ( const msgs::Quaternion &  _q)

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

Parameters
[in]_qThe quaternion to convert
Returns
A math::Quaternion object
Deprecated:
See ConvertIgn() function that returns an ignition::math object.
GAZEBO_VISIBLE math::Pose gazebo::msgs::Convert ( const msgs::Pose &  _p)

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

Parameters
[in]_qThe pose to convert
Returns
A math::Pose object
Deprecated:
See ConvertIgn() function that returns an ignition::math object.
GAZEBO_VISIBLE common::Color gazebo::msgs::Convert ( const msgs::Color &  _c)

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

Parameters
[in]_cThe color to convert
Returns
A common::Color object
GAZEBO_VISIBLE common::Time gazebo::msgs::Convert ( const msgs::Time &  _t)

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

Parameters
[in]_tThe time to convert
Returns
A common::Time object
GAZEBO_VISIBLE math::Plane gazebo::msgs::Convert ( const msgs::PlaneGeom &  _p)

Convert a msgs::PlaneGeom to a math::Plane.

Parameters
[in]_pThe plane to convert
Returns
A math::Plane object
Deprecated:
See ConvertIgn() function that returns an ignition::math object.
GAZEBO_VISIBLE msgs::Geometry::Type gazebo::msgs::ConvertGeometryType ( const std::string &  _str)

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

Parameters
[in]_strGeometry type string.
Returns
A msgs::Geometry::Type enum.
GAZEBO_VISIBLE std::string gazebo::msgs::ConvertGeometryType ( const msgs::Geometry::Type  _type)

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

Parameters
[in]_typeA msgs::Geometry::Type enum.
Returns
Geometry type string.
GAZEBO_VISIBLE ignition::math::Vector3d gazebo::msgs::ConvertIgn ( const msgs::Vector3d &  _v)

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

Parameters
[in]_vThe plane to convert
Returns
An ignition::math::Vector3 object
GAZEBO_VISIBLE ignition::math::Vector2d gazebo::msgs::ConvertIgn ( const msgs::Vector2d &  _v)

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

Parameters
[in]_vThe vector2 to convert
Returns
An ignition::math::Vector2d object
GAZEBO_VISIBLE ignition::math::Quaterniond gazebo::msgs::ConvertIgn ( const msgs::Quaternion &  _q)

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

Parameters
[in]_qThe quaternion to convert
Returns
An ignition::math::Quaternion object
GAZEBO_VISIBLE ignition::math::Pose3d gazebo::msgs::ConvertIgn ( const msgs::Pose &  _p)

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

Parameters
[in]_qThe pose to convert
Returns
An ignition::math::Pose object
GAZEBO_VISIBLE ignition::math::Planed gazebo::msgs::ConvertIgn ( const msgs::PlaneGeom &  _p)

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

Parameters
[in]_pThe plane to convert
Returns
An ignition::math::Planed object
GAZEBO_VISIBLE msgs::Joint::Type gazebo::msgs::ConvertJointType ( const std::string &  _str)

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

Parameters
[in]_strJoint type string.
Returns
A msgs::Joint::Type enum. Defaults to REVOLUTE if _str is unrecognized.
GAZEBO_VISIBLE std::string gazebo::msgs::ConvertJointType ( const msgs::Joint::Type &  _type)

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

Parameters
[in]_typeA msgs::Joint::Type enum.
Returns
Joint type string. Returns "unknown" if _type is unrecognized.
GAZEBO_VISIBLE msgs::Material::ShaderType gazebo::msgs::ConvertShaderType ( const std::string &  _str)

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

Parameters
[in]_strShader type string.
Returns
A msgs::Material::ShaderType enum. Defaults to VERTEX if _str is unrecognized.
GAZEBO_VISIBLE std::string gazebo::msgs::ConvertShaderType ( const msgs::Material::ShaderType &  _type)

Convert a msgs::ShaderType to a string.

Parameters
[in]_typeA msgs::ShaderType enum.
Returns
Shader type string. Returns "unknown" if _type is unrecognized.
GAZEBO_VISIBLE msgs::Request* gazebo::msgs::CreateRequest ( const std::string &  _request,
const std::string &  _data = "" 
)

Create a request message.

Parameters
[in]_requestRequest string
[in]_dataOptional data string
Returns
A Request message
GAZEBO_VISIBLE msgs::Fog gazebo::msgs::FogFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Fog object
GAZEBO_VISIBLE msgs::Geometry gazebo::msgs::GeometryFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Geometry object
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]_msgGeometry messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE msgs::Header* gazebo::msgs::GetHeader ( google::protobuf::Message &  _message)

Get the header from a protobuf message.

Parameters
[in]_messageA google protobuf message
Returns
A pointer to the message's header
GAZEBO_VISIBLE msgs::GUI gazebo::msgs::GUIFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::GUI object
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]_msgInertial messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE void gazebo::msgs::Init ( google::protobuf::Message &  _message,
const std::string &  _id = "" 
)
GAZEBO_VISIBLE msgs::Joint gazebo::msgs::JointFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Joint object
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]_msgThe msgs::Joint object.
[in]_sdfif supplied, performs an update from _sdf instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE msgs::Light gazebo::msgs::LightFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Light object
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]_msgLight messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
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]_msgLink messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
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]_msgMaterial messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE msgs::MeshGeom gazebo::msgs::MeshFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::MeshGeom object
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]_msgMesh messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
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]_msgThe msgs::Model object.
[in]_sdfif supplied, performs an update from _sdf instead of creating a new sdf element.
Returns
The new SDF element.
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]_msgPlugin messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE msgs::Scene gazebo::msgs::SceneFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Scene object
GAZEBO_VISIBLE void gazebo::msgs::Set ( common::Image &  _img,
const msgs::Image &  _msg 
)

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

Parameters
[out]_imgThe common::Image container
[in]_msgThe Image message to convert

Referenced by gazebo::gui::DirectionalLightMaker::DirectionalLightMaker(), and gazebo::gui::SpotLightMaker::SpotLightMaker().

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

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

Parameters
[out]_msgA msgs::Image pointer
[in]_iA common::Image reference
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::Vector3d *  _pt,
const math::Vector3 &  _v 
)

Set a msgs::Vector3d from a math::Vector3.

Parameters
[out]_ptA msgs::Vector3d pointer
[in]_vA math::Vector3 reference
Deprecated:
See Set() function that accepts an ignition::math::Vector3d object.
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::Vector2d *  _pt,
const math::Vector2d &  _v 
)

Set a msgs::Vector2d from a math::Vector3.

Parameters
[out]_ptA msgs::Vector2d pointer
[in]_vA math::Vector2d reference
Deprecated:
See Set() function that accepts an ignition::math::Vector2d object.
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::Quaternion *  _q,
const math::Quaternion &  _v 
)

Set a msgs::Quaternion from a math::Quaternion.

Parameters
[out]_qA msgs::Quaternion pointer
[in]_vA math::Quaternion reference
Deprecated:
See Set() function that accepts an ignition::math::Quaterniond object.
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::Pose *  _p,
const math::Pose &  _v 
)

Set a msgs::Pose from a math::Pose.

Parameters
[out]_pA msgs::Pose pointer
[in]_vA math::Pose reference
Deprecated:
See Set() function that accepts an ignition::math::Pose3d object.
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]_ptA msgs::Vector3d pointer
[in]_vAn ignition::math::Vector3d reference
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]_ptA msgs::Vector2d pointer
[in]_vAn ignition::math::Vector2d reference
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]_qA msgs::Quaternion pointer
[in]_vAn ignition::math::Quaterniond reference
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]_pA msgs::Pose pointer
[in]_vAn ignition::math::Pose3d reference
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::Color *  _c,
const common::Color &  _v 
)

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

Parameters
[out]_pA msgs::Color pointer
[in]_vA common::Color reference
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::Time *  _t,
const common::Time &  _v 
)

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

Parameters
[out]_pA msgs::Time pointer
[in]_vA common::Time reference
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::SphericalCoordinates *  _s,
const common::SphericalCoordinates &  _v 
)

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

Parameters
[out]_pA msgs::SphericalCoordinates pointer.
[in]_vA common::SphericalCoordinates reference
GAZEBO_VISIBLE void gazebo::msgs::Set ( msgs::PlaneGeom *  _p,
const math::Plane &  _v 
)

Set a msgs::Plane from a math::Plane.

Parameters
[out]_pA msgs::Plane pointer
[in]_vA math::Plane reference
Deprecated:
See Set() function that accepts an ignition::math::Planed object.
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]_pA msgs::Plane pointer
[in]_vAn ignition::math::Planed reference
GAZEBO_VISIBLE void gazebo::msgs::Stamp ( msgs::Header *  _header)

Time stamp a header.

Parameters
[in]_headerHeader to stamp
GAZEBO_VISIBLE void gazebo::msgs::Stamp ( msgs::Time *  _time)

Set the time in a time message.

Parameters
[in]_timeA Time message
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]_msgSurface messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.
GAZEBO_VISIBLE msgs::TrackVisual gazebo::msgs::TrackVisualFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::TrackVisual object
GAZEBO_VISIBLE msgs::Visual gazebo::msgs::VisualFromSDF ( sdf::ElementPtr  _sdf)

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

Parameters
[in]_sdfThe sdf element
Returns
The new msgs::Visual object
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]_msgVisual messsage
[in]_sdfif supplied, performs an update from _msg instead of creating a new sdf element.
Returns
The new SDF element.