Fawkes API Fawkes Development Version
|
00001 00002 /*************************************************************************** 00003 * effect.cpp - Abstract class defining a camera effect controller 00004 * 00005 * Created: Wed Apr 22 11:01:18 2009 00006 * Copyright 2009 Tobias Kellner 00007 * 2005-2009 Tim Niemueller [www.niemueller.de] 00008 * 00009 ****************************************************************************/ 00010 00011 /* This program is free software; you can redistribute it and/or modify 00012 * it under the terms of the GNU General Public License as published by 00013 * the Free Software Foundation; either version 2 of the License, or 00014 * (at your option) any later version. A runtime exception applies to 00015 * this software (see LICENSE.GPL_WRE file mentioned below for details). 00016 * 00017 * This program is distributed in the hope that it will be useful, 00018 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00019 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00020 * GNU Library General Public License for more details. 00021 * 00022 * Read the full text in the LICENSE.GPL_WRE file in the doc directory. 00023 */ 00024 00025 #include <cams/control/effect.h> 00026 00027 namespace firevision { 00028 #if 0 /* just to make Emacs auto-indent happy */ 00029 } 00030 #endif 00031 00032 /** @class CameraControlEffect <cams/control/effect.h> 00033 * Camera effect control interface. 00034 * Some cameras feature camera effects. 00035 * 00036 * This interface shall be implemented by such cameras. 00037 * 00038 * @author Tim Niemueller 00039 * @author Tobias Kellner 00040 * 00041 * @fn bool CameraControlEffect::supports_effect(unsigned int effect) = 0 00042 * Check if camera control supports desired effect. 00043 * Use camera-specific constants. 00044 * @param effect supported effect 00045 * @return true, if effect is supported, false otherwise 00046 * 00047 * @fn void CameraControlEffect::set_effect(unsigned int effect) = 0 00048 * Enable effect. 00049 * @param effect camera-specific effect. 00050 * 00051 * @fn unsigned int CameraControlEffect::effect() = 0 00052 * Current effect. 00053 * @return current effect. 00054 * 00055 * @fn void CameraControlEffect::reset_effect() = 0 00056 * Reset effect. 00057 * Disable all effects. 00058 */ 00059 00060 /** No effect constant. 00061 * This is the only effect constant defined in the interface. All others that 00062 * may exist are specific for each camera control implementation. 00063 */ 00064 const unsigned int CameraControlEffect::EFFECT_NONE = 0; 00065 00066 00067 /** Empty virtual destructor. */ 00068 CameraControlEffect::~CameraControlEffect() 00069 { 00070 } 00071 00072 } // end namespace firevision