OpenNI 1.5.4: xn::AntiFlickerCapability Class Reference

OpenNI

xn::AntiFlickerCapability Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::AntiFlickerCapability:

List of all members.

Public Member Functions

 AntiFlickerCapability (XnNodeHandle hNode)
 AntiFlickerCapability (const NodeWrapper &node)
XnStatus SetPowerLineFrequency (XnPowerLineFrequency nFrequency)
XnPowerLineFrequency GetPowerLineFrequency ()
XnStatus RegisterToPowerLineFrequencyChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromPowerLineFrequencyChange (XnCallbackHandle hCallback)

Detailed Description

Allows access to Anti Flicker capability functions. see Anti Flicker Capability for additional details.

Usage: Do not instantiate directly. Instead, use MapGenerator::GetAntiFlickerCap() to obtain an instance.


Constructor & Destructor Documentation

xn::AntiFlickerCapability::AntiFlickerCapability ( XnNodeHandle  hNode) [inline]

Ctor

Parameters:
[in]hNodeNode handle
xn::AntiFlickerCapability::AntiFlickerCapability ( const NodeWrapper node) [inline]

Member Function Documentation

XnPowerLineFrequency xn::AntiFlickerCapability::GetPowerLineFrequency ( ) [inline]

Gets the power line frequency.

For full details and usage, see xnGetPowerLineFrequency
XnStatus xn::AntiFlickerCapability::RegisterToPowerLineFrequencyChange ( StateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]

Registers an event handler for the 'Power Line Frequency Change' event.

Parameters:
[in]handlerCallback function to be invoked when the event is raised.
[in]pCookieUser's cookie, to be delivered to the callback.
[out]hCallbackHandle to the callback to be used for unregistering it.

For full details and usage of the parameters, see Registering to Events.

XnStatus xn::AntiFlickerCapability::SetPowerLineFrequency ( XnPowerLineFrequency  nFrequency) [inline]

Sets the power line frequency: 50 Hz, 60 Hz, or 0 to turn off anti-flicker.

For full details and usage, see xnSetPowerLineFrequency
void xn::AntiFlickerCapability::UnregisterFromPowerLineFrequencyChange ( XnCallbackHandle  hCallback) [inline]

Unregisters the event handler for the 'Power Line Frequency Change' event.

Parameters:
[in]hCallbackHandle received from registration.

For full details and usage of the parameter, see Unregistering from Events .


The documentation for this class was generated from the following file:
Generated on Wed May 16 2012 10:16:07 for OpenNI 1.5.4 by   doxygen 1.7.5.1