From c6270b071a936e29a2b867ac9319ee1e7fda8bec Mon Sep 17 00:00:00 2001 From: methylDragon Date: Mon, 27 Jun 2022 16:26:42 -0700 Subject: [PATCH 1/6] Migrate some docs and project names in macros Signed-off-by: methylDragon --- CMakeLists.txt | 2 +- api.md.in | 4 ++-- examples/hello_world_plugin/README.md | 2 +- tutorials.md.in | 4 ++-- tutorials/01_intro.md | 2 +- tutorials/02_install.md | 16 ++++++++-------- tutorials/04_lightmap.md | 8 ++++---- tutorials/10_actor_animation_tutorial.md | 2 +- tutorials/11_gazebo_scene_viewer_tutorial.md | 2 +- tutorials/12_mesh_viewer_tutorial.md | 2 +- tutorials/13_custom_scene_viewer.md | 2 +- tutorials/14_camera_tracking_tutorial.md | 2 +- tutorials/15_custom_shaders_tutorial.md | 2 +- tutorials/17_render_pass_tutorial.md | 2 +- tutorials/18_simple_demo_tutorial.md | 2 +- tutorials/19_text_geom_tutorial.md | 2 +- tutorials/20_particles_tutorial.md | 2 +- tutorials/21_heightmap.md | 2 +- tutorials/21_render_order.md | 2 +- tutorials/22_environment_map.md | 2 +- tutorials/23_depth_camera_tutorial.md | 2 +- 21 files changed, 33 insertions(+), 33 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 41174aec0..736c60f96 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -125,7 +125,7 @@ endif() # Plugin install dirs set(GZ_RENDERING_ENGINE_INSTALL_DIR - ${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/engine-plugins + ${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/gz-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/engine-plugins ) #-------------------------------------- diff --git a/api.md.in b/api.md.in index 1987b3bec..076d03826 100644 --- a/api.md.in +++ b/api.md.in @@ -1,6 +1,6 @@ -## Ignition @IGN_DESIGNATION_CAP@ +## Gazebo @IGN_DESIGNATION_CAP@ -Ignition @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries +Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries designed to rapidly develop robot and simulation applications. ## License diff --git a/examples/hello_world_plugin/README.md b/examples/hello_world_plugin/README.md index ffc253342..900848859 100644 --- a/examples/hello_world_plugin/README.md +++ b/examples/hello_world_plugin/README.md @@ -5,7 +5,7 @@ Gazebo Rendering and how to load it with Gazebo. ## Build -From the root of the `ign-rendering` repository, do the following to build the example: +From the root of the `gz-rendering` repository, do the following to build the example: ~~~ cd examples/hello_world_plugin diff --git a/tutorials.md.in b/tutorials.md.in index abe3d43e5..450265038 100644 --- a/tutorials.md.in +++ b/tutorials.md.in @@ -1,8 +1,8 @@ \page tutorials Tutorials -Welcome to the Ignition @IGN_DESIGNATION_CAP@ tutorials. These tutorials +Welcome to the Gazebo @IGN_DESIGNATION_CAP@ tutorials. These tutorials will guide you through the process of understanding the capabilities of the -Ignition @IGN_DESIGNATION_CAP@ library and how to use the library effectively. +Gazebo @IGN_DESIGNATION_CAP@ library and how to use the library effectively. **The tutorials** diff --git a/tutorials/01_intro.md b/tutorials/01_intro.md index 209b81e2e..d31d36154 100644 --- a/tutorials/01_intro.md +++ b/tutorials/01_intro.md @@ -4,7 +4,7 @@ Next Tutorial: \ref installation ## What is Gazebo Rendering? -Ignition Rendering is an open source library that provides an abstraction layer +Gazebo Rendering is an open source library that provides an abstraction layer to multiple rendering engines. The goal is to provide a set of unified C++ rendering APIs that are rendering-engine-agnostic. For instance, a scene created through the Gazebo Rendering API could be rendered using an OpenGL based diff --git a/tutorials/02_install.md b/tutorials/02_install.md index 85cd2ef46..5afe65b55 100644 --- a/tutorials/02_install.md +++ b/tutorials/02_install.md @@ -1,7 +1,7 @@ \page installation Installation These instructions are for installing only Gazebo Rendering. -If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://gazebosim.org/docs/latest/install). +If you're interested in using all the Gazebo libraries, check out this [Gazebo installation](https://gazebosim.org/docs/latest/install). We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible. @@ -120,7 +120,7 @@ sdk 4.0.2, comment out lines 167-206). 2. Configure and build ``` - cd ign-rendering + cd gz-rendering mkdir build cd build cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install/dir @@ -139,14 +139,14 @@ On Windows, only OGRE 1 is currently supported. ## Prerequisites -First, follow the [ign-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment. +First, follow the [gz-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment. Navigate to ``condabin`` if necessary to use the ``conda`` command (i.e., if Conda is not in your `PATH` environment variable. You can find the location of ``condabin`` in Anaconda Prompt, ``where conda``). Create if necessary, and activate a Conda environment: ``` -conda create -n ign-ws -conda activate ign-ws +conda create -n gz-ws +conda activate gz-ws ``` ## Binary Installation @@ -162,7 +162,7 @@ This assumes you have created and activated a Conda environment while installing conda install ogre --channel conda-forge ``` -2. Install Ignition dependencies: +2. Install Gazebo dependencies: You can view available versions and their dependencies: ``` @@ -182,7 +182,7 @@ This assumes you have created and activated a Conda environment while installing 4. Configure and build ``` - cd ign-rendering + cd gz-rendering mkdir build cd build cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install @@ -230,7 +230,7 @@ which version you need. 3. Configure and build ``` - cd ign-rendering + cd gz-rendering mkdir build cd build cmake .. diff --git a/tutorials/04_lightmap.md b/tutorials/04_lightmap.md index e35e152b1..8f4189898 100644 --- a/tutorials/04_lightmap.md +++ b/tutorials/04_lightmap.md @@ -1,6 +1,6 @@ \page lightmap Creating and using light maps -This example shows how to bake light maps in Blender and apply the light map texture in Ignition. +This example shows how to bake light maps in Blender and apply the light map texture in Gazebo. ## Light maps @@ -80,11 +80,11 @@ Light map baking applied to a more complex scene: @image html img/lightmap_depot_render.png -## Using the light map in Ignition +## Using the light map in Gazebo -When baking we have the option to either bake in all the lighting, both indirect and direct, or just the indirect lighting, also known as global illumination or bounced lighting, and use real time lights in Ignition for the direct lighting and shadows. With the latter method we get sharper lighting and shadow detail as well as more accurate lighting on our dynamic objects however performance will be impacted by having more real time lights. Even with all the lighting baked it’s still a good idea to have one real time light such as a large point light or directional light works particularly well in order to enhance the effects of the physically based materials. +When baking we have the option to either bake in all the lighting, both indirect and direct, or just the indirect lighting, also known as global illumination or bounced lighting, and use real time lights in Gazebo for the direct lighting and shadows. With the latter method we get sharper lighting and shadow detail as well as more accurate lighting on our dynamic objects however performance will be impacted by having more real time lights. Even with all the lighting baked it’s still a good idea to have one real time light such as a large point light or directional light works particularly well in order to enhance the effects of the physically based materials. -Lightmaps can be applied to a mesh in Ignition the same way as other texture maps. Create an `gz::rendering::Material` and specify a light map texture by calling +Lightmaps can be applied to a mesh in Gazebo the same way as other texture maps. Create an `gz::rendering::Material` and specify a light map texture by calling [SetLightMap](https://gazebosim.org/api/rendering/5.0/classignition_1_1rendering_1_1Material.html#addc6eb6206e0a17ab82aeaea543e8c71). Recall that when creating the light map UV texture in Step 2, we typically use a secondary UV set for light maps. Make sure to specify the index of the light map UV set as the second argument to this function. There are existing example models on Gazebo Fuel that use light maps. The [Depot](https://app.gazebosim.org/OpenRobotics/fuel/models/Depot) model mentioned earlier is one such example, and another one is the [Indoor Lightmap](https://app.gazebosim.org/OpenRobotics/fuel/models/Indoor%20light map) model. To see the Indoor Lightmap model with [Gazebo](https://gazebosim.org/docs/all/getstarted), you can run the following command (requires Gazebo Edifice or above): diff --git a/tutorials/10_actor_animation_tutorial.md b/tutorials/10_actor_animation_tutorial.md index 5835daee4..a8728449d 100644 --- a/tutorials/10_actor_animation_tutorial.md +++ b/tutorials/10_actor_animation_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, Create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/actor_animation +cd gz-rendering/examples/actor_animation mkdir build cd build cmake .. diff --git a/tutorials/11_gazebo_scene_viewer_tutorial.md b/tutorials/11_gazebo_scene_viewer_tutorial.md index d5269c1d6..34bab044b 100644 --- a/tutorials/11_gazebo_scene_viewer_tutorial.md +++ b/tutorials/11_gazebo_scene_viewer_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/gazebo_scene_viewer +cd gz-rendering/examples/gazebo_scene_viewer mkdir build cd build cmake .. diff --git a/tutorials/12_mesh_viewer_tutorial.md b/tutorials/12_mesh_viewer_tutorial.md index 32f76c798..74e7f5534 100644 --- a/tutorials/12_mesh_viewer_tutorial.md +++ b/tutorials/12_mesh_viewer_tutorial.md @@ -6,7 +6,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/mesh_viewer +cd gz-rendering/examples/mesh_viewer mkdir build cd build cmake .. diff --git a/tutorials/13_custom_scene_viewer.md b/tutorials/13_custom_scene_viewer.md index 594af1c10..ac06a969a 100644 --- a/tutorials/13_custom_scene_viewer.md +++ b/tutorials/13_custom_scene_viewer.md @@ -27,7 +27,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/custom_scene_viewer +cd gz-rendering/examples/custom_scene_viewer mkdir build cd build cmake .. diff --git a/tutorials/14_camera_tracking_tutorial.md b/tutorials/14_camera_tracking_tutorial.md index 9901a92dc..84e9f5cea 100644 --- a/tutorials/14_camera_tracking_tutorial.md +++ b/tutorials/14_camera_tracking_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/camera_tracking +cd gz-rendering/examples/camera_tracking mkdir build cd build cmake .. diff --git a/tutorials/15_custom_shaders_tutorial.md b/tutorials/15_custom_shaders_tutorial.md index 2c192d6ff..817da8150 100644 --- a/tutorials/15_custom_shaders_tutorial.md +++ b/tutorials/15_custom_shaders_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/custom_shaders +cd gz-rendering/examples/custom_shaders mkdir build cd build cmake .. diff --git a/tutorials/17_render_pass_tutorial.md b/tutorials/17_render_pass_tutorial.md index b9b4cbd92..deecd569b 100644 --- a/tutorials/17_render_pass_tutorial.md +++ b/tutorials/17_render_pass_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/render_pass +cd gz-rendering/examples/render_pass mkdir build cd build cmake .. diff --git a/tutorials/18_simple_demo_tutorial.md b/tutorials/18_simple_demo_tutorial.md index e665a67e5..711226d53 100644 --- a/tutorials/18_simple_demo_tutorial.md +++ b/tutorials/18_simple_demo_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/simple_demo +cd gz-rendering/examples/simple_demo mkdir build cd build cmake .. diff --git a/tutorials/19_text_geom_tutorial.md b/tutorials/19_text_geom_tutorial.md index a2d48e582..67ef18fd7 100644 --- a/tutorials/19_text_geom_tutorial.md +++ b/tutorials/19_text_geom_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/text_geom +cd gz-rendering/examples/text_geom mkdir build cd build cmake .. diff --git a/tutorials/20_particles_tutorial.md b/tutorials/20_particles_tutorial.md index 88c32f556..a8aab0a42 100644 --- a/tutorials/20_particles_tutorial.md +++ b/tutorials/20_particles_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/particles_demo +cd gz-rendering/examples/particles_demo mkdir build cd build cmake .. diff --git a/tutorials/21_heightmap.md b/tutorials/21_heightmap.md index 1723ebeff..de7f3cdc2 100644 --- a/tutorials/21_heightmap.md +++ b/tutorials/21_heightmap.md @@ -10,7 +10,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/heightmap +cd gz-rendering/examples/heightmap mkdir build cd build cmake .. diff --git a/tutorials/21_render_order.md b/tutorials/21_render_order.md index f0d208bd3..334204ef5 100644 --- a/tutorials/21_render_order.md +++ b/tutorials/21_render_order.md @@ -38,7 +38,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/simple_demo +cd gz-rendering/examples/simple_demo mkdir build cd build cmake .. diff --git a/tutorials/22_environment_map.md b/tutorials/22_environment_map.md index ee6d68318..0ed4fe348 100644 --- a/tutorials/22_environment_map.md +++ b/tutorials/22_environment_map.md @@ -14,7 +14,7 @@ which uses the ogre2 render engine. To see the example mesh, build and run the demo: ```{.sh} -cd ign-rendering/examples/ogre2_demo +cd gz-rendering/examples/ogre2_demo mkdir build cd build cmake .. diff --git a/tutorials/23_depth_camera_tutorial.md b/tutorials/23_depth_camera_tutorial.md index 4c3b09839..0e94761d0 100644 --- a/tutorials/23_depth_camera_tutorial.md +++ b/tutorials/23_depth_camera_tutorial.md @@ -8,7 +8,7 @@ Clone the source code, create a build directory and use `cmake` and `make` to co ```{.sh} git clone https://github.com/gazebosim/gz-rendering -cd ign-rendering/examples/simple_demo +cd gz-rendering/examples/simple_demo mkdir build cd build cmake .. From c8ef6052f74d5c57fc221b5bb8b0b6322fb74469 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Mon, 27 Jun 2022 16:38:24 -0700 Subject: [PATCH 2/6] Add project name migration note in Migration.md Signed-off-by: methylDragon --- Migration.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Migration.md b/Migration.md index 1c828b782..516e303ff 100644 --- a/Migration.md +++ b/Migration.md @@ -27,6 +27,16 @@ release will remove the deprecated code. 3. `IGN_VISIBILITY_SELECTION` 4. `IGN_VISIBILITY_GUI` 5. `IGN_VISIBILITY_SELECTABLE` + +### Breaking Changes + +1. The project name has been changed to use the `gz-` prefix, you **must** use the `gz` prefix! + * This also means that any generated code that use the project name (e.g. CMake variables, in-source macros) would have to be migrated. + * Some non-exhaustive examples of this include: + * `GZ__