Effect Class Reference
Base class for all effects. More...
#include <Effect.h>
Inheritance diagram for Effect:

Public Member Functions | |
virtual bool | open (yarp::os::Searchable &config) |
Configure an effect, and prepare it to run. | |
virtual bool | close () |
Shut an effect down. | |
virtual bool | reconfigure (yarp::os::Searchable &config) |
Reconfigure an effect while it is running. | |
virtual yarp::os::Property | getConfiguration () |
Recover the configuration of an effect. | |
virtual bool | draw (yarp::sig::ImageOf< yarp::sig::PixelRgb > &src, yarp::sig::ImageOf< yarp::sig::PixelRgb > &dest) |
Modify an image in an effect-specific way. | |
virtual yarp::sig::Image * | pdraw (yarp::sig::Image &src, yarp::sig::Image &dest) |
Modify an image in any format in an effect-specific way, producing an output in any format. | |
virtual std::string | getName () |
Get the name of an effect. | |
virtual bool | start () |
Prepare the effect for operation. | |
virtual bool | stop () |
Prepare the effect to cease operation. |
Detailed Description
Base class for all effects.For convenience, we treat effects as DeviceDrivers in YARP -- entities that can be created by name, and passed configuration information at runtime.
Member Function Documentation
virtual bool Effect::draw | ( | yarp::sig::ImageOf< yarp::sig::PixelRgb > & | src, | |
yarp::sig::ImageOf< yarp::sig::PixelRgb > & | dest | |||
) | [inline, virtual] |
Modify an image in an effect-specific way.
This is an RGB-to-RGB specialization of Effect::pdraw - it should return false if there is no such specialization.
virtual bool Effect::stop | ( | ) | [inline, virtual] |
Prepare the effect to cease operation.
It may be started again without a close/open cycle.
Reimplemented in PortEffectTV, and ParamEffect.
The documentation for this class was generated from the following file:
- src/common/Effect.h