ppovb5fc7/gazebo/plugins/LensFlareSensorPlugin.hh

54 lines
1.7 KiB
C++
Raw Normal View History

2019-03-25 11:01:43 +08:00
/*
* Copyright (C) 2017 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_PLUGINS_LENSFLARESENSORPLUGIN_HH_
#define GAZEBO_PLUGINS_LENSFLARESENSORPLUGIN_HH_
#include <memory>
#include <gazebo/common/Plugin.hh>
namespace gazebo
{
// Forward declare private data class.
class LensFlareSensorPluginPrivate;
/// \brief Plugin that adds lens flare effect to a camera or multicamera
/// sensor
/// The plugin has the following optional parameter:
/// <scale> Scale of lens flare. Must be greater than 0
class GAZEBO_VISIBLE LensFlareSensorPlugin : public SensorPlugin
{
/// \brief Constructor.
public: LensFlareSensorPlugin();
/// \brief Destructor.
public: ~LensFlareSensorPlugin();
// Documentation inherited
public: virtual void Load(sensors::SensorPtr _sensor,
sdf::ElementPtr _sdf);
/// \brief Add lens flare effect to a camera
/// \param[in] _camera Camera to add the lens flare effect to.
private: void AddLensFlare(rendering::CameraPtr _camera);
/// \internal
/// \brief Private data pointer
private: std::unique_ptr<LensFlareSensorPluginPrivate> dataPtr;
};
}
#endif