diff --git a/src/ign_TEST.cc b/src/ign_TEST.cc index 686055dd0b..6df0df2fab 100644 --- a/src/ign_TEST.cc +++ b/src/ign_TEST.cc @@ -100,7 +100,7 @@ TEST(CmdLine, CachedFuelWorld) std::string projectPath = std::string(PROJECT_SOURCE_PATH) + "/test/worlds"; ignition::common::setenv("IGN_FUEL_CACHE_PATH", projectPath.c_str()); std::string cmd = kIgnCommand + " -r -v 4 --iterations 5" + - " https://fuel.ignitionrobotics.org/1.0/OpenRobotics/worlds/Test%20world"; + " https://fuel.gazebosim.org/1.0/OpenRobotics/worlds/Test%20world"; std::cout << "Running command [" << cmd << "]" << std::endl; std::string output = customExecStr(cmd); diff --git a/tutorials/battery.md b/tutorials/battery.md index 4b235125c3..aacfaff581 100644 --- a/tutorials/battery.md +++ b/tutorials/battery.md @@ -53,7 +53,7 @@ Next, you can find a description of the SDF parameters used: * ``: Power load on battery (W). -* ``: As reported [here](https://github.com/ignitionrobotics/ign-gazebo/issues/225), +* ``: As reported [here](https://github.com/gazebosim/gz-sim/issues/225), there are some issues affecting batteries in Ignition Blueprint and Citadel. This parameter fixes the issues. Feel free to omit the parameter if you have legacy code and want to preserve the old behavior. diff --git a/tutorials/collada_world_exporter.md b/tutorials/collada_world_exporter.md index e1bdd4e60a..7e452d736a 100644 --- a/tutorials/collada_world_exporter.md +++ b/tutorials/collada_world_exporter.md @@ -22,4 +22,4 @@ ign gazebo -v 4 -s -r --iterations 1 WORLD_FILE_NAME 3. A subdirectory, named after the world, has been created in the current working directory. Within this subdirectory is the mesh and materials for the world. -Refer to the [collada_world_exporter.sdf](https://github.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo4/examples/worlds/collada_world_exporter.sdf) example. +Refer to the [collada_world_exporter.sdf](https://github.com/gazebosim/gz-sim/blob/ign-gazebo4/examples/worlds/collada_world_exporter.sdf) example. diff --git a/tutorials/detachable_joints.md b/tutorials/detachable_joints.md index 70a2456b8d..38f2d0d5a3 100644 --- a/tutorials/detachable_joints.md +++ b/tutorials/detachable_joints.md @@ -8,7 +8,7 @@ kinematic topology has to be a tree, i.e., kinematic loops are not currently supported. This affects the choice of the parent link, and therefore, the parent model, which is the model that contains the `DetachableJoint` system. -For example, [detachable_joint.sdf](https://github.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo2/examples/worlds/detachable_joint.sdf) +For example, [detachable_joint.sdf](https://github.com/gazebosim/gz-sim/blob/ign-gazebo2/examples/worlds/detachable_joint.sdf) demonstrates a four wheel vehicle that holds three objects that are later detached from the vehicle. As seen in this example, the parent model is the vehicle. The kinematic topology is the following. diff --git a/tutorials/distributed_simulation.md b/tutorials/distributed_simulation.md index e81b91ac9a..21620a71d4 100644 --- a/tutorials/distributed_simulation.md +++ b/tutorials/distributed_simulation.md @@ -106,7 +106,7 @@ keeps all performers loaded, but performs no physics simulation. Stepping happens in 2 stages: the primary update and the secondaries update, according to the diagram below: - + 1. The primary publishes a `SimulationStep` message on the `/step` topic, containing: diff --git a/tutorials/erb_template.md b/tutorials/erb_template.md index b5cf20a1b0..6a1a21ea5e 100644 --- a/tutorials/erb_template.md +++ b/tutorials/erb_template.md @@ -17,7 +17,7 @@ Some of them are listed below and demonstrated in this [example ERB file](https: ## Set up Ruby Firstly, Ruby needs to be installed. -If you have gone through [Ignition's installation guide](https://ignitionrobotics.org/docs/latest/install), it's most likely you already have Ruby installed. +If you have gone through [Ignition's installation guide](https://gazebosim.org/docs/latest/install), it's most likely you already have Ruby installed. To check if Ruby is installed, use ```{.sh} ruby --version @@ -102,7 +102,7 @@ Each box model also has a different name and pose to ensure they show up as indi %> ``` -[Here](https://github.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo3/examples/worlds/shapes_population.sdf.erb) is a complete shapes simulation world example. +[Here](https://github.com/gazebosim/gz-sim/blob/ign-gazebo3/examples/worlds/shapes_population.sdf.erb) is a complete shapes simulation world example. Instead of simple shapes, you can also use a nested loop to generate 100 actors spaced out evenly in a simulation world. @@ -116,11 +116,11 @@ Instead of simple shapes, you can also use a nested loop to generate 100 actors - https://fuel.ignitionrobotics.org/1.0/Mingfei/models/actor/tip/files/meshes/talk_b.dae + https://fuel.gazebosim.org/1.0/Mingfei/models/actor/tip/files/meshes/talk_b.dae 1.0 - https://fuel.ignitionrobotics.org/1.0/Mingfei/models/actor/tip/files/meshes/talk_b.dae + https://fuel.gazebosim.org/1.0/Mingfei/models/actor/tip/files/meshes/talk_b.dae 0.055 true diff --git a/tutorials/gui_config.md b/tutorials/gui_config.md index fddc6b156f..58569d10a4 100644 --- a/tutorials/gui_config.md +++ b/tutorials/gui_config.md @@ -1,9 +1,9 @@ \page gui_config GUI Configuration Ignition Gazebo's graphical user interface is powered by -[Ignition GUI](https://ignitionrobotics.org/libs/gui). Therefore, Gazebo's +[Ignition GUI](https://gazebosim.org/libs/gui). Therefore, Gazebo's GUI layout can be defined in -[Ignition GUI configuration files](https://ignitionrobotics.org/api/gui/2.1/config.html). +[Ignition GUI configuration files](https://gazebosim.org/api/gui/2.1/config.html). These are XML files that describe what plugins to be loaded and with what settings. @@ -103,11 +103,11 @@ favorite editor and save this file as `fuel_preview.sdf`: - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/Sun + https://fuel.gazebosim.org/1.0/OpenRobotics/models/Sun - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/Gazebo + https://fuel.gazebosim.org/1.0/OpenRobotics/models/Gazebo diff --git a/tutorials/levels.md b/tutorials/levels.md index c2f62b8667..f8f1f98df5 100644 --- a/tutorials/levels.md +++ b/tutorials/levels.md @@ -77,7 +77,7 @@ being added and removed. Take a look at the 2D example below. This example focuses on a single performer, but the same logic can be extended to multiple performers. - + * The **green area** represents the area of the world which this simulation is expected to take place in. @@ -115,23 +115,23 @@ Let's take a look at how levels are loaded / unloaded as the performer moves: * `M1` and `M3`, because they belong to the level. * `M6`, because it is global. - + 2. The performer moves south towards `L3` and enters its buffer zone, triggering a load of that level's models, `M4` and `M5`. Note that at this moment, both `L1` and `L3` are loaded. - + 3. The performer moves further south, exiting `L1` and entering `L3`. However, `L1` is still loaded, since `R1` is still within its buffer zone. - + 4. Eventually `R1` moves beyond `L1`'s buffer, triggering an unload of `L1`. The main effect is unloading `M1`. - + ## SDF elements @@ -248,7 +248,7 @@ ign service -s /world/levels/level/set_performer --reqtype ignition.msgs.StringM The following is a world file that could be an instance of the world shown in the figure - + ```xml diff --git a/tutorials/log.md b/tutorials/log.md index a401a32263..70e77222c0 100644 --- a/tutorials/log.md +++ b/tutorials/log.md @@ -8,7 +8,7 @@ Ignition records two types of information to files: * Always recorded * Simulation state * Entity poses, insertion and deletion - * Logged to an [Ignition Transport `state.tlog` file](https://ignitionrobotics.org/api/transport/7.0/logging.html) + * Logged to an [Ignition Transport `state.tlog` file](https://gazebosim.org/api/transport/7.0/logging.html) * Recording must be enabled from the command line or the C++ API * Can be played back using the command line or the C++ API @@ -42,7 +42,7 @@ Other options for recording: ### From C++ API All features available through the command line are also available through -[ignition::gazebo::ServerConfig](https://ignitionrobotics.org/api/gazebo/2.0/classignition_1_1gazebo_1_1ServerConfig.html). +[ignition::gazebo::ServerConfig](https://gazebosim.org/api/gazebo/2.0/classignition_1_1gazebo_1_1ServerConfig.html). When instantiating a server programmatically, logging options can be passed to the constructor, for example: diff --git a/tutorials/logical_audio_sensor.md b/tutorials/logical_audio_sensor.md index 0a1e776e47..526ece535a 100644 --- a/tutorials/logical_audio_sensor.md +++ b/tutorials/logical_audio_sensor.md @@ -8,7 +8,7 @@ The logical audio plugin does not play actual audio to a device like speakers, b ## Setup -Let's take a look at [logical_audio_sensor_plugin.sdf](https://github.com/ignitionrobotics/ign-gazebo/blob/460d2b1cfbf0addf05a1e61c05e1f7a675a83785/examples/worlds/logical_audio_sensor_plugin.sdf), which defines a simulation world with 4 models (in this case, boxes) that have an audio object attached to them. +Let's take a look at [logical_audio_sensor_plugin.sdf](https://github.com/gazebosim/gz-sim/blob/460d2b1cfbf0addf05a1e61c05e1f7a675a83785/examples/worlds/logical_audio_sensor_plugin.sdf), which defines a simulation world with 4 models (in this case, boxes) that have an audio object attached to them. This world attaches logical audio sources to the `red_box` and `blue_box` models, and attaches logical microphones to the `green_box` and `yellow_box` models. Let's take a look at the SDF relevant to the source for `red_box` to understand how to define a logical audio source in SDF: @@ -30,7 +30,7 @@ Let's take a look at the SDF relevant to the source for `red_box` to understand ``` As we can see, we use a `` tag to define an audio source. -An explanation of all of the tags can be found in the [plugin documentation](https://github.com/ignitionrobotics/ign-gazebo/blob/314477419d2aa946f384204dc99b17d9fcd963b3/src/systems/logical_audio_sensor_plugin/LogicalAudioSensorPlugin.hh#L35-L130), but there are a few important things to point out: +An explanation of all of the tags can be found in the [plugin documentation](https://github.com/gazebosim/gz-sim/blob/314477419d2aa946f384204dc99b17d9fcd963b3/src/systems/logical_audio_sensor_plugin/LogicalAudioSensorPlugin.hh#L35-L130), but there are a few important things to point out: * `` is used to identify this source when operating on it via services (services will be discussed later). Since a model can have multiple sources and microphones attached to it, each source attached to a particular model must have a unique ID. This means that no other sources attached to `red_box` can have an ID of 1, but sources attached to other models can have an ID of 1 (assuming that other models don't already have a source with an ID of 1 attached to it). @@ -55,7 +55,7 @@ Let's now take a look at the SDF relevant to the microphone for `green_box` to u ``` The same rules regarding `` and `` for a logical audio source also apply to a logical microphone. -You can also take a look at the [microphone documentation](https://github.com/ignitionrobotics/ign-gazebo/blob/314477419d2aa946f384204dc99b17d9fcd963b3/src/systems/logical_audio_sensor_plugin/LogicalAudioSensorPlugin.hh#L35-L130) for a detailed explanation of the tags embedded in the `` tag. +You can also take a look at the [microphone documentation](https://github.com/gazebosim/gz-sim/blob/314477419d2aa946f384204dc99b17d9fcd963b3/src/systems/logical_audio_sensor_plugin/LogicalAudioSensorPlugin.hh#L35-L130) for a detailed explanation of the tags embedded in the `` tag. ## Testing Source and Microphone Behavior diff --git a/tutorials/mesh_to_fuel.md b/tutorials/mesh_to_fuel.md index e534210eb3..710a5cb900 100644 --- a/tutorials/mesh_to_fuel.md +++ b/tutorials/mesh_to_fuel.md @@ -1,17 +1,17 @@ \page meshtofuel Importing a Mesh to Fuel -This tutorial will explain how to import a mesh to the [Ignition Fuel](https://app.ignitionrobotics.org) web application. +This tutorial will explain how to import a mesh to the [Ignition Fuel](https://app.gazebosim.org) web application. Adding models and/or worlds to Fuel will make your content readily available to the open source robotics simulation community, and easier to use with the Ignition GUI. ## Prerequisites To import meshes to Fuel, you need to have a user account. -Go to [app.ignitionrobotics.org](https://app.ignitionrobotics.org) and click Login in the top right corner of the screen, then click Sign Up. +Go to [app.gazebosim.org](https://app.gazebosim.org) and click Login in the top right corner of the screen, then click Sign Up. Once you verify your email address, your account will be ready. You'll need a mesh ready before trying to import to Fuel. There are several ways to acquire a mesh. -To save time, we'll use this [Electrical Box model](https://app.ignitionrobotics.org/openrobotics/fuel/models/Electrical%20Box) that you can download from Fuel. +To save time, we'll use this [Electrical Box model](https://app.gazebosim.org/openrobotics/fuel/models/Electrical%20Box) that you can download from Fuel. ## Model Directory Structure @@ -126,17 +126,17 @@ Click the `Add folders` button, or drag and drop the `Electrical Box` folder you All the files in your model description will be listed there. Press `Upload`, and the "Fuel Model Info" page for your model will open. -![Electrical Box Test](https://raw.githubusercontent.com/ignitionrobotics/ign-gazebo/983d50937cbcaa75c790515b2ec5797fe82f1188/tutorials/files/mesh_to_fuel/model_info2.png) +![Electrical Box Test](https://raw.githubusercontent.com/gazebosim/gz-sim/983d50937cbcaa75c790515b2ec5797fe82f1188/tutorials/files/mesh_to_fuel/model_info2.png) You can always delete a model by clicking the "Edit model" button and then selecting "Delete model" at the bottom of the page -![Delete model](https://raw.githubusercontent.com/ignitionrobotics/ign-gazebo/983d50937cbcaa75c790515b2ec5797fe82f1188/tutorials/files/mesh_to_fuel/delete2.png) +![Delete model](https://raw.githubusercontent.com/gazebosim/gz-sim/983d50937cbcaa75c790515b2ec5797fe82f1188/tutorials/files/mesh_to_fuel/delete2.png) ## Include the Model in a World With your mesh successfully uploaded to Fuel, you can now easily include it in a world SDF file. -Copy [this example world code](https://raw.githubusercontent.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo3/examples/worlds/import_mesh.sdf) into a text editor and save it as `import_mesh.sdf`. +Copy [this example world code](https://raw.githubusercontent.com/gazebosim/gz-sim/blob/ign-gazebo3/examples/worlds/import_mesh.sdf) into a text editor and save it as `import_mesh.sdf`. This is a simple world SDF file, which you can learn more about on the [SDF website](http://sdformat.org/). Scroll all the way to the bottom of the file until you see the `include` tag section following the `` comment line. @@ -156,7 +156,7 @@ Scroll all the way to the bottom of the file until you see the `include` tag sec true Electrical Box 0 0 0 0 0 0 - https://fuel.ignitionrobotics.org/1.0/openrobotics/models/Electrical Box + https://fuel.gazebosim.org/1.0/openrobotics/models/Electrical Box @@ -171,7 +171,7 @@ Change `Electrical Box` to `Electrical Box Test`. The syntax for including any model from Fuel is: ```xml -https://fuel.ignitionrobotics.org/1.0//models/ +https://fuel.gazebosim.org/1.0//models/ ``` ### Launch World @@ -182,4 +182,4 @@ To launch the world and see your mesh, run Ignition from inside the directory wh ign gazebo import_mesh.sdf ``` -![Launch sample world with mesh](https://raw.githubusercontent.com/ignitionrobotics/ign-gazebo/983d50937cbcaa75c790515b2ec5797fe82f1188/tutorials/files/mesh_to_fuel/launch_world2.png) +![Launch sample world with mesh](https://raw.githubusercontent.com/gazebosim/gz-sim/983d50937cbcaa75c790515b2ec5797fe82f1188/tutorials/files/mesh_to_fuel/launch_world2.png) diff --git a/tutorials/migrating_ardupilot_plugin.md b/tutorials/migrating_ardupilot_plugin.md index afdb36ae77..bddfa6fb8b 100644 --- a/tutorials/migrating_ardupilot_plugin.md +++ b/tutorials/migrating_ardupilot_plugin.md @@ -22,7 +22,7 @@ documentation](https://ardupilot.org/dev/docs/using-gazebo-simulator-with-sitl.h As context to understand what we're migrating, here's a system diagram for how the ArduPilot Gazebo plugin works is used: - + *UAV icon credit: By Julian Herzog, CC BY 4.0, https://commons.wikimedia.org/w/index.php?curid=60965475* @@ -224,8 +224,8 @@ To better understand the ECS pattern as it is used in Ignition, it's helpful to learn about the EntityComponentManager (ECM), which is responsible for managing the ECS graph. A great resource to understand the logic under the hood of the ECM is the `SdfEntityCreator` class -([header](https://github.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo3/include/ignition/gazebo/SdfEntityCreator.hh), -[source](https://github.com/ignitionrobotics/ign-gazebo/blob/ign-gazebo3/src/SdfEntityCreator.cc)). +([header](https://github.com/gazebosim/gz-sim/blob/ign-gazebo3/include/ignition/gazebo/SdfEntityCreator.hh), +[source](https://github.com/gazebosim/gz-sim/blob/ign-gazebo3/src/SdfEntityCreator.cc)). This class is responsible for mapping the content of an SDF file to the entities and components that form the graph handled by the ECM. For example, if you wonder which components can be accessed by default from the plugin, this diff --git a/tutorials/migration_link_api.md b/tutorials/migration_link_api.md index fc5f6c8349..aadb9c59ed 100644 --- a/tutorials/migration_link_api.md +++ b/tutorials/migration_link_api.md @@ -14,7 +14,7 @@ class. If you're trying to use some API which doesn't have an equivalent on Ignition yet, feel free to -[ticket an issue](https://github.com/ignitionrobotics/ign-gazebo/issues/). +[ticket an issue](https://github.com/gazebosim/gz-sim/issues/). ## Link API @@ -34,14 +34,14 @@ can be divided in these categories: You'll find the Ignition APIs below on the following headers: -* [ignition/gazebo/Link.hh](https://ignitionrobotics.org/api/gazebo/3.3/Link_8hh.html) -* [ignition/gazebo/Util.hh](https://ignitionrobotics.org/api/gazebo/3.3/Util_8hh.html) -* [ignition/gazebo/SdfEntityCreator.hh](https://ignitionrobotics.org/api/gazebo/3.3/SdfEntityCreator_8hh.html) -* [ignition/gazebo/EntityComponentManager.hh](https://ignitionrobotics.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) +* [ignition/gazebo/Link.hh](https://gazebosim.org/api/gazebo/3.3/Link_8hh.html) +* [ignition/gazebo/Util.hh](https://gazebosim.org/api/gazebo/3.3/Util_8hh.html) +* [ignition/gazebo/SdfEntityCreator.hh](https://gazebosim.org/api/gazebo/3.3/SdfEntityCreator_8hh.html) +* [ignition/gazebo/EntityComponentManager.hh](https://gazebosim.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) It's worth remembering that most of this functionality can be performed using the -[EntityComponentManager](https://ignitionrobotics.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) +[EntityComponentManager](https://gazebosim.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) directly. The functions presented here exist for convenience and readability. ### Properties diff --git a/tutorials/migration_model_api.md b/tutorials/migration_model_api.md index e3a4a5337e..bd4ecbbb63 100644 --- a/tutorials/migration_model_api.md +++ b/tutorials/migration_model_api.md @@ -14,7 +14,7 @@ class. If you're trying to use some API which doesn't have an equivalent on Ignition yet, feel free to -[ticket an issue](https://github.com/ignitionrobotics/ign-gazebo/issues/). +[ticket an issue](https://github.com/gazebosim/gz-sim/issues/). ## Model API @@ -34,14 +34,14 @@ can be divided in these categories: You'll find the Ignition APIs below on the following headers: -* [ignition/gazebo/Model.hh](https://ignitionrobotics.org/api/gazebo/3.3/Model_8hh.html) -* [ignition/gazebo/Util.hh](https://ignitionrobotics.org/api/gazebo/3.3/Util_8hh.html) -* [ignition/gazebo/SdfEntityCreator.hh](https://ignitionrobotics.org/api/gazebo/3.3/SdfEntityCreator_8hh.html) -* [ignition/gazebo/EntityComponentManager.hh](https://ignitionrobotics.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) +* [ignition/gazebo/Model.hh](https://gazebosim.org/api/gazebo/3.3/Model_8hh.html) +* [ignition/gazebo/Util.hh](https://gazebosim.org/api/gazebo/3.3/Util_8hh.html) +* [ignition/gazebo/SdfEntityCreator.hh](https://gazebosim.org/api/gazebo/3.3/SdfEntityCreator_8hh.html) +* [ignition/gazebo/EntityComponentManager.hh](https://gazebosim.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) It's worth remembering that most of this functionality can be performed using the -[EntityComponentManager](https://ignitionrobotics.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) +[EntityComponentManager](https://gazebosim.org/api/gazebo/3.3/classignition_1_1gazebo_1_1EntityComponentManager.html) directly. The functions presented here exist for convenience and readability. ### Properties diff --git a/tutorials/migration_sdf.md b/tutorials/migration_sdf.md index 52e3716bb1..90d591b21c 100644 --- a/tutorials/migration_sdf.md +++ b/tutorials/migration_sdf.md @@ -33,7 +33,7 @@ Here are the recommended ways to use URIs from most recommended to least: ### Ignition Fuel URL It's possible to use URLs of resources on -[Ignition Fuel](https://app.ignitionrobotics.org) within any of the tags +[Ignition Fuel](https://app.gazebosim.org) within any of the tags above and both simulators will be able to load it. For example, this world can be loaded into both simulators: @@ -43,12 +43,12 @@ For example, this world can be loaded into both simulators: - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/Sun + https://fuel.gazebosim.org/1.0/OpenRobotics/models/Sun - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/Ground Plane + https://fuel.gazebosim.org/1.0/OpenRobotics/models/Ground Plane @@ -59,7 +59,7 @@ For example, this world can be loaded into both simulators: - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/Radio/4/files/meshes/Radio.dae + https://fuel.gazebosim.org/1.0/OpenRobotics/models/Radio/4/files/meshes/Radio.dae @@ -67,7 +67,7 @@ For example, this world can be loaded into both simulators: - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/Radio/4/files/meshes/Radio.dae + https://fuel.gazebosim.org/1.0/OpenRobotics/models/Radio/4/files/meshes/Radio.dae @@ -76,11 +76,11 @@ For example, this world can be loaded into both simulators: - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/actor - relative paths/tip/files/meshes/talk_b.dae + https://fuel.gazebosim.org/1.0/OpenRobotics/models/actor - relative paths/tip/files/meshes/talk_b.dae 1.0 - https://fuel.ignitionrobotics.org/1.0/OpenRobotics/models/actor - relative paths/tip/files/meshes/talk_b.dae + https://fuel.gazebosim.org/1.0/OpenRobotics/models/actor - relative paths/tip/files/meshes/talk_b.dae 1.0