FCam::Flash::FireAction Class Reference

An action to fire the flash during an exposure. More...

Inheritance diagram for FCam::Flash::FireAction:

Collaboration diagram for FCam::Flash::FireAction:

List of all members.

Public Member Functions
	FireAction (Flash *f)
	Construct a FireAction to fire the given flash.
	FireAction (Flash *f, int time)
	Construct a FireAction to fire the given flash, starting at the given time into the exposure (in microseconds).
	FireAction (Flash *f, int time, float brightness, int duration)
	Construct a FireAction to fire the given flash, starting at the given time into the exposure (in microseconds), at the given brightness, for the given duration (in microseconds).
void	doAction ()
	Perform the action.
Flash *	getFlash ()
	Get the flash associated with this fire event.
Public Attributes
float	brightness
	The brightness setting for this flash fire.
int	duration
	The length of time the flash should fire for.

---

Detailed Description

An action to fire the flash during an exposure.

---

Constructor & Destructor Documentation

FCam::Flash::FireAction::FireAction

(

Flash *

f

)

Construct a FireAction to fire the given flash.

FCam::Flash::FireAction::FireAction	(	Flash *	f,
		int	time
	)

Construct a FireAction to fire the given flash, starting at the given time into the exposure (in microseconds).

FCam::Flash::FireAction::FireAction	(	Flash *	f,
		int	time,
		float	brightness,
		int	duration
	)

Construct a FireAction to fire the given flash, starting at the given time into the exposure (in microseconds), at the given brightness, for the given duration (in microseconds).

---

Member Function Documentation

void FCam::Flash::FireAction::doAction

(

)

[virtual]

Perform the action.

Derived classes should override this. This method will be called in the highest priority thread possible to allow for precise timing, so don't perform any long running computations in it unless you really want the entire OS to freeze.

Implements FCam::Action.

Flash* FCam::Flash::FireAction::getFlash

(

)

[inline]

Get the flash associated with this fire event.

---

Member Data Documentation

float FCam::Flash::FireAction::brightness

The brightness setting for this flash fire.

Units are platform specific. Peak lumens are suggested.

int FCam::Flash::FireAction::duration

The length of time the flash should fire for.