Gazebo Rendering

API Reference

9.0.0
RenderEnginePlugin.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2018 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17
18#ifndef GZ_RENDERING_RENDERENGINEPLUGIN_HH_
19#define GZ_RENDERING_RENDERENGINEPLUGIN_HH_
20
21#include <memory>
22#include <string>
23
24#include <gz/utils/SuppressWarning.hh>
25
26#include "gz/rendering/config.hh"
27#include "gz/rendering/Export.hh"
28
29namespace gz
30{
31 namespace rendering
32 {
33 inline namespace GZ_RENDERING_VERSION_NAMESPACE {
34 //
35 // Forward declarations
36 class RenderEngine;
37 class RenderEnginePluginPrivate;
38
40 class GZ_RENDERING_VISIBLE RenderEnginePlugin
41 {
44
46 public: virtual ~RenderEnginePlugin();
47
50 public: virtual std::string Name() const = 0;
51
54 public: virtual RenderEngine *Engine() const = 0;
55
57 GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
59 GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
60 };
61 }
62 }
63}
64#endif