Public Member Functions | Protected Attributes | List of all members
gazebo::CameraPlugin Class Reference

#include <CameraPlugin.hh>

Inheritance diagram for gazebo::CameraPlugin:
Inheritance graph
[legend]

Public Member Functions

 CameraPlugin ()
 
virtual ~CameraPlugin ()
 Destructor. More...
 
virtual void Load (sensors::SensorPtr _sensor, sdf::ElementPtr _sdf)
 Load function. More...
 
virtual void OnNewFrame (const unsigned char *_image, unsigned int _width, unsigned int _height, unsigned int _depth, const std::string &_format)
 
- Public Member Functions inherited from gazebo::SensorPlugin
 SensorPlugin ()
 Constructor. More...
 
virtual ~SensorPlugin ()
 Destructor. More...
 
virtual void Init ()
 Override this method for custom plugin initialization behavior. More...
 
virtual void Reset ()
 Override this method for custom plugin reset behavior. More...
 
- Public Member Functions inherited from gazebo::PluginT< SensorPlugin >
 PluginT ()
 Constructor. More...
 
virtual ~PluginT ()
 Destructor. More...
 
std::string GetFilename () const
 Get the name of the handler. More...
 
std::string GetHandle () const
 Get the short name of the handler. More...
 
PluginType GetType () const
 Returns the type of the plugin. More...
 

Protected Attributes

rendering::CameraPtr camera
 
unsigned int depth
 
std::string format
 
unsigned int height
 
sensors::CameraSensorPtr parentSensor
 
unsigned int width
 
- Protected Attributes inherited from gazebo::PluginT< SensorPlugin >
std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Additional Inherited Members

- Public Types inherited from gazebo::PluginT< SensorPlugin >
typedef boost::shared_ptr
< SensorPlugin
TPtr
 plugin pointer type definition More...
 
- Static Public Member Functions inherited from gazebo::PluginT< SensorPlugin >
static TPtr Create (const std::string &_filename, const std::string &_name)
 a class method that creates a plugin from a file name. More...
 

Constructor & Destructor Documentation

gazebo::CameraPlugin::CameraPlugin ( )
virtual gazebo::CameraPlugin::~CameraPlugin ( )
virtual

Destructor.

Member Function Documentation

virtual void gazebo::CameraPlugin::Load ( sensors::SensorPtr  _sensor,
sdf::ElementPtr  _sdf 
)
virtual

Load function.

Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.

Parameters
[in]_sensorPointer the Sensor.
[in]_sdfPointer the the SDF element of the plugin.

Implements gazebo::SensorPlugin.

virtual void gazebo::CameraPlugin::OnNewFrame ( const unsigned char *  _image,
unsigned int  _width,
unsigned int  _height,
unsigned int  _depth,
const std::string &  _format 
)
virtual

Member Data Documentation

rendering::CameraPtr gazebo::CameraPlugin::camera
protected
unsigned int gazebo::CameraPlugin::depth
protected
std::string gazebo::CameraPlugin::format
protected
unsigned int gazebo::CameraPlugin::height
protected
sensors::CameraSensorPtr gazebo::CameraPlugin::parentSensor
protected
unsigned int gazebo::CameraPlugin::width
protected

The documentation for this class was generated from the following file: