From 21566ee6daf819fd05cee566b78887e7a372206e Mon Sep 17 00:00:00 2001 From: Ian Chen Date: Wed, 9 Oct 2024 17:08:31 +0000 Subject: [PATCH] bump main to rendering10~pre1 Signed-off-by: Ian Chen --- .github/workflows/windows.yaml | 2 +- CMakeLists.txt | 4 ++-- Changelog.md | 4 ++++ examples/actor_animation/CMakeLists.txt | 2 +- examples/boundingbox_camera/CMakeLists.txt | 2 +- examples/camera_tracking/CMakeLists.txt | 2 +- examples/custom_scene_viewer/CMakeLists.txt | 2 +- examples/custom_shaders/CMakeLists.txt | 2 +- examples/custom_shaders_uniforms/CMakeLists.txt | 2 +- examples/depth_camera/CMakeLists.txt | 2 +- examples/global_illumination/CMakeLists.txt | 2 +- examples/heightmap/CMakeLists.txt | 2 +- examples/hello_world_plugin/CMakeLists.txt | 4 ++-- examples/lidar_visual/CMakeLists.txt | 2 +- examples/lux_core_engine/CMakeLists.txt | 2 +- examples/mesh_viewer/CMakeLists.txt | 2 +- examples/mouse_picking/CMakeLists.txt | 2 +- examples/ogre2_demo/CMakeLists.txt | 2 +- examples/particles_demo/CMakeLists.txt | 2 +- examples/projector/CMakeLists.txt | 6 +++--- examples/render_pass/CMakeLists.txt | 2 +- examples/segmentation_camera/CMakeLists.txt | 2 +- examples/simple_demo/CMakeLists.txt | 2 +- examples/simple_demo_qml/CMakeLists.txt | 2 +- examples/text_geom/CMakeLists.txt | 2 +- examples/thermal_camera/CMakeLists.txt | 2 +- examples/transform_control/CMakeLists.txt | 2 +- examples/view_control/CMakeLists.txt | 2 +- examples/visualization_demo/CMakeLists.txt | 2 +- examples/waves/CMakeLists.txt | 2 +- examples/wide_angle_camera/CMakeLists.txt | 2 +- package.xml | 4 ++-- tutorials/03_rendering_plugins.md | 12 ++++++------ 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 +- 38 files changed, 51 insertions(+), 47 deletions(-) diff --git a/.github/workflows/windows.yaml b/.github/workflows/windows.yaml index e3ed647a9..1444b4cab 100644 --- a/.github/workflows/windows.yaml +++ b/.github/workflows/windows.yaml @@ -6,7 +6,7 @@ jobs: build: name: Window CI env: - PACKAGE: gz-rendering9 + PACKAGE: gz-rendering10 runs-on: windows-latest steps: - name: setup-pixi diff --git a/CMakeLists.txt b/CMakeLists.txt index bf7aa7098..8b26ca9b5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) #============================================================================ # Initialize the project #============================================================================ -project(gz-rendering9 VERSION 9.0.0) +project(gz-rendering10 VERSION 10.0.0) #============================================================================ # Find gz-cmake @@ -18,7 +18,7 @@ set(GZ_CMAKE_VER ${gz-cmake4_VERSION_MAJOR}) set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) -gz_configure_project(VERSION_SUFFIX) +gz_configure_project(VERSION_SUFFIX pre1) #============================================================================ # Set project-specific options diff --git a/Changelog.md b/Changelog.md index c83802638..30ae0da01 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,5 +1,9 @@ ## Gazebo Rendering +### Gazebo Rendering 10.X + +### Gazebo Rendering 10.0.0 (20XX-XX-XX) + ### Gazebo Rendering 9.X ### Gazebo Rendering 9.0.0 (2024-09-25) diff --git a/examples/actor_animation/CMakeLists.txt b/examples/actor_animation/CMakeLists.txt index d47126e70..27c4afefc 100644 --- a/examples/actor_animation/CMakeLists.txt +++ b/examples/actor_animation/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-actor-animation) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/boundingbox_camera/CMakeLists.txt b/examples/boundingbox_camera/CMakeLists.txt index 2e7ce8b85..663d6a6ac 100644 --- a/examples/boundingbox_camera/CMakeLists.txt +++ b/examples/boundingbox_camera/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-boundingbox-camera) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/camera_tracking/CMakeLists.txt b/examples/camera_tracking/CMakeLists.txt index a84dcaf62..b99e7adae 100644 --- a/examples/camera_tracking/CMakeLists.txt +++ b/examples/camera_tracking/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-camera-tracking) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) find_package(GLUT REQUIRED) include_directories(SYSTEM ${GLUT_INCLUDE_DIRS}) diff --git a/examples/custom_scene_viewer/CMakeLists.txt b/examples/custom_scene_viewer/CMakeLists.txt index 3bb932a4d..6d29212f9 100644 --- a/examples/custom_scene_viewer/CMakeLists.txt +++ b/examples/custom_scene_viewer/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-custom-scene-viewer) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/custom_shaders/CMakeLists.txt b/examples/custom_shaders/CMakeLists.txt index 065778aed..153e6ab4d 100644 --- a/examples/custom_shaders/CMakeLists.txt +++ b/examples/custom_shaders/CMakeLists.txt @@ -5,7 +5,7 @@ include_directories(SYSTEM ${PROJECT_BINARY_DIR} ) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) find_package(GLUT REQUIRED) include_directories(SYSTEM ${GLUT_INCLUDE_DIRS}) diff --git a/examples/custom_shaders_uniforms/CMakeLists.txt b/examples/custom_shaders_uniforms/CMakeLists.txt index 16ca48496..be4a59e76 100644 --- a/examples/custom_shaders_uniforms/CMakeLists.txt +++ b/examples/custom_shaders_uniforms/CMakeLists.txt @@ -5,7 +5,7 @@ include_directories(SYSTEM ${PROJECT_BINARY_DIR} ) -find_package(gz-rendering9) +find_package(gz-rendering10) set(TARGET_THIRD_PARTY_DEPENDS "") diff --git a/examples/depth_camera/CMakeLists.txt b/examples/depth_camera/CMakeLists.txt index 79d9a471c..79d85a81b 100644 --- a/examples/depth_camera/CMakeLists.txt +++ b/examples/depth_camera/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-depth-camera) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/global_illumination/CMakeLists.txt b/examples/global_illumination/CMakeLists.txt index 717fa4ae6..a3674b2b2 100644 --- a/examples/global_illumination/CMakeLists.txt +++ b/examples/global_illumination/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-global_illumination) -find_package(gz-rendering9) +find_package(gz-rendering10) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/heightmap/CMakeLists.txt b/examples/heightmap/CMakeLists.txt index c20213ff2..9297f5530 100644 --- a/examples/heightmap/CMakeLists.txt +++ b/examples/heightmap/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-heightmap) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/hello_world_plugin/CMakeLists.txt b/examples/hello_world_plugin/CMakeLists.txt index c8df1fbcb..ab1b2ed25 100644 --- a/examples/hello_world_plugin/CMakeLists.txt +++ b/examples/hello_world_plugin/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) -find_package(gz-rendering9 REQUIRED) -set(GZ_RENDERING_VER ${gz-rendering9_VERSION_MAJOR}) +find_package(gz-rendering10 REQUIRED) +set(GZ_RENDERING_VER ${gz-rendering10_VERSION_MAJOR}) find_package(gz-plugin3 REQUIRED COMPONENTS all) set(GZ_PLUGIN_VER ${gz-plugin3_VERSION_MAJOR}) diff --git a/examples/lidar_visual/CMakeLists.txt b/examples/lidar_visual/CMakeLists.txt index 1f7a06d41..40fbf0bf8 100644 --- a/examples/lidar_visual/CMakeLists.txt +++ b/examples/lidar_visual/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-lidar_visual) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/lux_core_engine/CMakeLists.txt b/examples/lux_core_engine/CMakeLists.txt index 2f19c3bb2..624bd8e2a 100644 --- a/examples/lux_core_engine/CMakeLists.txt +++ b/examples/lux_core_engine/CMakeLists.txt @@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) set(GZ_PLUGIN_VER 2) set(GZ_COMMON_VER 5) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) find_package(gz-plugin3 REQUIRED COMPONENTS all) if (NOT DEFINED ENV{LUXCORE_SDK_PATH}) diff --git a/examples/mesh_viewer/CMakeLists.txt b/examples/mesh_viewer/CMakeLists.txt index 875df453d..0544fcd7a 100644 --- a/examples/mesh_viewer/CMakeLists.txt +++ b/examples/mesh_viewer/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-mesh-viewer) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/mouse_picking/CMakeLists.txt b/examples/mouse_picking/CMakeLists.txt index a0dc637d7..2b8f091ca 100644 --- a/examples/mouse_picking/CMakeLists.txt +++ b/examples/mouse_picking/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-mouse-picking) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/ogre2_demo/CMakeLists.txt b/examples/ogre2_demo/CMakeLists.txt index 35b305a3e..82c63062e 100644 --- a/examples/ogre2_demo/CMakeLists.txt +++ b/examples/ogre2_demo/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-ogre2-demo) -find_package(gz-rendering9) +find_package(gz-rendering10) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/particles_demo/CMakeLists.txt b/examples/particles_demo/CMakeLists.txt index cfe7d93cd..b0cd71f68 100644 --- a/examples/particles_demo/CMakeLists.txt +++ b/examples/particles_demo/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-particles-demo) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/projector/CMakeLists.txt b/examples/projector/CMakeLists.txt index 4561fea50..647d1557e 100644 --- a/examples/projector/CMakeLists.txt +++ b/examples/projector/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-projector) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} @@ -30,8 +30,8 @@ target_link_libraries(projector ${GLUT_LIBRARIES} ${OPENGL_LIBRARIES} ${GLEW_LIBRARIES} - gz-rendering9::gz-rendering9 - gz-rendering9::core + gz-rendering10::gz-rendering10 + gz-rendering10::core ) add_custom_command(TARGET projector POST_BUILD diff --git a/examples/render_pass/CMakeLists.txt b/examples/render_pass/CMakeLists.txt index 082440d3c..b6cb3a9cd 100644 --- a/examples/render_pass/CMakeLists.txt +++ b/examples/render_pass/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-render-pass) -find_package(gz-rendering9) +find_package(gz-rendering10) find_package(GLUT REQUIRED) include_directories(SYSTEM ${GLUT_INCLUDE_DIRS}) diff --git a/examples/segmentation_camera/CMakeLists.txt b/examples/segmentation_camera/CMakeLists.txt index 5f2be8214..153a3bbd9 100644 --- a/examples/segmentation_camera/CMakeLists.txt +++ b/examples/segmentation_camera/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-segmentation-camera) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/simple_demo/CMakeLists.txt b/examples/simple_demo/CMakeLists.txt index 973ff5059..b78d4cca4 100644 --- a/examples/simple_demo/CMakeLists.txt +++ b/examples/simple_demo/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-simple-demo) -find_package(gz-rendering9) +find_package(gz-rendering10) find_package(GLUT REQUIRED) include_directories(SYSTEM ${GLUT_INCLUDE_DIRS}) diff --git a/examples/simple_demo_qml/CMakeLists.txt b/examples/simple_demo_qml/CMakeLists.txt index f5a369369..be97c39b5 100644 --- a/examples/simple_demo_qml/CMakeLists.txt +++ b/examples/simple_demo_qml/CMakeLists.txt @@ -8,7 +8,7 @@ set(GZ_CMAKE_VER ${gz-cmake4_VERSION_MAJOR}) #------------------------------------------------------------------------ # Find gz-rendering -find_package(gz-rendering9) +find_package(gz-rendering10) #====================================== # Find Qt diff --git a/examples/text_geom/CMakeLists.txt b/examples/text_geom/CMakeLists.txt index 8cacdccaa..a90ec9888 100644 --- a/examples/text_geom/CMakeLists.txt +++ b/examples/text_geom/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-text-geom) -find_package(gz-rendering9) +find_package(gz-rendering10) find_package(GLUT REQUIRED) include_directories(SYSTEM ${GLUT_INCLUDE_DIRS}) diff --git a/examples/thermal_camera/CMakeLists.txt b/examples/thermal_camera/CMakeLists.txt index d75c89ad8..67deaaf22 100644 --- a/examples/thermal_camera/CMakeLists.txt +++ b/examples/thermal_camera/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-thermal-camera) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/transform_control/CMakeLists.txt b/examples/transform_control/CMakeLists.txt index e181cc5a9..112c2e3ed 100644 --- a/examples/transform_control/CMakeLists.txt +++ b/examples/transform_control/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-transform-control) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/examples/view_control/CMakeLists.txt b/examples/view_control/CMakeLists.txt index c82255016..5b71fa9e0 100644 --- a/examples/view_control/CMakeLists.txt +++ b/examples/view_control/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-view-control) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) find_package(GLUT REQUIRED) include_directories(SYSTEM ${GLUT_INCLUDE_DIRS}) diff --git a/examples/visualization_demo/CMakeLists.txt b/examples/visualization_demo/CMakeLists.txt index 432536b96..9f74bbdc1 100644 --- a/examples/visualization_demo/CMakeLists.txt +++ b/examples/visualization_demo/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-visualization-demo) -find_package(gz-rendering9) +find_package(gz-rendering10) if (APPLE OR UNIX) find_package(GLUT REQUIRED) diff --git a/examples/waves/CMakeLists.txt b/examples/waves/CMakeLists.txt index c0d404ee8..925cb2bc1 100644 --- a/examples/waves/CMakeLists.txt +++ b/examples/waves/CMakeLists.txt @@ -5,7 +5,7 @@ include_directories(SYSTEM ${PROJECT_BINARY_DIR} ) -find_package(gz-rendering9) +find_package(gz-rendering10) set(TARGET_THIRD_PARTY_DEPENDS "") diff --git a/examples/wide_angle_camera/CMakeLists.txt b/examples/wide_angle_camera/CMakeLists.txt index d6e125586..c7bf6caec 100644 --- a/examples/wide_angle_camera/CMakeLists.txt +++ b/examples/wide_angle_camera/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) project(gz-rendering-wide-angle-camera) -find_package(gz-rendering9 REQUIRED) +find_package(gz-rendering10 REQUIRED) include_directories(SYSTEM ${PROJECT_BINARY_DIR} diff --git a/package.xml b/package.xml index 8083274df..60a904c51 100644 --- a/package.xml +++ b/package.xml @@ -1,8 +1,8 @@ - gz-rendering9 - 9.0.0 + gz-rendering10 + 10.0.0 Gazebo Rendering: Rendering library for robot applications Ian Chen Apache License 2.0 diff --git a/tutorials/03_rendering_plugins.md b/tutorials/03_rendering_plugins.md index 16246e5eb..a3b34190e 100644 --- a/tutorials/03_rendering_plugins.md +++ b/tutorials/03_rendering_plugins.md @@ -11,18 +11,18 @@ It is also possible to integrate your own selected rendering engine by writing a #### How to Write Your Own Rendering Engine Plugin -A mocked example of a custom rendering engine plugin can be found [here](https://github.com/gazebosim/gz-rendering/tree/gz-rendering9/examples/hello_world_plugin). In order +A mocked example of a custom rendering engine plugin can be found [here](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin). In order to make your own custom rendering engine, this example is a good starting point. There are a few key things which will need to be done in order for a custom rendering engine to function: - * A singleton Render Engine class which implements the pure virtual functions in [`gz::rendering::BaseRenderEngine`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/include/gz/rendering/base/BaseRenderEngine.hh). - * A plugin class which implements the pure virtual functions in [`gz::rendering::RenderEnginePlugin`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/include/gz/rendering/RenderEnginePlugin.hh) - * Registering the plugin, this line can be seen at the bottom of the [`HelloWorldPlugin`](https://github.com/gazebosim/gz-rendering/tree/gz-rendering9/examples/hello_world_plugin/HelloWorldPlugin.cc) example + * A singleton Render Engine class which implements the pure virtual functions in [`gz::rendering::BaseRenderEngine`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/base/BaseRenderEngine.hh). + * A plugin class which implements the pure virtual functions in [`gz::rendering::RenderEnginePlugin`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/RenderEnginePlugin.hh) + * Registering the plugin, this line can be seen at the bottom of the [`HelloWorldPlugin`](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin/HelloWorldPlugin.cc) example -Finally, for your custom rendering engine to actually have any functionality and at minimum, display something in a window, you will need to implement your own `Scene` and `Camera` classes, which inherit from and implement the pure virtual functions of [`gz::rendering::Scene`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/include/gz/rendering/Scene.hh) and [`gz::rendering::Camera`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/include/gz/rendering/Camera.hh), respectively. The mocked example simply returns `nullptr` for its `CreateSceneImpl(...)` function, so it may be useful to look at the current `Scene` implementations for the other rendering engines within `gz::rendering` such as [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/ogre/src/OgreScene.cc) or [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/ogre2/src/Ogre2Scene.cc). Likewise, it may be helpful to look at the `Camera` implementations from [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/ogre/src/OgreCamera.cc) and [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering9/ogre2/src/Ogre2Camera.cc) +Finally, for your custom rendering engine to actually have any functionality and at minimum, display something in a window, you will need to implement your own `Scene` and `Camera` classes, which inherit from and implement the pure virtual functions of [`gz::rendering::Scene`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/Scene.hh) and [`gz::rendering::Camera`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/Camera.hh), respectively. The mocked example simply returns `nullptr` for its `CreateSceneImpl(...)` function, so it may be useful to look at the current `Scene` implementations for the other rendering engines within `gz::rendering` such as [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/main/ogre/src/OgreScene.cc) or [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2Scene.cc). Likewise, it may be helpful to look at the `Camera` implementations from [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/main/ogre/src/OgreCamera.cc) and [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2Camera.cc) #### Building and Running Your Rendering Engine Plugin with Gazebo -Once you have your own rendering plugin written, you can build it similarly to how the example is built. It may be helpful to look at the [`CMakeLists.txt`](https://github.com/gazebosim/gz-rendering/tree/gz-rendering9/examples/hello_world_plugin) from the example as it contains the boilerplate code needed to get a custom rendering engine plugin built. +Once you have your own rendering plugin written, you can build it similarly to how the example is built. It may be helpful to look at the [`CMakeLists.txt`](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin) from the example as it contains the boilerplate code needed to get a custom rendering engine plugin built. After you have your plugin built, you will need to set the `GZ_SIM_RENDER_ENGINE_PATH` environment variable to the path in which your built shared library resides. Note that you will need to do this for every command line instance unless you add the line to your startup shell script (`.bashrc`, `.zshrc`, etc.). diff --git a/tutorials/17_render_pass_tutorial.md b/tutorials/17_render_pass_tutorial.md index de7218e7e..604638b99 100644 --- a/tutorials/17_render_pass_tutorial.md +++ b/tutorials/17_render_pass_tutorial.md @@ -23,7 +23,7 @@ Execute the example: You'll see: ```{.sh} -[Msg] Loading plugin [gz-rendering9-ogre] +[Msg] Loading plugin [gz-rendering10-ogre] =============================== TAB - Switch render engines ESC - Exit diff --git a/tutorials/18_simple_demo_tutorial.md b/tutorials/18_simple_demo_tutorial.md index 7fb573503..4fd78bd6a 100644 --- a/tutorials/18_simple_demo_tutorial.md +++ b/tutorials/18_simple_demo_tutorial.md @@ -30,7 +30,7 @@ Execute the example: You'll see: ```{.sh} -[Msg] Loading plugin [gz-rendering9-ogre] +[Msg] Loading plugin [gz-rendering10-ogre] =============================== TAB - Switch render engines ESC - Exit diff --git a/tutorials/19_text_geom_tutorial.md b/tutorials/19_text_geom_tutorial.md index f8bc405d8..f333a8e48 100644 --- a/tutorials/19_text_geom_tutorial.md +++ b/tutorials/19_text_geom_tutorial.md @@ -23,7 +23,7 @@ Execute the example: You'll see: ```{.sh} -[Msg] Loading plugin [gz-rendering9-ogre] +[Msg] Loading plugin [gz-rendering10-ogre] =============================== TAB - Switch render engines ESC - Exit diff --git a/tutorials/20_particles_tutorial.md b/tutorials/20_particles_tutorial.md index e3a6a5507..ab576f35b 100644 --- a/tutorials/20_particles_tutorial.md +++ b/tutorials/20_particles_tutorial.md @@ -23,7 +23,7 @@ Execute the example: You'll see: ```{.sh} -[Msg] Loading plugin [gz-rendering9-ogre2] +[Msg] Loading plugin [gz-rendering10-ogre2] =============================== TAB - Switch render engines ESC - Exit diff --git a/tutorials/21_heightmap.md b/tutorials/21_heightmap.md index 894ed4d49..b2ec88582 100644 --- a/tutorials/21_heightmap.md +++ b/tutorials/21_heightmap.md @@ -32,7 +32,7 @@ Example 1 (image heightmap): You'll see: ```{.sh} -[Msg] Loading plugin [gz-rendering9-ogre] +[Msg] Loading plugin [gz-rendering10-ogre] [Msg] Loading heightmap: scene::Heightmap(65528) [Msg] Heightmap loaded. Process took 217 ms. ===============================