▼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 |
CDetachableJointInfo | Data structure to hold information about the parent and child links connected by a detachable joint |
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 |
►Ngui | |
►Nevents | Namespace for all events. Refer to the EventManager class for more information about events |
CDeselectAllEntities | Event that notifies when all entities have been deselected |
CEntitiesSelected | Event that notifies when new entities have been selected |
CRender | Event called in the render thread of a 3D scene. It's safe to make rendering calls in this event's callback |
CSnapIntervals | The class for sending and receiving custom snap value events |
CSpawnPreviewModel | Event called to spawn a preview model. Used by plugins that spawn models |
CSpawnPreviewPath | Event called to spawn a preview resource, which takes the path to the SDF file. Used by plugins that spawn resources |
►NIGNITION_GAZEBO_VERSION_NAMESPACE | |
►Nsystems | |
►Noptical_tactile_sensor | |
COpticalTactilePluginVisualization | |
COpticalTactilePlugin | Plugin that implements an optical tactile sensor |
CVisualizeLidar | Visualize the LaserScan message returned by the sensors. Use the checkbox to turn visualization of non-hitting rays on or off and the textfield to select the message to be visualised. The combobox is used to select the type of visual for the sensor data |
►Nlogical_audio | |
CMicrophone | Properties of a logical audio microphone. A microphone also has a pose, which can be stored as a component of a microphone entity via components::Pose |
CSource | Properties of a logical audio source. A source also has a pose, which can be stored as a component of a source entity via components::Pose |
CSourcePlayInfo | A source's playing information. Useful for keeping track of when to start/stop playing a source |
►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 |
CAnimationTimeSerializer | |
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 |
CDetachableJointInfoSerializer | Serializer for DetachableJointInfo object |
CJointTypeSerializer | |
CLevelEntityNamesSerializer | |
CLogicalAudioSourcePlayInfoSerializer | Serializer for components::LogicalAudioSourcePlayInfo object |
CLogicalAudioSourceSerializer | Serializer for components::LogicalAudioSource object |
CLogicalMicrophoneSerializer | Serializer for components::LogicalMicrophone object |
CMsgSerializer | Serializer for components that hold protobuf messages |
CPerformerLevelsSerializer | |
CStringSerializer | Serializer for components that hold std::string |
CVectorDoubleSerializer | Serializer for components that hold std::vector<double> |
►Nsystems | Namespace for all System plugins. Refer to the System class for more information about systems |
►Nmulticopter_control | |
CEigenTwist | Struct containing linear and angular velocities |
CFrameData | Frame data of a link including its pose and linear velocity in world frame as well as its angular velocity in body frame |
CLeeVelocityController | |
CLeeVelocityControllerParameters | Data structure containing various parameters for the Lee velocity controller |
CNoiseParameters | Noise parameters used when computing frame data. These are all assumed to be gaussian |
CRotor | A struct that holds various properties of a rotor |
CVehicleParameters | A struct that holds properties of the vehicle such as mass, inertia and rotor configuration. Gravity is also included even though it's not a parameter unique to the vehicle |
CAirPressure | An air pressure sensor that reports vertical position and velocity readings over ign transport |
CAltimeter | An altimeter sensor that reports vertical position and velocity readings over ign transport |
CApplyJointForce | This system applies a force to the first axis of a specified joint |
CBreadcrumbs | A system for creating Breadcrumbs in the form of models that can get deployed/spawned at the location of the model to which this system is attached. Each breadcrumb is a complete sdf::Model. When deployed, the pose of the breadcrumb model is offset from the containing model by the pose specified in the <pose> element of the breadcrumb model. A name is generated for the breadcrumb by appending the current count of deployments to the name specified in the breadcrumb <model> element. The model specified in the <breadcrumb> parameter serves as a template for deploying multiple breadcrumbs of the same type. Including models from Fuel is accomplished by creating a <model> that includes the Fuel model using the tag. See the example in examples/worlds/breadcrumbs.sdf |
CBuoyancy | A system that simulates buoyancy of objects immersed in fluid. All SDF parameters are optional. This system must be attached to the world and this system will apply buoyancy to all links that have inertia and collision shapes |
CCameraVideoRecorder | Record video from a camera sensor The system takes in the following parameter: <topic> Name of topic for the video recorder service. If this is not specified, the topic defaults to: /world/<world_name/model/<model_name>/link/<link_name>/ sensor/<sensor_name>/record_video |
CColladaWorldExporter | A plugin that exports a world to a mesh. When loaded the plugin will dump a mesh containing all the models in the world to the current directory |
CContact | Contact sensor system which manages all contact sensors in simulation |
CDetachableJoint | A system that initially attaches two models via a fixed joint and allows for the models to get detached during simulation via a topic |
CDiffDrive | Differential drive controller which can be attached to a model with any number of left and right wheels |
CFollowActor | Make an actor follow a target entity in the world |
CImu | This system manages all IMU sensors in simulation. Each IMU sensor eports vertical position, angular velocity and lienar acceleration readings over Ignition Transport |
CJointController | Joint controller which can be attached to a model with a reference to a single joint. Currently only the first axis of a joint is actuated |
CJointPositionController | Joint position controller which can be attached to a model with a reference to a single joint |
CJointStatePublisher | The JointStatePub system publishes state information for a model. The published message type is ignition::msgs::Model, and the publication topic is "/world/<world_name>/model/<model_name>/state" |
CKineticEnergyMonitor | A system that monitors the kinetic energy of a link in a model and publishes when there is a lost of kinetic energy during a timestep that surpasses a specific threshold. This system can be used to detect when a model could be damaged |
CLiftDrag | The LiftDrag system computes lift and drag forces enabling simulation of aerodynamic robots |
CLinearBatteryPlugin | A plugin for simulating battery usage |
CLogicalAudioSensorPlugin | A plugin for logical audio detection |
CLogicalCamera | A logical camera sensor that reports objects detected within its frustum readings over ign transport |
CLogPlayback | Log state playback |
CLogRecord | Log state recorder |
CLogVideoRecorder | System which recordings videos from log playback There are two ways to specify what entities in the log playback to follow and record videos for: 1) by entity name and 2) by region. See the following parameters: <entity> Name of entity to record. <region> Axis-aligned box where entities are at start of log <min> Min corner position of box region. <max> Max corner position of box region. <start_time> Sim time when recording should start <end_time> Sim time when recording should end <exit_on_finish> Exit ign-gazebo when log playback recording ends When recording is finished. An end string will be published to the /log_video_recorder/status topic and the videos are saved to a timestamped directory |
CMagnetometer | An magnetometer sensor that reports the magnetic field in its current location |
CMulticopterMotorModel | This system applies a thrust force to models with spinning propellers. See examples/worlds/quadcopter.sdf for a demonstration |
CMulticopterVelocityControl | This is a velocity controller for multicopters that allows control over the linear velocity and the yaw angular velocity of the vehicle. The velocities are expressed in the body frame of the vehicle. A vehicle with at least 4 rotors is required for the controller to function |
CPerformerDetector | A system system that publishes on a topic when a performer enters or leaves a specified region |
CPhysics | Base class for a System |
CPosePublisher | Pose publisher system. Attach to an entity to publish the transform of its child entities in the form of ignition::msgs::Pose messages, or a single ignition::msgs::Pose_V message if "use_pose_vector_msg" is true |
CSceneBroadcaster | System which periodically publishes an ignition::msgs::Scene message with updated information |
CSensors | TODO(louise) Have one system for all sensors, or one per sensor / sensor type? |
CSpeedLimiter | Class to limit velocity, acceleration and jerk. https://github.com/ros-controls/ros_controllers/tree/melodic-devel/diff_drive_controller |
CThermal | A thermal plugin that sets the temperature for the parent entity |
CTouchPlugin | Plugin which checks if a model has touched some specific target for a given time continuously and exclusively. After the touch is completed, the plugin is disabled. It can be re-enabled through an Ignition transport service |
CTriggeredPublisher | The triggered publisher system publishes a user specified message on an output topic in response to an input message that matches user specified criteria |
CUserCommands | This system provides an Ignition Transport interface to execute commands while simulation is running |
CVelocityControl | Linear and angular velocity controller which is directly set on a model |
CWheelSlip | A system that updates wheel slip parameters based on linear wheel spin velocity (radius * spin rate). It currently assumes that the fdir1 friction parameter is set parallel to the joint axis (often [0 0 1]) and that the link origin is on the joint axis. The slip parameter is a Force-Dependent Slip (slip1, slip2) and it has units of velocity / force (m / s / N), similar to the inverse of a viscous damping coefficient. The slip_compliance parameters specified in this plugin are unitless, representing the lateral or longitudinal slip ratio (see https://en.wikipedia.org/wiki/Slip_(vehicle_dynamics) ) to tangential force ratio (tangential / normal force). Note that the maximum force ratio is the friction coefficient. At each time step, these compliances are multiplied by the linear wheel spin velocity and divided by the wheel_normal_force parameter specified below in order to match the units of the slip parameters |
CWindEffects | A system that simulates a simple wind model. The wind is described as a uniform worldwide model. So it is independent from model position for simple computations. Its components are computed separately: |
►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 |
CAlignTool | Provides buttons for the align tool |
CAnimationUpdateData | Data structure for updating skeleton animations |
CDisplay | Data used by the DisplayData() function to filter and sort the resources to be displayed |
CEntityComponentManager | The EntityComponentManager constructs, deletes, and returns components and entities. A component can be of any class which inherits from components::BaseComponent |
CEntityContextMenu | A context menu providing actions that can be invoked on an entity |
CEntityTree | Displays a tree view with all the entities in the world |
CEventManager | The EventManager is used to send/receive notifications of simulator events |
CGridConfig | |
CGuiRunner | Responsible for running GUI systems as new states are received from the backend |
CGuiSystem | Base class for a GUI System |
CIgnGazeboPlugin | IgnGazebo QML Plugin that registers C++ class so that they are accessible from QML |
CIgnRenderer | Ign-rendering renderer. All ign-rendering calls should be performed inside this class as it makes sure that opengl calls in the underlying render engine do not interfere with QtQuick's opengl render operations. The main Render function will render to an offscreen texture and notify via signal and slots when it's ready to be displayed |
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 |
CMarkerManager | Creates, deletes, and maintains marker visuals. Only the Scene class should instantiate and use this class |
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 |
CPathModel | Provides a model by which the resource spawner qml plugin pulls and updates from |
CPlaybackScrubber | Provides buttons for adding a box, sphere, or cylinder to the scene |
CPlotComponent | A container of the component data that keeps track of the registered attributes and update their values and their registered charts |
CPlotting | Physics data plotting handler that keeps track of the registered components, update them and update the plot |
CRenderThread | Rendering thread |
CRenderUtil | |
CRenderWindowItem | A QQUickItem that manages the render window |
CResource | Resource used to update the ResourceModel |
CResourceModel | Provides a model by which the resource spawner qml plugin pulls and updates from |
CResourceSpawner | Provides interface for communicating to backend for generation of local models |
CScene3D | Creates a new ignition rendering scene or adds a user-camera to an existing scene. It is possible to orbit the camera around the scene with the mouse. Use other plugins to manage objects in the scene |
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 |
CShapes | Provides buttons for adding a box, sphere, or cylinder to the scene |
CSystem | Base class for a System |
CSystemLoader | Class for loading/unloading System plugins |
CTapeMeasure | Provides buttons for the tape measure tool |
CTextureNode | Texture node for displaying the render texture from ign-renderer |
CTmpIface | Temporary place to prototype transport interfaces while it's not clear where they will live |
CTransformControl | Provides buttons for translation, rotation, and scale |
CTreeModel | TODO |
CUpdateInfo | Information passed to systems on the update callback |
CVideoRecorder | Provides buttons for starting and stopping video recording |
CViewAngle | Provides buttons for viewing angles |
CWorld | 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 world entity |