Inheritance diagram for xn::GeneralIntCapability:

Public Member Functions
	GeneralIntCapability (XnNodeHandle hNode, const XnChar *strCap)
	GeneralIntCapability (const NodeWrapper &node, const XnChar *strCap)
void	GetRange (XnInt32 &nMin, XnInt32 &nMax, XnInt32 &nStep, XnInt32 &nDefault, XnBool &bIsAutoSupported) const
XnInt32	Get ()
XnStatus	Set (XnInt32 nValue)
XnStatus	RegisterToValueChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void	UnregisterFromValueChange (XnCallbackHandle hCallback)

Detailed Description

Allows access to general integer capabilities functions - see General Int Capability for additional details.

Constructor & Destructor Documentation

xn::GeneralIntCapability::GeneralIntCapability	(	XnNodeHandle	hNode,
		const XnChar *	strCap
	)		`[inline]`

Ctor

Parameters:

[in]	hNode	Node handle
[in]	strCap	Name of the capability

xn::GeneralIntCapability::GeneralIntCapability	(	const NodeWrapper &	node,
		const XnChar *	strCap
	)		`[inline]`

XnInt32 xn::GeneralIntCapability::Get ( ) [inline]

Gets the current value of this capability.

For full details and usage, see xnGetGeneralIntValue

void xn::GeneralIntCapability::GetRange	(	XnInt32 &	nMin,
		XnInt32 &	nMax,
		XnInt32 &	nStep,
		XnInt32 &	nDefault,
		XnBool &	bIsAutoSupported
	)		const `[inline]`

Gets the range of this capability values.

For full details and usage, see xnGetGeneralIntRange

XnStatus xn::GeneralIntCapability::RegisterToValueChange	(	StateChangedHandler	handler,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)		`[inline]`

Registers an event handler for the 'Value Change' event.

Parameters:

[in]	handler	Callback function to be invoked when the event is raised.
[in]	pCookie	User's cookie, to be delivered to the callback.
[out]	hCallback	Handle to the callback to be used for unregistering it.

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

XnStatus xn::GeneralIntCapability::Set ( XnInt32 nValue ) [inline]

Sets the current value of this capability.

For full details and usage, see xnSetGeneralIntValue

void xn::GeneralIntCapability::UnregisterFromValueChange ( XnCallbackHandle hCallback ) [inline]

Unregisters the event handler for the 'Value Change' event.

Parameters:

[in] hCallback Handle 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: