Public Member Functions | Static Public Attributes

firevision::CameraControlEffect Class Reference

Camera effect control interface. More...

#include <>>

Inheritance diagram for firevision::CameraControlEffect:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~CameraControlEffect ()
 Empty virtual destructor.
virtual bool supports_effect (unsigned int effect)=0
 Check if camera control supports desired effect.
virtual void set_effect (unsigned int effect)=0
 Enable effect.
virtual unsigned int effect ()=0
 Current effect.
virtual void reset_effect ()=0
 Reset effect.

Static Public Attributes

static const unsigned int EFFECT_NONE = 0
 No effect constant.

Detailed Description

Camera effect control interface.

Some cameras feature camera effects.

This interface shall be implemented by such cameras.

Author:
Tim Niemueller
Tobias Kellner

Definition at line 35 of file effect.h.


Constructor & Destructor Documentation

firevision::CameraControlEffect::~CameraControlEffect (  )  [virtual]

Empty virtual destructor.

Definition at line 68 of file effect.cpp.


Member Function Documentation

unsigned int firevision::CameraControlEffect::effect (  )  [pure virtual]

Current effect.

Returns:
current effect.

Implemented in firevision::SonyEviD100PControl.

void firevision::CameraControlEffect::reset_effect (  )  [pure virtual]

Reset effect.

Disable all effects.

Implemented in firevision::SonyEviD100PControl.

void firevision::CameraControlEffect::set_effect ( unsigned int  effect  )  [pure virtual]

Enable effect.

Parameters:
effect camera-specific effect.

Implemented in firevision::SonyEviD100PControl.

bool firevision::CameraControlEffect::supports_effect ( unsigned int  effect  )  [pure virtual]

Check if camera control supports desired effect.

Use camera-specific constants.

Parameters:
effect supported effect
Returns:
true, if effect is supported, false otherwise

Implemented in firevision::SonyEviD100PControl.


Member Data Documentation

const unsigned int firevision::CameraControlEffect::EFFECT_NONE = 0 [static]

No effect constant.

This is the only effect constant defined in the interface. All others that may exist are specific for each camera control implementation.

Definition at line 38 of file effect.h.

Referenced by firevision::SonyEviD100PControl::set_effect(), firevision::SonyEviD100PControl::SonyEviD100PControl(), and firevision::SonyEviD100PControl::supports_effect().


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