gz/rendering/RenderEngineManager.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 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_RENDERENGINEMANAGER_HH_
#define GZ_RENDERING_RENDERENGINEMANAGER_HH_
 
#include <list>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include <gz/common/SingletonT.hh>
#include <gz/common/SuppressWarning.hh>
#include "gz/rendering/config.hh"
#include "gz/rendering/Export.hh"
 
namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    // forward declarations.
    class RenderEngine;
    class RenderEngineManagerPrivate;
 
    class IGNITION_RENDERING_VISIBLE RenderEngineManager :
      public virtual common::SingletonT<RenderEngineManager>
    {
      public: RenderEngineManager();
 
      public: ~RenderEngineManager();
 
      public: unsigned int EngineCount() const;
 
      public: bool HasEngine(const std::string &_name) const;
 
      public: bool IsEngineLoaded(const std::string &_name) const;
 
      public: std::vector<std::string> LoadedEngines() const;
 
      public: RenderEngine *Engine(const std::string &_name,
                  const std::map<std::string, std::string> &_params = {},
                  const std::string &_path = "");
 
      public: RenderEngine *EngineAt(unsigned int _index,
                  const std::map<std::string, std::string> &_params = {},
                  const std::string &_path = "");
 
      public: bool UnloadEngine(const std::string &_name);
 
      public: bool UnloadEngineAt(unsigned int _index);
 
      public: void RegisterEngine(const std::string &_name,
                  RenderEngine *_engine);
 
      public: void UnregisterEngine(const std::string &_name);
 
      public: void UnregisterEngine(RenderEngine *_engine);
 
      public: void UnregisterEngineAt(unsigned int _index);
 
      public: void SetPluginPaths(const std::list<std::string> &_paths);
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<RenderEngineManagerPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
 
      private: friend class gz::common::SingletonT<RenderEngineManager>;
    };
    }
  }
}
#endif