From a781e09ddbb5cd499f48dd7d9bd17055a17972e6 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Tue, 28 Jun 2022 10:46:00 -0700 Subject: [PATCH] ign -> gz Partial Docs Migration and Project Name Followups : gz-rendering (#657) --- CMakeLists.txt | 2 +- Changelog.md | 20 +++++++++---------- Migration.md | 10 ++++++++++ README.md | 2 +- api.md.in | 4 ++-- examples/hello_world_plugin/README.md | 6 +++--- examples/simple_demo_qml/CMakeLists.txt | 2 +- .../gz/rendering/ogre/OgreConversions.hh | 6 +++--- ogre/src/OgreDistortionPass.cc | 2 +- .../gz/rendering/ogre2/Ogre2Conversions.hh | 6 +++--- ogre2/src/Ogre2Material.cc | 2 +- src/RenderEngineManager.cc | 2 +- src/Utils_TEST.cc | 2 +- test/integration/depth_camera.cc | 2 +- test/integration/render_pass.cc | 2 +- tutorials.md.in | 4 ++-- tutorials/01_intro.md | 2 +- tutorials/02_install.md | 18 ++++++++--------- tutorials/03_rendering_plugins.md | 2 +- tutorials/04_lightmap.md | 10 +++++----- 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 | 4 ++-- tutorials/18_simple_demo_tutorial.md | 4 ++-- tutorials/19_text_geom_tutorial.md | 4 ++-- tutorials/20_particles_tutorial.md | 4 ++-- tutorials/21_heightmap.md | 4 ++-- tutorials/21_render_order.md | 2 +- tutorials/22_environment_map.md | 2 +- tutorials/23_depth_camera_tutorial.md | 2 +- 34 files changed, 77 insertions(+), 67 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/Changelog.md b/Changelog.md index a67a3c965..88e8971c8 100644 --- a/Changelog.md +++ b/Changelog.md @@ -194,7 +194,7 @@ 1. Fix particle effect randomness * [Pull request #388](https://github.com/gazebosim/gz-rendering/pull/388) -1. Update test config to run ogre 1.x tests in ign-rendering6 on macOS +1. Update test config to run ogre 1.x tests in gz-rendering6 on macOS * [Pull request #407](https://github.com/gazebosim/gz-rendering/pull/407) * [Pull request #409](https://github.com/gazebosim/gz-rendering/pull/409) * [Pull request #409](https://github.com/gazebosim/gz-rendering/pull/409) @@ -334,7 +334,7 @@ * [Pull request #398](https://github.com/gazebosim/gz-rendering/pull/398) * [Pull request #389](https://github.com/gazebosim/gz-rendering/pull/389) -1. Set OGRE minimal version to 1.8. Warn on versions not supported (ign-rendering3) +1. Set OGRE minimal version to 1.8. Warn on versions not supported (gz-rendering3) * [Pull request #376](https://github.com/gazebosim/gz-rendering/pull/376) 1. 👩‍🌾 Remove bitbucket-pipelines.yml @@ -343,7 +343,7 @@ 1. [macOS] support OpenGL < 4.2 in PBS shader * [Pull request #377](https://github.com/gazebosim/gz-rendering/pull/377) -1. Moved ScreenToPlane and ScreenToScene from ign-gui to ign-rendering +1. Moved ScreenToPlane and ScreenToScene from gz-gui to gz-rendering * [Pull request #363](https://github.com/gazebosim/gz-rendering/pull/363) * [Pull request #368](https://github.com/gazebosim/gz-rendering/pull/368) @@ -388,7 +388,7 @@ 1. Test re-enabling depth camera integration test on mac * [Pull request #335](https://github.com/gazebosim/gz-rendering/pull/335) -1. Include MoveTo Helper class to ign-rendering +1. Include MoveTo Helper class to gz-rendering * [Pull request #311](https://github.com/gazebosim/gz-rendering/pull/311) 1. Remove `tools/code_check` and update codecov @@ -455,7 +455,7 @@ 1. ogre2: explicitly request OpenGL 3.3 core profile context. * [Pull request #244](https://github.com/gazebosim/gz-rendering/pull/244) -1. Bump in edifice: ign-common4 +1. Bump in edifice: gz-common4 * [Pull request #209](https://github.com/gazebosim/gz-rendering/pull/209) 1. Support setting horizontal and vertical resolution for GpuRays @@ -496,7 +496,7 @@ * [Pull request #378](https://github.com/gazebosim/gz-rendering/pull/378) * [Pull request #383](https://github.com/gazebosim/gz-rendering/pull/383) -1. All changes merged forward from ign-rendering3 +1. All changes merged forward from gz-rendering3 * [Pull request #382](https://github.com/gazebosim/gz-rendering/pull/382) * [Pull request #398](https://github.com/gazebosim/gz-rendering/pull/398) @@ -521,7 +521,7 @@ 1. Fix floating point precision bug handling alpha channel (#332) * [Pull request #333](https://github.com/gazebosim/gz-rendering/pull/333) -1. Include MoveTo Helper class to ign-rendering +1. Include MoveTo Helper class to gz-rendering * [Pull request #311](https://github.com/gazebosim/gz-rendering/pull/311) 1. Remove `tools/code_check` and update codecov @@ -741,7 +741,7 @@ 1. Ogre: Do not assume that ogre plugins have lib prefix on macOS * [Pull request 454](https://github.com/gazebosim/gz-rendering/pull/454) -1. Moved ScreenToPlane and ScreenToScene from ign-gui to ign-rendering +1. Moved ScreenToPlane and ScreenToScene from gz-gui to gz-rendering * [Pull request 363](https://github.com/gazebosim/gz-rendering/pull/363) * [Pull request 368](https://github.com/gazebosim/gz-rendering/pull/368) @@ -760,7 +760,7 @@ ### Gazebo Rendering 3.5.0 (2021-05-25) -1. Include MoveTo Helper class to ign-rendering +1. Include MoveTo Helper class to gz-rendering * [Pull request 311](https://github.com/gazebosim/gz-rendering/pull/311) 1. Remove tools/code_check and update codecov @@ -835,7 +835,7 @@ ### Gazebo Rendering 3.1.0 (2020-03-05) -1. Use default material properties from ign-common PBR material when loading a mesh +1. Use default material properties from gz-common PBR material when loading a mesh * [BitBucket pull request 242](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-rendering/pull-requests/242) 1. Fix build for ogre version >= 1.12.0 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__