Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump main to rendering 10.0.0~pre1 #1079

Merged
merged 2 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/windows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
build:
name: Window CI
env:
PACKAGE: gz-rendering9
PACKAGE: gz-rendering10
runs-on: windows-latest
steps:
- name: setup-pixi
Expand Down
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/actor_animation/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/boundingbox_camera/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/camera_tracking/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/custom_scene_viewer/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/custom_shaders/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/custom_shaders_uniforms/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include_directories(SYSTEM
${PROJECT_BINARY_DIR}
)

find_package(gz-rendering9)
find_package(gz-rendering10)

set(TARGET_THIRD_PARTY_DEPENDS "")

Expand Down
2 changes: 1 addition & 1 deletion examples/depth_camera/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/global_illumination/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/heightmap/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
4 changes: 2 additions & 2 deletions examples/hello_world_plugin/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/lidar_visual/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/lux_core_engine/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/mesh_viewer/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/mouse_picking/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/ogre2_demo/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/particles_demo/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
6 changes: 3 additions & 3 deletions examples/projector/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/render_pass/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/segmentation_camera/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/simple_demo/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/simple_demo_qml/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/text_geom/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/thermal_camera/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/transform_control/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
2 changes: 1 addition & 1 deletion examples/view_control/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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})
Expand Down
2 changes: 1 addition & 1 deletion examples/visualization_demo/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/waves/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include_directories(SYSTEM
${PROJECT_BINARY_DIR}
)

find_package(gz-rendering9)
find_package(gz-rendering10)

set(TARGET_THIRD_PARTY_DEPENDS "")

Expand Down
2 changes: 1 addition & 1 deletion examples/wide_angle_camera/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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}
Expand Down
4 changes: 2 additions & 2 deletions package.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?xml version="1.0"?>
<?xml-model href="http://download.ros.org/schema/package_format2.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="2">
<name>gz-rendering9</name>
<version>9.0.0</version>
<name>gz-rendering10</name>
<version>10.0.0</version>
<description>Gazebo Rendering: Rendering library for robot applications</description>
<maintainer email="ichen@openrobotics.org">Ian Chen</maintainer>
<license>Apache License 2.0</license>
Expand Down
12 changes: 6 additions & 6 deletions tutorials/03_rendering_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.).

Expand Down
2 changes: 1 addition & 1 deletion tutorials/17_render_pass_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tutorials/18_simple_demo_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tutorials/19_text_geom_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tutorials/20_particles_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tutorials/21_heightmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
===============================
Expand Down