Gazebo is a leading open source robotics simulator, that provides high fidelity physics, rendering, and sensor simulation. More...
Namespaces | |
components | |
Components represent data, such as position information. An Entity usually has one or more associated components. | |
events | |
Namespace for all events. Refer to the EventManager class for more information about events. | |
gui | |
serializers | |
A Serializer class is used to serialize and deserialize a component. It is passed in as the third template parameter to components::Component. Eg. | |
systems | |
Namespace for all System plugins. Refer to the System class for more information about systems. | |
traits | |
Classes | |
class | EntityComponentManager |
The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent . More... | |
class | EventManager |
The EventManager is used to send/receive notifications of simulator events. More... | |
class | GuiRunner |
Responsible for running GUI systems as new states are received from the backend. More... | |
class | GuiSystem |
Base class for a GUI System. More... | |
class | ISystemConfigure |
Interface for a system that implements optional configuration. More... | |
class | ISystemPostUpdate |
Interface for a system that uses the PostUpdate phase. More... | |
class | ISystemPreUpdate |
Interface for a system that uses the PreUpdate phase. More... | |
class | ISystemUpdate |
Interface for a system that uses the Update phase. More... | |
class | Link |
This class provides wrappers around entities and components which are more convenient and straight-forward to use than dealing with the EntityComponentManager directly. All the functions provided here are meant to be used with a link entity. More... | |
class | MarkerManager |
Creates, deletes, and maintains marker visuals. Only the Scene class should instantiate and use this class. More... | |
class | Model |
This class provides wrappers around entities and components which are more convenient and straight-forward to use than dealing with the EntityComponentManager directly. All the functions provided here are meant to be used with a model entity. More... | |
class | RenderUtil |
class | SceneManager |
Scene manager class for loading and managing objects in the scene. More... | |
class | SdfEntityCreator |
Provides convenient functions to spawn entities and load their plugins from SDF elements, to remove them, and to change their hierarchy. More... | |
class | Server |
The server instantiates and controls simulation. More... | |
class | ServerConfig |
Configuration parameters for a Server. An instance of this object can be used to construct a Server with a particular configuration. More... | |
class | System |
Base class for a System. More... | |
class | SystemLoader |
Class for loading/unloading System plugins. More... | |
class | TmpIface |
Temporary place to prototype transport interfaces while it's not clear where they will live. More... | |
struct | UpdateInfo |
Information passed to systems on the update callback. More... | |
Typedefs | |
using | ComponentId = int |
A unique identifier for a component instance. The uniqueness of a ComponentId is scoped to the component's type. More... | |
using | ComponentKey = std::pair< ComponentTypeId, ComponentId > |
A key that uniquely identifies, at the global scope, a component instance. More... | |
using | ComponentTypeId = uint64_t |
A unique identifier for a component type. A component type must be derived from components::BaseComponent and can contain plain data or something more complex like ignition::math::Pose3d . More... | |
using | Entity = uint64_t |
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier. More... | |
using | EntityGraph = math::graph::DirectedGraph< Entity, bool > |
Type alias for the graph that holds entities. Each vertex is an entity, and the direction points from the parent to its children. All edges are positive booleans. More... | |
using | EntityQueryCallback = std::function< void(const UpdateInfo, EntityComponentManager &)> |
typedef for query callbacks More... | |
using | SystemPluginPtr = ignition::plugin::SpecializedPluginPtr< System, ISystemConfigure, ISystemPreUpdate, ISystemUpdate, ISystemPostUpdate > |
Enumerations | |
enum | ComponentState { NoChange = 0, PeriodicChange = 1, OneTimeChange = 2 } |
Possible states for a component. More... | |
Functions | |
std::string | asFullPath (const std::string &_uri, const std::string &_filePath) |
Combine a URI and a file path into a full path. If the URI is already a full path or contains a scheme, it won't be modified. If the URI is a relative path, the file path will be prepended. More... | |
template<class Out > | |
Out | convert (const sdf::Geometry &) |
Generic conversion from an SDF geometry to another type. More... | |
template<> | |
msgs::Geometry | convert (const sdf::Geometry &_in) |
Specialized conversion from an SDF geometry to a geometry message. More... | |
template<class Out > | |
Out | convert (const msgs::Pose &) |
Generic conversion from a msgs Pose to another type. More... | |
template<> | |
math::Pose3d | convert (const msgs::Pose &_in) |
Specialized conversion for msgs Pose to math Pose. More... | |
template<class Out > | |
Out | convert (const msgs::Geometry &) |
Generic conversion from a geometry message to another type. More... | |
template<> | |
sdf::Geometry | convert (const msgs::Geometry &_in) |
Specialized conversion from a geometry message to a geometry SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Material &) |
Generic conversion from an SDF material to another type. More... | |
template<> | |
msgs::Material | convert (const sdf::Material &_in) |
Specialized conversion from an SDF material to a material message. More... | |
template<class Out > | |
Out | convert (const msgs::Material &) |
Generic conversion from a material message to another type. More... | |
template<> | |
sdf::Material | convert (const msgs::Material &_in) |
Specialized conversion from a material message to a material SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Actor &) |
Generic conversion from an SDF actor to another type. More... | |
template<> | |
msgs::Actor | convert (const sdf::Actor &_in) |
Specialized conversion from an SDF actor to an actor message. More... | |
template<class Out > | |
Out | convert (const msgs::Actor &) |
Generic conversion from an actor message to another type. More... | |
template<> | |
sdf::Actor | convert (const msgs::Actor &_in) |
Specialized conversion from an actor message to an actor SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Light &) |
Generic conversion from an SDF light to another type. More... | |
template<> | |
msgs::Light | convert (const sdf::Light &_in) |
Specialized conversion from an SDF light to a light message. More... | |
template<class Out > | |
Out | convert (const msgs::Light &) |
Generic conversion from a light message to another type. More... | |
template<> | |
sdf::Light | convert (const msgs::Light &_in) |
Specialized conversion from a light message to a light SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Gui &) |
Generic conversion from an SDF gui to another type. More... | |
template<> | |
msgs::GUI | convert (const sdf::Gui &_in) |
Specialized conversion from an SDF gui to a gui message. More... | |
template<class Out > | |
Out | convert (const std::chrono::steady_clock::duration &) |
Generic conversion from a steady clock duration to another type. More... | |
template<> | |
msgs::Time | convert (const std::chrono::steady_clock::duration &_in) |
Specialized conversion from a steady clock duration to a time message. More... | |
template<class Out > | |
Out | convert (const msgs::Time &) |
Generic conversion from a time message to another type. More... | |
template<> | |
std::chrono::steady_clock::duration | convert (const msgs::Time &_in) |
Specialized conversion from a time message to a steady clock duration. More... | |
template<class Out > | |
Out | convert (const math::Inertiald &) |
Generic conversion from a math inertial to another type. More... | |
template<> | |
msgs::Inertial | convert (const math::Inertiald &_in) |
Specialized conversion from a math inertial to an inertial message. More... | |
template<class Out > | |
Out | convert (const msgs::Inertial &) |
Generic conversion from an inertial message to another type. More... | |
template<> | |
math::Inertiald | convert (const msgs::Inertial &_in) |
Specialized conversion from an inertial message to an inertial math object. More... | |
template<class Out > | |
Out | convert (const sdf::JointAxis &) |
Generic conversion from an SDF joint axis to another type. More... | |
template<> | |
msgs::Axis | convert (const sdf::JointAxis &_in) |
Specialized conversion from an SDF joint axis to an axis message. More... | |
template<class Out > | |
Out | convert (const msgs::Axis &) |
Generic conversion from an axis message to another type. More... | |
template<> | |
sdf::JointAxis | convert (const msgs::Axis &_in) |
Specialized conversion from an axis message to a joint axis SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Scene &) |
Generic conversion from an SDF scene to another type. More... | |
template<> | |
msgs::Scene | convert (const sdf::Scene &_in) |
Specialized conversion from an SDF scene to a scene message. More... | |
template<class Out > | |
Out | convert (const msgs::Scene &) |
Generic conversion from a scene message to another type. More... | |
template<> | |
sdf::Scene | convert (const msgs::Scene &_in) |
Specialized conversion from a scene message to a scene SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Atmosphere &) |
Generic conversion from an SDF atmosphere to another type. More... | |
template<> | |
msgs::Atmosphere | convert (const sdf::Atmosphere &_in) |
Specialized conversion from an SDF atmosphere to an atmosphere message. More... | |
template<class Out > | |
Out | convert (const msgs::Atmosphere &) |
Generic conversion from an atmosphere message to another type. More... | |
template<> | |
sdf::Atmosphere | convert (const msgs::Atmosphere &_in) |
Specialized conversion from an atmosphere message to an atmosphere SDF object. More... | |
template<class Out > | |
Out | convert (const sdf::Sensor &) |
Generic conversion from an SDF Sensor to another type. More... | |
template<> | |
msgs::Sensor | convert (const sdf::Sensor &_in) |
Specialized conversion from an SDF sensor to a sensor message. More... | |
template<class Out > | |
Out | convert (const msgs::Sensor &) |
Generic conversion from a sensor message to another type. More... | |
template<> | |
sdf::Sensor | convert (const msgs::Sensor &_in) |
Specialized conversion from a sensor message to a sensor SDF object. More... | |
template<class Out > | |
Out | convert (const msgs::SensorNoise &) |
Generic conversion from a sensor noise message to another type. More... | |
template<> | |
sdf::Noise | convert (const msgs::SensorNoise &_in) |
Specialized conversion from a sensor noise message to a noise SDF object. More... | |
template<class Out > | |
Out | convert (const msgs::WorldStatistics &) |
Generic conversion from a world statistics message to another type. More... | |
template<> | |
UpdateInfo | convert (const msgs::WorldStatistics &_in) |
Specialized conversion from a world statistics message to an UpdateInfo object. More... | |
template<class Out > | |
Out | convert (const UpdateInfo &) |
Generic conversion from update info to another type. More... | |
template<> | |
msgs::WorldStatistics | convert (const UpdateInfo &_in) |
Specialized conversion from update info to a world statistics message. More... | |
template<class Out > | |
Out | convert (const sdf::Collision &) |
Generic conversion from an SDF collision to another type. More... | |
template<> | |
msgs::Collision | convert (const sdf::Collision &_in) |
Specialized conversion from an SDF collision to a collision message. More... | |
template<class Out > | |
Out | convert (const msgs::Collision &) |
Generic conversion from a collision message to another type. More... | |
template<> | |
sdf::Collision | convert (const msgs::Collision &_in) |
Specialized conversion from a collision message to a collision SDF object. More... | |
template<class Out > | |
Out | convert (const std::string &) |
Generic conversion from a string to another type. More... | |
template<> | |
msgs::Entity_Type | convert (const std::string &_in) |
Specialized conversion from a string to an Entity_Type msg. More... | |
std::string | removeParentScope (const std::string &_name, const std::string &_delim) |
Helper function to remove a parent scope from a given name. This removes the first name found before the delimiter. More... | |
std::string | scopedName (const Entity &_entity, const EntityComponentManager &_ecm, const std::string &_delim="/", bool _includePrefix=true) |
Helper function to generate scoped name for an entity. More... | |
void | set (msgs::SensorNoise *_msg, const sdf::Noise &_sdf) |
Helper function that sets a mutable msgs::SensorNoise object to the values contained in a sdf::Noise object. More... | |
void | set (msgs::WorldStatistics *_msg, const UpdateInfo &_in) |
Helper function that sets a mutable msgs::WorldStatistics object to the values contained in a gazebo::UpdateInfo object. More... | |
void | set (msgs::Time *_msg, const std::chrono::steady_clock::duration &_in) |
Helper function that sets a mutable msgs::Time object to the values contained in a std::chrono::steady_clock::duration object. More... | |
math::Pose3d | worldPose (const Entity &_entity, const EntityComponentManager &_ecm) |
Helper function to compute world pose of an entity. More... | |
Variables | |
class IGNITION_GAZEBO_HIDDEN | EntityComponentManagerPrivate |
class IGNITION_GAZEBO_HIDDEN | EventManagerPrivate |
static const ComponentId | kComponentIdInvalid = -1 |
Id that indicates an invalid component. More... | |
static const ComponentTypeId | kComponentTypeIdInvalid = -1 |
Id that indicates an invalid component type. More... | |
const Entity | kNullEntity {0} |
Indicates a non-existant or invalid Entity. More... | |
class IGNITION_GAZEBO_HIDDEN | LinkPrivate |
class IGNITION_GAZEBO_HIDDEN | ModelPrivate |
class IGNITION_GAZEBO_HIDDEN | SystemLoaderPrivate |
Detailed Description
Gazebo is a leading open source robotics simulator, that provides high fidelity physics, rendering, and sensor simulation.
Typedef Documentation
◆ ComponentId
using ComponentId = int |
A unique identifier for a component instance. The uniqueness of a ComponentId is scoped to the component's type.
- See also
- ComponentKey.
◆ ComponentKey
using ComponentKey = std::pair<ComponentTypeId, ComponentId> |
A key that uniquely identifies, at the global scope, a component instance.
◆ ComponentTypeId
using ComponentTypeId = uint64_t |
A unique identifier for a component type. A component type must be derived from components::BaseComponent
and can contain plain data or something more complex like ignition::math::Pose3d
.
◆ Entity
using Entity = uint64_t |
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
An Entity usually has one or more associated Components. Components represent data, such as position information.
The set of Components assigned to an Entity also act as a key. Systems process Entities based on their key. For example, a physics system may process only entities that have pose and inertia components.
An Entity that needs to be identified and used by Systems should be created through the EntityComponentManager.
◆ EntityGraph
using EntityGraph = math::graph::DirectedGraph<Entity, bool> |
Type alias for the graph that holds entities. Each vertex is an entity, and the direction points from the parent to its children. All edges are positive booleans.
◆ EntityQueryCallback
using EntityQueryCallback = std::function<void (const UpdateInfo, EntityComponentManager &)> |
typedef for query callbacks
◆ SystemPluginPtr
using SystemPluginPtr = ignition::plugin::SpecializedPluginPtr< System, ISystemConfigure, ISystemPreUpdate, ISystemUpdate, ISystemPostUpdate > |
Enumeration Type Documentation
◆ ComponentState
|
strong |
Possible states for a component.
Function Documentation
◆ asFullPath()
std::string ignition::gazebo::asFullPath | ( | const std::string & | _uri, |
const std::string & | _filePath | ||
) |
Combine a URI and a file path into a full path. If the URI is already a full path or contains a scheme, it won't be modified. If the URI is a relative path, the file path will be prepended.
- Parameters
-
[in] _uri URI, which can have a scheme, or be full or relative paths. [in] _filePath The path to a file in disk.
- Returns
- The full path URI.
◆ convert() [1/56]
Out ignition::gazebo::convert | ( | const sdf::Geometry & | ) |
◆ convert() [2/56]
msgs::Geometry ignition::gazebo::convert | ( | const sdf::Geometry & | ) |
Specialized conversion from an SDF geometry to a geometry message.
- Parameters
-
[in] _in SDF geometry.
- Returns
- Geometry message.
Specialized conversion from an SDF geometry to a geometry message.
- Parameters
-
[in] _in SDF geometry.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
Referenced by convert().
◆ convert() [3/56]
Out ignition::gazebo::convert | ( | const msgs::Pose & | ) |
Generic conversion from a msgs Pose to another type.
Specialized conversion for msgs Pose to math Pose.
- Parameters
-
[in] _in msgs Pose
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [4/56]
math::Pose3d ignition::gazebo::convert | ( | const msgs::Pose & | ) |
Specialized conversion for msgs Pose to math Pose.
- Parameters
-
[in] _in msgs Pose
- Returns
- math Pose.
Specialized conversion for msgs Pose to math Pose.
- Parameters
-
[in] _in msgs Pose
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [5/56]
Out ignition::gazebo::convert | ( | const msgs::Geometry & | ) |
Generic conversion from a geometry message to another type.
Specialized conversion from a geometry message to a geometry SDF object.
- Parameters
-
[in] _in Geometry message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [6/56]
sdf::Geometry ignition::gazebo::convert | ( | const msgs::Geometry & | ) |
Specialized conversion from a geometry message to a geometry SDF object.
- Parameters
-
[in] _in Geometry message.
- Returns
- SDF geometry.
Specialized conversion from a geometry message to a geometry SDF object.
- Parameters
-
[in] _in Geometry message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [7/56]
Out ignition::gazebo::convert | ( | const sdf::Material & | ) |
Generic conversion from an SDF material to another type.
Specialized conversion from an SDF material to a material message.
- Parameters
-
[in] _in SDF material.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [8/56]
msgs::Material ignition::gazebo::convert | ( | const sdf::Material & | ) |
Specialized conversion from an SDF material to a material message.
- Parameters
-
[in] _in SDF material.
- Returns
- Material message.
Specialized conversion from an SDF material to a material message.
- Parameters
-
[in] _in SDF material.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [9/56]
Out ignition::gazebo::convert | ( | const msgs::Material & | ) |
Generic conversion from a material message to another type.
Specialized conversion from a material message to a material SDF object.
- Parameters
-
[in] _in Material message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [10/56]
sdf::Material ignition::gazebo::convert | ( | const msgs::Material & | ) |
Specialized conversion from a material message to a material SDF object.
- Parameters
-
[in] _in Material message.
- Returns
- SDF material.
Specialized conversion from a material message to a material SDF object.
- Parameters
-
[in] _in Material message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [11/56]
Out ignition::gazebo::convert | ( | const sdf::Actor & | ) |
Generic conversion from an SDF actor to another type.
Specialized conversion from an SDF actor to an actor message.
- Parameters
-
[in] _in SDF actor.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [12/56]
msgs::Actor ignition::gazebo::convert | ( | const sdf::Actor & | ) |
Specialized conversion from an SDF actor to an actor message.
- Parameters
-
[in] _in SDF actor.
- Returns
- Actor message.
Specialized conversion from an SDF actor to an actor message.
- Parameters
-
[in] _in SDF actor.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [13/56]
Out ignition::gazebo::convert | ( | const msgs::Actor & | ) |
Generic conversion from an actor message to another type.
Specialized conversion from an actor message to an actor SDF object.
- Parameters
-
[in] _in Actor message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [14/56]
sdf::Actor ignition::gazebo::convert | ( | const msgs::Actor & | ) |
Specialized conversion from an actor message to an actor SDF object.
- Parameters
-
[in] _in Actor message.
- Returns
- Actor SDF object.
Specialized conversion from an actor message to an actor SDF object.
- Parameters
-
[in] _in Actor message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [15/56]
Out ignition::gazebo::convert | ( | const sdf::Light & | ) |
Generic conversion from an SDF light to another type.
Specialized conversion from an SDF light to a light message.
- Parameters
-
[in] _in SDF light.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [16/56]
msgs::Light ignition::gazebo::convert | ( | const sdf::Light & | ) |
Specialized conversion from an SDF light to a light message.
- Parameters
-
[in] _in SDF light.
- Returns
- Light message.
Specialized conversion from an SDF light to a light message.
- Parameters
-
[in] _in SDF light.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [17/56]
Out ignition::gazebo::convert | ( | const msgs::Light & | ) |
Generic conversion from a light message to another type.
Specialized conversion from a light message to a light SDF object.
- Parameters
-
[in] _in Light message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [18/56]
sdf::Light ignition::gazebo::convert | ( | const msgs::Light & | ) |
Specialized conversion from a light message to a light SDF object.
- Parameters
-
[in] _in Light message.
- Returns
- Light SDF object.
Specialized conversion from a light message to a light SDF object.
- Parameters
-
[in] _in Light message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [19/56]
Out ignition::gazebo::convert | ( | const sdf::Gui & | ) |
Generic conversion from an SDF gui to another type.
Specialized conversion from an SDF gui to a gui message.
- Parameters
-
[in] _in SDF gui.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [20/56]
msgs::GUI ignition::gazebo::convert | ( | const sdf::Gui & | ) |
Specialized conversion from an SDF gui to a gui message.
- Parameters
-
[in] _in SDF gui.
- Returns
- Gui message.
Specialized conversion from an SDF gui to a gui message.
- Parameters
-
[in] _in SDF gui.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [21/56]
Out ignition::gazebo::convert | ( | const std::chrono::steady_clock::duration & | ) |
Generic conversion from a steady clock duration to another type.
Specialized conversion from a steady clock duration to a time message.
- Parameters
-
[in] _in Steady clock duration.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [22/56]
msgs::Time ignition::gazebo::convert | ( | const std::chrono::steady_clock::duration & | ) |
Specialized conversion from a steady clock duration to a time message.
- Parameters
-
[in] _in Steady clock duration.
- Returns
- Ignition time message.
Specialized conversion from a steady clock duration to a time message.
- Parameters
-
[in] _in Steady clock duration.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [23/56]
Out ignition::gazebo::convert | ( | const msgs::Time & | ) |
Generic conversion from a time message to another type.
Specialized conversion from a time message to a steady clock duration.
- Parameters
-
[in] _in Time message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [24/56]
std::chrono::steady_clock::duration ignition::gazebo::convert | ( | const msgs::Time & | ) |
Specialized conversion from a time message to a steady clock duration.
- Parameters
-
[in] _in Time message.
- Returns
- Steady clock duration.
Specialized conversion from a time message to a steady clock duration.
- Parameters
-
[in] _in Time message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [25/56]
Out ignition::gazebo::convert | ( | const math::Inertiald & | ) |
Generic conversion from a math inertial to another type.
Specialized conversion from a math inertial to an inertial message.
- Parameters
-
[in] _in Math inertial.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [26/56]
msgs::Inertial ignition::gazebo::convert | ( | const math::Inertiald & | ) |
Specialized conversion from a math inertial to an inertial message.
- Parameters
-
[in] _in Math inertial.
- Returns
- Inertial message.
Specialized conversion from a math inertial to an inertial message.
- Parameters
-
[in] _in Math inertial.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [27/56]
Out ignition::gazebo::convert | ( | const msgs::Inertial & | ) |
Generic conversion from an inertial message to another type.
Specialized conversion from an inertial message to an inertial math object.
- Parameters
-
[in] _in Inertial message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [28/56]
math::Inertiald ignition::gazebo::convert | ( | const msgs::Inertial & | ) |
Specialized conversion from an inertial message to an inertial math object.
- Parameters
-
[in] _in Inertial message.
- Returns
- math inertial.
Specialized conversion from an inertial message to an inertial math object.
- Parameters
-
[in] _in Inertial message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [29/56]
Out ignition::gazebo::convert | ( | const sdf::JointAxis & | ) |
Generic conversion from an SDF joint axis to another type.
Specialized conversion from an SDF joint axis to an axis message.
- Parameters
-
[in] _in SDF joint axis.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [30/56]
msgs::Axis ignition::gazebo::convert | ( | const sdf::JointAxis & | ) |
Specialized conversion from an SDF joint axis to an axis message.
- Parameters
-
[in] _in SDF joint axis.
- Returns
- Axis message.
Specialized conversion from an SDF joint axis to an axis message.
- Parameters
-
[in] _in SDF joint axis.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [31/56]
Out ignition::gazebo::convert | ( | const msgs::Axis & | ) |
Generic conversion from an axis message to another type.
Specialized conversion from an axis message to a joint axis SDF object.
- Parameters
-
[in] _in Axis message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [32/56]
sdf::JointAxis ignition::gazebo::convert | ( | const msgs::Axis & | ) |
Specialized conversion from an axis message to a joint axis SDF object.
- Parameters
-
[in] _in Axis message.
- Returns
- SDF joint axis.
Specialized conversion from an axis message to a joint axis SDF object.
- Parameters
-
[in] _in Axis message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [33/56]
Out ignition::gazebo::convert | ( | const sdf::Scene & | ) |
Generic conversion from an SDF scene to another type.
Specialized conversion from an SDF scene to a scene message.
- Parameters
-
[in] _in SDF scene.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [34/56]
msgs::Scene ignition::gazebo::convert | ( | const sdf::Scene & | ) |
Specialized conversion from an SDF scene to a scene message.
- Parameters
-
[in] _in SDF scene.
- Returns
- Scene message.
Specialized conversion from an SDF scene to a scene message.
- Parameters
-
[in] _in SDF scene.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [35/56]
Out ignition::gazebo::convert | ( | const msgs::Scene & | ) |
Generic conversion from a scene message to another type.
Specialized conversion from a scene message to a scene SDF object.
- Parameters
-
[in] _in Scene message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [36/56]
sdf::Scene ignition::gazebo::convert | ( | const msgs::Scene & | ) |
Specialized conversion from a scene message to a scene SDF object.
- Parameters
-
[in] _in Scene message.
- Returns
- SDF scene.
Specialized conversion from a scene message to a scene SDF object.
- Parameters
-
[in] _in Scene message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [37/56]
Out ignition::gazebo::convert | ( | const sdf::Atmosphere & | ) |
Generic conversion from an SDF atmosphere to another type.
Specialized conversion from an SDF atmosphere to an atmosphere message.
- Parameters
-
[in] _in SDF atmosphere.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [38/56]
msgs::Atmosphere ignition::gazebo::convert | ( | const sdf::Atmosphere & | ) |
Specialized conversion from an SDF atmosphere to an atmosphere message.
- Parameters
-
[in] _in SDF atmosphere.
- Returns
- Atmosphere message.
Specialized conversion from an SDF atmosphere to an atmosphere message.
- Parameters
-
[in] _in SDF atmosphere.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [39/56]
Out ignition::gazebo::convert | ( | const msgs::Atmosphere & | ) |
Generic conversion from an atmosphere message to another type.
Specialized conversion from an atmosphere message to an atmosphere SDF object.
- Parameters
-
[in] _in Atmosphere message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [40/56]
sdf::Atmosphere ignition::gazebo::convert | ( | const msgs::Atmosphere & | ) |
Specialized conversion from an atmosphere message to an atmosphere SDF object.
- Parameters
-
[in] _in Atmosphere message.
- Returns
- SDF scene.
Specialized conversion from an atmosphere message to an atmosphere SDF object.
- Parameters
-
[in] _in Atmosphere message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [41/56]
Out ignition::gazebo::convert | ( | const sdf::Sensor & | ) |
Generic conversion from an SDF Sensor to another type.
Specialized conversion from an SDF sensor to a sensor message.
- Parameters
-
[in] _in SDF Sensor.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [42/56]
msgs::Sensor ignition::gazebo::convert | ( | const sdf::Sensor & | ) |
Specialized conversion from an SDF sensor to a sensor message.
- Parameters
-
[in] _in SDF geometry.
- Returns
- Sensor message.
Specialized conversion from an SDF sensor to a sensor message.
- Parameters
-
[in] _in SDF Sensor.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [43/56]
Out ignition::gazebo::convert | ( | const msgs::Sensor & | ) |
Generic conversion from a sensor message to another type.
Specialized conversion from a sensor message to a sensor SDF object.
- Parameters
-
[in] _in Sensor message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [44/56]
sdf::Sensor ignition::gazebo::convert | ( | const msgs::Sensor & | ) |
Specialized conversion from a sensor message to a sensor SDF object.
- Parameters
-
[in] _in Sensor message.
- Returns
- SDF sensor.
Specialized conversion from a sensor message to a sensor SDF object.
- Parameters
-
[in] _in Sensor message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [45/56]
Out ignition::gazebo::convert | ( | const msgs::SensorNoise & | ) |
Generic conversion from a sensor noise message to another type.
Specialized conversion from a sensor noise message to a noise SDF object.
- Parameters
-
[in] _in SensorNoise message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [46/56]
sdf::Noise ignition::gazebo::convert | ( | const msgs::SensorNoise & | ) |
Specialized conversion from a sensor noise message to a noise SDF object.
- Parameters
-
[in] _in Sensor noise message.
- Returns
- SDF noise.
Specialized conversion from a sensor noise message to a noise SDF object.
- Parameters
-
[in] _in SensorNoise message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [47/56]
Out ignition::gazebo::convert | ( | const msgs::WorldStatistics & | ) |
Generic conversion from a world statistics message to another type.
Specialized conversion from a world statistics message to an UpdateInfo
object.
- Parameters
-
[in] _in WorldStatistics message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [48/56]
UpdateInfo ignition::gazebo::convert | ( | const msgs::WorldStatistics & | ) |
Specialized conversion from a world statistics message to an UpdateInfo
object.
- Parameters
-
[in] _in WorldStatistics message.
- Returns
- Update info.
Specialized conversion from a world statistics message to an UpdateInfo
object.
- Parameters
-
[in] _in WorldStatistics message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [49/56]
Out ignition::gazebo::convert | ( | const UpdateInfo & | ) |
Generic conversion from update info to another type.
Specialized conversion from update info to a world statistics message.
- Parameters
-
[in] _in Update info.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [50/56]
msgs::WorldStatistics ignition::gazebo::convert | ( | const UpdateInfo & | ) |
Specialized conversion from update info to a world statistics message.
- Parameters
-
[in] _in Update info.
- Returns
- World statistics message.
Specialized conversion from update info to a world statistics message.
- Parameters
-
[in] _in Update info.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [51/56]
Out ignition::gazebo::convert | ( | const sdf::Collision & | ) |
Generic conversion from an SDF collision to another type.
Specialized conversion from an SDF collision to a collision message.
- Parameters
-
[in] _in SDF collision.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [52/56]
msgs::Collision ignition::gazebo::convert | ( | const sdf::Collision & | ) |
Specialized conversion from an SDF collision to a collision message.
- Parameters
-
[in] _in SDF collision.
- Returns
- Collision message.
Specialized conversion from an SDF collision to a collision message.
- Parameters
-
[in] _in SDF collision.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [53/56]
Out ignition::gazebo::convert | ( | const msgs::Collision & | ) |
Generic conversion from a collision message to another type.
Specialized conversion from a collision message to a collision SDF object.
- Parameters
-
[in] _in Collision message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [54/56]
sdf::Collision ignition::gazebo::convert | ( | const msgs::Collision & | ) |
Specialized conversion from a collision message to a collision SDF object.
- Parameters
-
[in] _in Collision message.
- Returns
- SDF collision.
Specialized conversion from a collision message to a collision SDF object.
- Parameters
-
[in] _in Collision message.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [55/56]
Out ignition::gazebo::convert | ( | const std::string & | ) |
Generic conversion from a string to another type.
Specialized conversion from a string to an Entity_Type msg.
- Parameters
-
[in] _in string.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ convert() [56/56]
msgs::Entity_Type ignition::gazebo::convert | ( | const std::string & | ) |
Specialized conversion from a string to an Entity_Type msg.
- Parameters
-
[in] _in string message.
- Returns
- Entity_Type.
Specialized conversion from a string to an Entity_Type msg.
- Parameters
-
[in] _in string.
- Returns
- Conversion result.
- Template Parameters
-
Out Output type.
References convert().
◆ removeParentScope()
std::string ignition::gazebo::removeParentScope | ( | const std::string & | _name, |
const std::string & | _delim | ||
) |
Helper function to remove a parent scope from a given name. This removes the first name found before the delimiter.
- Parameters
-
[in] _name Input name possibly generated by scopedName. [in] _delim Delimiter between names.
- Returns
- A new string with the parent scope removed.
◆ scopedName()
std::string ignition::gazebo::scopedName | ( | const Entity & | _entity, |
const EntityComponentManager & | _ecm, | ||
const std::string & | _delim = "/" , |
||
bool | _includePrefix = true |
||
) |
Helper function to generate scoped name for an entity.
- Parameters
-
[in] _entity Entity to get the name for. [in] _ecm Immutable reference to ECM. [in] _delim Delimiter to put between names, defaults to "/". [in] _includePrefix True to include the type prefix before the entity name
◆ set() [1/3]
void ignition::gazebo::set | ( | msgs::SensorNoise * | _msg, |
const sdf::Noise & | _sdf | ||
) |
Helper function that sets a mutable msgs::SensorNoise object to the values contained in a sdf::Noise object.
- Parameters
-
[out] _msg SensorNoise message to set. [in] _sdf SDF Noise object.
◆ set() [2/3]
void ignition::gazebo::set | ( | msgs::WorldStatistics * | _msg, |
const UpdateInfo & | _in | ||
) |
Helper function that sets a mutable msgs::WorldStatistics object to the values contained in a gazebo::UpdateInfo object.
- Parameters
-
[out] _msg WorldStatistics message to set. [in] _in UpdateInfo object.
◆ set() [3/3]
void ignition::gazebo::set | ( | msgs::Time * | _msg, |
const std::chrono::steady_clock::duration & | _in | ||
) |
Helper function that sets a mutable msgs::Time object to the values contained in a std::chrono::steady_clock::duration object.
- Parameters
-
[out] _msg Time message to set. [in] _in Chrono duration object.
◆ worldPose()
math::Pose3d ignition::gazebo::worldPose | ( | const Entity & | _entity, |
const EntityComponentManager & | _ecm | ||
) |
Helper function to compute world pose of an entity.
- Parameters
-
[in] _entity Entity to get the world pose for [in] _ecm Immutable reference to ECM.
- Returns
- World pose of entity
Variable Documentation
◆ EntityComponentManagerPrivate
class IGNITION_GAZEBO_HIDDEN EntityComponentManagerPrivate |
◆ EventManagerPrivate
class IGNITION_GAZEBO_HIDDEN EventManagerPrivate |
◆ kComponentIdInvalid
|
static |
Id that indicates an invalid component.
◆ kComponentTypeIdInvalid
|
static |
Id that indicates an invalid component type.
◆ kNullEntity
const Entity kNullEntity {0} |
Indicates a non-existant or invalid Entity.
◆ LinkPrivate
class IGNITION_GAZEBO_HIDDEN LinkPrivate |
◆ ModelPrivate
class IGNITION_GAZEBO_HIDDEN ModelPrivate |
◆ SystemLoaderPrivate
class IGNITION_GAZEBO_HIDDEN SystemLoaderPrivate |