User Position Capability

Collaboration diagram for User Position Capability:

Functions
XN_C_API XnUInt32	xnGetSupportedUserPositionsCount (XnNodeHandle hInstance)
	Gets the number of user positions supported by this generator.
XN_C_API XnStatus	xnGetUserPosition (XnNodeHandle hInstance, XnUInt32 nIndex, XnBoundingBox3D *pPosition)
	Gets the current user position.
XN_C_API XnStatus	xnRegisterToUserPositionChange (XnNodeHandle hInstance, XnStateChangedHandler handler, void *pCookie, XnCallbackHandle *phCallback)
	Registers a callback function to user position changes.
XN_C_API XnStatus	xnSetUserPosition (XnNodeHandle hInstance, XnUInt32 nIndex, const XnBoundingBox3D *pPosition)
	Sets the current user position.
XN_C_API void	xnUnregisterFromUserPositionChange (XnNodeHandle hInstance, XnCallbackHandle hCallback)
	Unregisters a callback function which was registered using xnRegisterToUserPositionChange.

---

Detailed Description

The User Position capability (XN_CAPABILITY_USER_POSITION) allows a Depth Generator to change its output, so that it would be optimized in specific locations in the scene.

---

Function Documentation

XN_C_API XnUInt32 xnGetSupportedUserPositionsCount

(

XnNodeHandle

hInstance

)

Gets the number of user positions supported by this generator.

Parameters:

hInstance

[in] A handle to the instance.

Returns:

0 if this production node does not support the User Position capability.

XN_C_API XnStatus xnGetUserPosition	(	XnNodeHandle	hInstance,
		XnUInt32	nIndex,
		XnBoundingBox3D *	pPosition
	)

Gets the current user position.

Parameters:

hInstance	[in] A handle to the instance.
nIndex	[in] The user position to get.
pPosition	[out] The user position.

Returns:

XN_STATUS_INVALID_OPERATION if this production node does not support the User Position capability.

XN_C_API XnStatus xnRegisterToUserPositionChange	(	XnNodeHandle	hInstance,
		XnStateChangedHandler	handler,
		void *	pCookie,
		XnCallbackHandle *	phCallback
	)

Registers a callback function to user position changes.

Parameters:

hInstance	[in] A handle to the instance.
handler	[in] A pointer to a function that will be called when user position changes.
pCookie	[in] A user cookie that will be passed to the callback function.
phCallback	[out] Optional. Will be filled with a handle to be passed to xnUnregisterFromUserPositionChange.

Returns:

XN_STATUS_INVALID_OPERATION if this production node does not support the User Position capability.

XN_C_API XnStatus xnSetUserPosition	(	XnNodeHandle	hInstance,
		XnUInt32	nIndex,
		const XnBoundingBox3D *	pPosition
	)

Sets the current user position.

Parameters:

hInstance	[in] A handle to the instance.
nIndex	[in] The user position to set.
pPosition	[in] The user position in the frame.

Returns:

XN_STATUS_INVALID_OPERATION if this production node does not support the User Position capability.

XN_C_API void xnUnregisterFromUserPositionChange	(	XnNodeHandle	hInstance,
		XnCallbackHandle	hCallback
	)

Unregisters a callback function which was registered using xnRegisterToUserPositionChange.

Parameters:

hInstance	[in] A handle to the instance.
hCallback	[in] The handle to the callback returned from xnRegisterToUserPositionChange.