gz/rendering/ogre2/Ogre2RenderEngine.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_RENDERING_OGRE2_OGRE2RENDERENGINE_HH_
#define GZ_RENDERING_OGRE2_OGRE2RENDERENGINE_HH_
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
#include <gz/common/SingletonT.hh>
 
#include "gz/rendering/GraphicsAPI.hh"
#include "gz/rendering/RenderEnginePlugin.hh"
#include "gz/rendering/base/BaseRenderEngine.hh"
#include "gz/rendering/base/BaseRenderTypes.hh"
#include "gz/rendering/ogre2/Ogre2RenderTypes.hh"
#include "gz/rendering/ogre2/Ogre2GzOgreRenderingMode.hh"
#include "gz/rendering/ogre2/Export.hh"
 
namespace Ogre
{
  class LogManager;
  class Root;
  class Window;
  namespace v1
  {
    class OverlaySystem;
  }
 
  class HlmsPbsTerraShadows;
  class CompositorWorkspaceListener;
}
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2RenderEnginePrivate;
    class Ogre2GzHlmsSphericalClipMinDistance;
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2RenderEnginePlugin :
      public RenderEnginePlugin
    {
      public: Ogre2RenderEnginePlugin();
 
      public: ~Ogre2RenderEnginePlugin() = default;
 
      public: std::string Name() const;
 
      public: RenderEngine *Engine() const;
    };
 
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2RenderEngine :
      public virtual BaseRenderEngine,
      public common::SingletonT<Ogre2RenderEngine>
    {
      private: Ogre2RenderEngine();
 
      public: virtual ~Ogre2RenderEngine();
 
      // Documentation Inherited.
      public: virtual void Destroy() override;
 
      // Documentation Inherited.
      public: virtual bool IsEnabled() const override;
 
      // Documentation Inherited.
      public: virtual std::string Name() const override;
 
      public: void AddResourcePath(const std::string &_uri) override;
 
      public: Ogre::Window * OgreWindow() const;
 
      public: virtual Ogre::Root *OgreRoot() const;
 
      public: std::string CreateRenderWindow(const std::string &_handle,
                  const unsigned int _width, const unsigned int _height,
                  const double _ratio, const unsigned int _antiAliasing);
 
      // Documentation Inherited
      public: virtual rendering::GraphicsAPI GraphicsAPI() const override;
 
      protected: virtual ScenePtr CreateSceneImpl(unsigned int _id,
                  const std::string &_name) override;
 
      protected: virtual SceneStorePtr Scenes() const override;
 
      // Documentation Inherited.
      protected: virtual bool LoadImpl(
          const std::map<std::string, std::string> &_params) override;
 
      protected: virtual bool InitImpl() override;
 
      private: void LoadAttempt();
 
      private: void CreateLogger();
 
      private: void CreateContext();
 
      private: void RegisterHlms();
 
      private: void CreateRoot();
 
      private: void CreateOverlay();
 
      private: void LoadPlugins();
 
      private: void CreateRenderSystem();
 
      private: void CreateRenderWindow();
 
      private: void CreateResources();
 
      private: void InitAttempt();
 
      public: std::vector<unsigned int> FSAALevels() const;
 
      public: Ogre2GzHlmsSphericalClipMinDistance GZ_DEPRECATED(7) &
          HlmsCustomizations();
 
      public: Ogre2GzHlmsSphericalClipMinDistance &SphericalClipMinDistance();
 
      public: Ogre::v1::OverlaySystem *OverlaySystem() const;
 
      public: void SetGzOgreRenderingMode(GzOgreRenderingMode renderingMode);
      // TODO(CH3): Deprecated. Remove on tock.
      public:
        inline void GZ_DEPRECATED(7) SetIgnOgreRenderingMode(
          GzOgreRenderingMode renderingMode)
        {
          return SetGzOgreRenderingMode(renderingMode);
        }
 
      public: Ogre::HlmsPbsTerraShadows *HlmsPbsTerraShadows() const;
 
      public: Ogre::CompositorWorkspaceListener
          *TerraWorkspaceListener() const;
 
      public: static Ogre2RenderEngine *Instance();
 
      private: Ogre::v1::OverlaySystem *ogreOverlaySystem = nullptr;
 
      private: Ogre2SceneStorePtr scenes;
 
      private: Ogre::Root *ogreRoot = nullptr;
 
      private: Ogre::LogManager *ogreLogManager = nullptr;
 
      private: std::vector<std::string> ogrePaths;
 
      private: void *dummyDisplay = nullptr;
 
      private: void *dummyContext = nullptr;
 
      private: uint64_t dummyWindowId = 0u;
 
      private: Ogre::Window *window = nullptr;
 
      private: bool useCurrentGLContext = false;
 
      private: std::unique_ptr<Ogre2RenderEnginePrivate> dataPtr;
 
      private: friend class common::SingletonT<Ogre2RenderEngine>;
    };
    }
  }
}
#endif