RenderEngine.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2016 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 _GAZEBO_RENDERING_RENDERENGINE_HH_
#define _GAZEBO_RENDERING_RENDERENGINE_HH_

#include <memory>
#include <string>

#include "gazebo/common/SingletonT.hh"
#include "gazebo/common/CommonTypes.hh"

#include "gazebo/rendering/ogre_gazebo.h"
#include "gazebo/rendering/RenderTypes.hh"
#include "gazebo/util/system.hh"

namespace Ogre
{
  class Root;
  class OverlaySystem;
}

namespace gazebo
{
  namespace rendering
  {
    // Forward declare private data.
    class RenderEnginePrivate;


    class GZ_RENDERING_VISIBLE RenderEngine : public SingletonT<RenderEngine>
    {
      public: enum RenderPathType
              {
                NONE = 0,
                VERTEX = 1,
                FORWARD = 2,
                DEFERRED = 3,
                RENDER_PATH_COUNT
              };

      private: RenderEngine();

      private: virtual ~RenderEngine();

      public: void Load();

      public: void Init();

      public: void Fini();

      public: ScenePtr CreateScene(const std::string &_name,
                                   bool _enableVisualizations,
                                   bool _isServer = false);

      public: void RemoveScene(const std::string &_name);

      public: ScenePtr GetScene(const std::string &_name="");

      public: ScenePtr GetScene(unsigned int _index);

      public: unsigned int GetSceneCount() const GAZEBO_DEPRECATED(7.0);

      public: unsigned int SceneCount() const;

      public: void AddResourcePath(const std::string &_uri);

      public: RenderPathType GetRenderPathType() const;

      public: WindowManagerPtr GetWindowManager() const;

      public: Ogre::Root *Root() const;

#if OGRE_VERSION_MAJOR > 1 || OGRE_VERSION_MINOR >= 9
      public: Ogre::OverlaySystem *GetOverlaySystem() const
          GAZEBO_DEPRECATED(7.0);

      public: Ogre::OverlaySystem *OverlaySystem() const;
#endif

      private: bool CreateContext();

      private: void LoadPlugins();

      private: void SetupResources();

      private: void SetupRenderSystem();

      private: void PreRender();

      private: void Render();

      private: void PostRender();

      private: void CheckSystemCapabilities();

      protected: uint64_t dummyWindowId;

      protected: void *dummyDisplay;

      protected: void *dummyContext;

      private: friend class SingletonT<RenderEngine>;

      private: std::unique_ptr<RenderEnginePrivate> dataPtr;
    };
  }
}
#endif