Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234]
| ▼Nignition | This library is part of the Ignition Robotics project |
| ▼Ngazebo | Gazebo is a leading open source robotics simulator, that provides high fidelity physics, rendering, and sensor simulation |
| ▼Ncomponents | Components represent data, such as position information. An Entity usually has one or more associated components |
| CBaseComponent | Base class for all components |
| CComponent | A component type that wraps any data type. The intention is for this class to be used to create simple components while avoiding a lot of boilerplate code. The Identifier must be a unique type so that type aliases can be used to create new components. However the type does not need to be defined anywhere eg |
| CComponent< NoData, Identifier, Serializer > | Specialization for components that don't wrap any data. This class to be used to create simple components that represent just a "tag", while avoiding a lot of boilerplate code. The Identifier must be a unique type so that type aliases can be used to create new components. However the type does not need to be defined anywhere eg |
| CComponentDescriptor | A class for an object responsible for creating components |
| CComponentDescriptorBase | A base class for an object responsible for creating components |
| CFactory | A factory that generates a component based on a string type |
| CStorageDescriptor | A class for an object responsible for creating storages |
| CStorageDescriptorBase | A base class for an object responsible for creating storages |
| ▼Nserializers | A Serializer class is used to serialize and deserialize a component. It is passed in as the third template parameter to components::Component. Eg |
| CComponentToMsgSerializer | Serialization for that converts components data types to ignition::msgs. This assumes that convert<DataType> is defined |
| CDefaultSerializer | Default serializer template to call stream operators only on types that support them. If the stream operator is not available, a warning message is printed |
| CDefaultSerializer< components::NoData > | Specialization of DefaultSerializer for NoData |
| CJointTypeSerializer | |
| CLevelEntityNamesSerializer | |
| CPerformerLevelsSerializer | |
| CVectorDoubleSerializer | Serializer for components that hold std::vector<double> |
| ▼Ntraits | |
| CIsInStreamable | Type trait that determines if a operator>> is defined on Stream and DataType, i.e, it checks if the function Stream& operator>>(Stream&, DataType&) exists. Example: |
| CIsOutStreamable | Type trait that determines if a operator<< is defined on Stream and DataType, i.e, it checks if the function Stream& operator<<(Stream&, const DataType&) exists. Example: |
| CIsSharedPtr | Helper trait to determine if a type is shared_ptr or not |
| CIsSharedPtr< std::shared_ptr< T > > | Helper trait to determine if a type is shared_ptr or not |
| CEntityComponentManager | The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent |
| CEventManager | The EventManager is used to send/receive notifications of simulator events |
| CGuiRunner | |
| CGuiSystem | Base class for a GUI System |
| CISystemConfigure | Interface for a system that implements optional configuration |
| CISystemPostUpdate | Interface for a system that uses the PostUpdate phase |
| CISystemPreUpdate | Interface for a system that uses the PreUpdate phase |
| CISystemUpdate | Interface for a system that uses the Update phase |
| CLink | 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 |
| CModel | 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 |
| CRenderUtil | |
| CSceneManager | Scene manager class for loading and managing objects in the scene |
| CSdfEntityCreator | Provides convenient functions to spawn entities and load their plugins from SDF elements, to remove them, and to change their hierarchy |
| CServer | The server instantiates and controls simulation |
| ▼CServerConfig | Configuration parameters for a Server. An instance of this object can be used to construct a Server with a particular configuration |
| CPluginInfo | Information about a plugin that should be loaded by the server. Currently supports attaching a plugin to an entity given its type and name, but it can't tell apart multiple entities with the same name in different parts of the entity tree |
| CSystem | Base class for a System |
| CSystemLoader | Class for loading/unloading System plugins |
| CTmpIface | Temporary place to prototype transport interfaces while it's not clear where they will live |
| CUpdateInfo | Information passed to systems on the update callback |