Gazebo Sensors

API Reference

3.6.0
gz/sensors/RenderingSensor.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 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 #ifndef GZ_SENSORS_RENDERINGSENSOR_HH_
18 #define GZ_SENSORS_RENDERINGSENSOR_HH_
19 
20 #include <memory>
21 
22 #include <gz/common/SuppressWarning.hh>
23 
24 // TODO(louise) Remove these pragmas once ign-rendering is disabling the
25 // warnings
26 #ifdef _WIN32
27 #pragma warning(push)
28 #pragma warning(disable: 4251)
29 #endif
30 #include <gz/rendering/RenderTypes.hh>
31 #ifdef _WIN32
32 #pragma warning(pop)
33 #endif
34 
35 #include "gz/sensors/rendering/Export.hh"
36 #include "gz/sensors/Sensor.hh"
37 
38 namespace ignition
39 {
40  namespace sensors
41  {
42  // Inline bracket to help doxygen filtering.
43  inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
44  //
46  class RenderingSensorPrivate;
47 
52  class IGNITION_SENSORS_RENDERING_VISIBLE RenderingSensor
53  : public Sensor
54  {
56  protected: RenderingSensor();
57 
59  public: virtual ~RenderingSensor();
60 
64  public: virtual void SetScene(rendering::ScenePtr _scene);
65 
67  public: rendering::ScenePtr Scene() const;
68 
70  public: void Render();
71 
76  public: void SetManualSceneUpdate(bool _manual);
77 
82  public: bool ManualSceneUpdate() const;
83 
87  protected: void AddSensor(rendering::SensorPtr _sensor);
88 
89  IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
93  IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
94  };
95  }
96  }
97 }
98 
99 #endif
a rendering sensor class
Definition: gz/sensors/RenderingSensor.hh:52
Definition: gz/sensors/AirPressureSensor.hh:32
std::shared_ptr< Sensor > SensorPtr
Definition: gz/sensors/SensorTypes.hh:49
a base sensor class
Definition: gz/sensors/Sensor.hh:60