FCam::F2::ShutterButton Class Reference
A simple shutter button class that generates an FCam::Event each time the Phidget based shutter button is pressed or released. More...
#include <ShutterButton.h>
Inheritance diagram for FCam::F2::ShutterButton:
Collaboration diagram for FCam::F2::ShutterButton:
Public Member Functions | |
| virtual std::string | getEventString (const Event &) const |
| Returns a string describing the meaning of a given event generated by this object. | |
| ShutterButton (int halfPress=1, int fullPress=0) | |
| Creates a new shutter button PhidgetDevice and registers the Phidget input indices corresponding to half and full presses. | |
Protected Member Functions | |
| int | halfPressHandler (CPhidgetInterfaceKitHandle interfaceKit, int index, int state) |
| The handler function for half presses. This simply generates and enqueues a FocusPressed or FocusReleased type Event. | |
| int | fullPressHandler (CPhidgetInterfaceKitHandle interfaceKit, int index, int state) |
| The handler function for half presses. This simply generates and enqueues a ShutterPressed or ShutterReleased type Event. | |
| virtual int | handleInputChange (CPhidgetInterfaceKitHandle interfaceKit, int index, int state) |
| An overridden implementation of the basic PhidgetDevice input change handler. | |
Detailed Description
A simple shutter button class that generates an FCam::Event each time the Phidget based shutter button is pressed or released.
Definition at line 11 of file ShutterButton.h.
Constructor & Destructor Documentation
| FCam::F2::ShutterButton::ShutterButton | ( | int | halfPress = 1, |
|
| int | fullPress = 0 | |||
| ) |
Creates a new shutter button PhidgetDevice and registers the Phidget input indices corresponding to half and full presses.
Definition at line 8 of file ShutterButton.cpp.
Member Function Documentation
| int FCam::F2::ShutterButton::handleInputChange | ( | CPhidgetInterfaceKitHandle | interfaceKit, | |
| int | index, | |||
| int | state | |||
| ) | [protected, virtual] |
An overridden implementation of the basic PhidgetDevice input change handler.
It simply hands off the event to the appropriate half or full press handler depending on the index of the PhidgetEvent.
Reimplemented from FCam::F2::PhidgetDevice.
Definition at line 15 of file ShutterButton.cpp.
The documentation for this class was generated from the following files:
