[WIP] Port #1175 under a CMake option

Signed-off-by: Jose Luis Rivero <jrivero@honurobotics.com>

Author: j-rivero

CMakeLists.txt

@@ -24,6 +24,7 @@ gz_configure_project(VERSION_SUFFIX)
 # Set project-specific options
 #============================================================================
 option(USE_UNOFFICIAL_OGRE_VERSIONS "Accept unsupported Ogre versions in the build" OFF)
+option(USE_OGRE2_OVERLAY "Enable OGRE2 Overlay support" OFF)  # TODO: change default to ON
 
 #============================================================================
 # Search for project-specific dependencies
@@ -102,21 +103,40 @@ endif()
 # Find OGRE2: first try to find OGRE2 built with PlanarReflections support and
 # fallback to look for OGRE2 without it. Both seems to works for gz-rendering.
 # See https://github.com/gazebosim/gz-rendering/issues/597
+
+# Build the list of OGRE2 components based on the options
+set(OGRE2_COMPONENTS HlmsPbs HlmsUnlit)
+if(USE_OGRE2_OVERLAY)
+  list(APPEND OGRE2_COMPONENTS Overlay)
+endif()
+
 gz_find_package(GzOGRE2 VERSION 2.3.1
-    COMPONENTS HlmsPbs HlmsUnlit Overlay PlanarReflections
+    COMPONENTS ${OGRE2_COMPONENTS} PlanarReflections
     PRIVATE_FOR ogre2
     QUIET)
 
 if ("${OGRE2-PlanarReflections}" STREQUAL "OGRE2-PlanarReflections-NOTFOUND")
   message(STATUS "PlanarReflections component was not found. Try looking without it:")
   gz_find_package(GzOGRE2 VERSION 2.3.1
-    COMPONENTS HlmsPbs HlmsUnlit Overlay
+    COMPONENTS ${OGRE2_COMPONENTS}
     REQUIRED_BY ogre2
     PRIVATE_FOR ogre2)
 endif()
 
 if (OGRE2_FOUND)
   set(GZ_RENDERING_HAVE_OGRE2 TRUE)
+
+  # Set overlay support based on option and component availability
+  if(USE_OGRE2_OVERLAY AND TARGET OGRE2::Overlay)
+    set(GZ_RENDERING_HAVE_OGRE2_OVERLAY TRUE)
+    message(STATUS "OGRE2 Overlay support enabled")
+  else()
+    if(USE_OGRE2_OVERLAY)
+      message(STATUS "OGRE2 Overlay requested but not available - disabling overlay support")
+    else()
+      message(STATUS "OGRE2 Overlay support disabled by configuration")
+    endif()
+  endif()
 endif()
 
 #--------------------------------------

Migration.md

@@ -1,10 +1,28 @@
 # Note on deprecations
+
 A tick-tock release cycle allows easy migration to new software versions.
 Obsolete code is marked as deprecated for one major release.
 Deprecated code produces compile-time warnings. These warning serve as
 notification to users that their code should be upgraded. The next major
 release will remove the deprecated code.
 
+## Gazebo Rendering 9.x to 10.x
+
+### Conditional Overlay Support
+
+As of gz-rendering10, the OGRE2 Overlay component dependency is removed
+due to compatibility issues (<https://github.com/OGRECave/ogre-next/issues/541>).
+By default, overlay support is enabled, but it can be disabled using the CMake
+option `USE_OGRE2_OVERLAY=OFF`. When overlay support is disabled, the following
+internal API methods will not be available:
+
+1. **Ogre2RenderEngine**
+   + Unavailable (when `USE_OGRE2_OVERLAY=OFF`): `Ogre::v1::OverlaySystem *OverlaySystem() const`
+
+Note: The `OverlaySystem` method was always marked as internal and was not part
+of the public API. This change only affects code that directly used this internal
+method.
+
 ## Gazebo Rendering 8.x to 9.x
 
 ### Deprecations

include/gz/rendering/config.hh.in

@@ -38,6 +38,7 @@
 
 #cmakedefine GZ_RENDERING_HAVE_OGRE 1
 #cmakedefine GZ_RENDERING_HAVE_OGRE2 1
+#cmakedefine GZ_RENDERING_HAVE_OGRE2_OVERLAY 1
 #cmakedefine GZ_RENDERING_HAVE_OPTIX 1
 #cmakedefine GZ_RENDERING_HAVE_VULKAN 1
 

ogre2/include/gz/rendering/ogre2/Ogre2Includes.hh

@@ -17,6 +17,8 @@
 #ifndef GZ_RENDERING_OGRE2_OGRE2INCLUDES_HH_
 #define GZ_RENDERING_OGRE2_OGRE2INCLUDES_HH_
 
+#include "gz/rendering/config.hh"
+
 // This disables warning messages for OGRE
 #ifndef _MSC_VER
   #pragma GCC system_header
@@ -96,12 +98,14 @@
 #include <Compositor/Pass/PassScene/OgreCompositorPassScene.h>
 #include <Compositor/Pass/PassScene/OgreCompositorPassSceneDef.h>
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
 #include <Overlay/OgreOverlayPrerequisites.h>
 #include <Overlay/OgreOverlayManager.h>
 #include <Overlay/OgreOverlayElement.h>
 #include <Overlay/OgreOverlayContainer.h>
 #include <Overlay/OgreFontManager.h>
 #include <Overlay/OgreOverlaySystem.h>
+#endif
 
 // TODO(anyone): enable when ogre 2.1 fully supports paging
 // and terrain components

ogre2/include/gz/rendering/ogre2/Ogre2RenderEngine.hh

@@ -24,6 +24,7 @@
 
 #include <gz/common/SingletonT.hh>
 
+#include "gz/rendering/config.hh"
 #include "gz/rendering/GraphicsAPI.hh"
 #include "gz/rendering/RenderEnginePlugin.hh"
 #include "gz/rendering/base/BaseRenderEngine.hh"
@@ -37,10 +38,12 @@ namespace Ogre
   class LogManager;
   class Root;
   class Window;
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
   namespace v1
   {
     class OverlaySystem;
   }
+#endif
 
   class HlmsPbsTerraShadows;
   class CompositorWorkspaceListener;
@@ -161,8 +164,10 @@ namespace gz
       /// \brief Create ogre root
       private: void CreateRoot();
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
       /// \brief Create ogre overlay component
       private: void CreateOverlay();
+#endif
 
       /// \brief Create ogre plugins.
       private: void LoadPlugins();
@@ -187,10 +192,12 @@ namespace gz
       /// \return Ogre HLMS customizations
       public: Ogre2GzHlmsSphericalClipMinDistance &SphericalClipMinDistance();
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
       /// \internal
       /// \brief Get a pointer to the Ogre overlay system.
       /// \return Pointer to the ogre overlay system.
       public: Ogre::v1::OverlaySystem *OverlaySystem() const;
+#endif
 
       /// \internal
       /// \brief Sets the current rendering mode. See GzOgreRenderingMode
@@ -221,8 +228,10 @@ namespace gz
       /// \return a pointer to the render engine
       public: static Ogre2RenderEngine *Instance();
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
       /// \brief Pointer to the ogre's overlay system
       private: Ogre::v1::OverlaySystem *ogreOverlaySystem = nullptr;
+#endif
 
       /// \brief List of scenes managed by the render engine
       private: Ogre2SceneStorePtr scenes;

ogre2/src/Ogre2RenderEngine.cc

@@ -28,6 +28,7 @@
 
 #include <gz/plugin/Register.hh>
 
+#include "gz/rendering/config.hh"
 #include "gz/rendering/GraphicsAPI.hh"
 #include "gz/rendering/InstallationDirectories.hh"
 #include "gz/rendering/RenderEngineManager.hh"
@@ -190,8 +191,10 @@ void Ogre2RenderEngine::Destroy()
     this->scenes->RemoveAll();
   }
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
   delete this->ogreOverlaySystem;
   this->ogreOverlaySystem = nullptr;
+#endif
 
   this->dataPtr->hlmsPbsTerraShadows.reset();
 
@@ -501,7 +504,9 @@ void Ogre2RenderEngine::LoadAttempt()
   }
 
   this->CreateRoot();
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
   this->CreateOverlay();
+#endif
   this->LoadPlugins();
   this->CreateRenderSystem();
   this->ogreRoot->initialise(false);
@@ -636,11 +641,13 @@ void Ogre2RenderEngine::CreateRoot()
   }
 }
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
 //////////////////////////////////////////////////
 void Ogre2RenderEngine::CreateOverlay()
 {
   this->ogreOverlaySystem = new Ogre::v1::OverlaySystem();
 }
+#endif
 
 //////////////////////////////////////////////////
 void Ogre2RenderEngine::LoadPlugins()
@@ -1416,11 +1423,13 @@ SphericalClipMinDistance()
   return this->dataPtr->sphericalClipMinDistance;
 }
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
 /////////////////////////////////////////////////
 Ogre::v1::OverlaySystem *Ogre2RenderEngine::OverlaySystem() const
 {
   return this->ogreOverlaySystem;
 }
+#endif
 
 /////////////////////////////////////////////////
 void Ogre2RenderEngine::SetGzOgreRenderingMode(

ogre2/src/Ogre2Scene.cc

@@ -31,6 +31,7 @@
 
 #include <gz/common/Console.hh>
 
+#include "gz/rendering/config.hh"
 #include "gz/rendering/base/SceneExt.hh"
 #include "gz/rendering/GraphicsAPI.hh"
 #include "gz/rendering/RenderTypes.hh"
@@ -83,8 +84,10 @@
 #include <OgrePlatformInformation.h>
 #include <OgreRoot.h>
 #include <OgreSceneManager.h>
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
 #include <Overlay/OgreOverlayManager.h>
 #include <Overlay/OgreOverlaySystem.h>
+#endif
 #if OGRE_VERSION_MAJOR == 2 && OGRE_VERSION_MINOR == 1
 #include <OgreHlms.h>
 #include <OgreHlmsManager.h>
@@ -501,11 +504,13 @@ void Ogre2Scene::Destroy()
 
   BaseScene::Destroy();
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
   if (this->ogreSceneManager)
   {
     this->ogreSceneManager->removeRenderQueueListener(
         Ogre2RenderEngine::Instance()->OverlaySystem());
   }
+#endif
 
   if (this->dataPtr->activeGi)
   {
@@ -1477,12 +1482,14 @@ void Ogre2Scene::CreateContext()
   this->ogreSceneManager = root->createSceneManager(Ogre::ST_GENERIC,
                                                     numThreads);
 
+#ifdef GZ_RENDERING_HAVE_OGRE2_OVERLAY
   this->ogreSceneManager->addRenderQueueListener(
       Ogre2RenderEngine::Instance()->OverlaySystem());
 
   this->ogreSceneManager->getRenderQueue()->setSortRenderQueue(
       Ogre::v1::OverlayManager::getSingleton().mDefaultRenderQueueId,
       Ogre::RenderQueue::StableSort);
+#endif
 
   // Set sane defaults for proper shadow mapping
   this->ogreSceneManager->setShadowDirectionalLightExtrusionDistance(500.0f);