gz/rendering/RenderingIface.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_RENDERINGIFACE_HH_
#define GZ_RENDERING_RENDERINGIFACE_HH_
 
#include <list>
#include <map>
#include <string>
#include <vector>
 
#include "gz/rendering/config.hh"
#include "gz/rendering/Export.hh"
#include "gz/rendering/RenderTypes.hh"
 
namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    class RenderEngine;
 
    IGNITION_RENDERING_VISIBLE
    bool load();
 
    IGNITION_RENDERING_VISIBLE
    bool init();
 
    IGNITION_RENDERING_VISIBLE
    bool fini();
 
    IGNITION_RENDERING_VISIBLE
    unsigned int engineCount();
 
    IGNITION_RENDERING_VISIBLE
    bool hasEngine(const std::string &_name);
 
    IGNITION_RENDERING_VISIBLE
    bool isEngineLoaded(const std::string &_name);
 
    IGNITION_RENDERING_VISIBLE
    std::vector<std::string> loadedEngines();
 
    IGNITION_RENDERING_VISIBLE
    RenderEngine *engine(const std::string &_name,
        const std::map<std::string, std::string> &_params = {},
        const std::string &_path = "");
 
    IGNITION_RENDERING_VISIBLE
    RenderEngine *engine(const unsigned int _index,
        const std::map<std::string, std::string> &_params = {},
        const std::string &_path = "");
 
    IGNITION_RENDERING_VISIBLE
    bool unloadEngine(const std::string &_name);
 
    IGNITION_RENDERING_VISIBLE
    void registerEngine(const std::string &_name, RenderEngine *_engine);
 
    IGNITION_RENDERING_VISIBLE
    void unregisterEngine(const std::string &_name);
 
    IGNITION_RENDERING_VISIBLE
    void unregisterEngine(RenderEngine *_engine);
 
    IGNITION_RENDERING_VISIBLE
    void unregisterEngine(const unsigned int _index);
 
    IGNITION_RENDERING_VISIBLE
    void setPluginPaths(const std::list<std::string> &_paths);
 
    IGNITION_RENDERING_VISIBLE
    ScenePtr sceneFromFirstRenderEngine();
    }
  }
}
#endif