#include <XnModuleInterface.h>

Public Member Functions
	void (XN_CALLBACK_TYPE *StopGenerating)(XnModuleNodeHandle hGenerator)
	void (XN_CALLBACK_TYPE *UnregisterFromGenerationRunningChange)(XnModuleNodeHandle hGenerator
	void (XN_CALLBACK_TYPE *UnregisterFromNewDataAvailable)(XnModuleNodeHandle hGenerator
	XnBool (XN_CALLBACK_TYPE *IsGenerating)(XnModuleNodeHandle hGenerator)
	XnBool (XN_CALLBACK_TYPE *IsNewDataAvailable)(XnModuleNodeHandle hGenerator
	XnStatus (XN_CALLBACK_TYPE *StartGenerating)(XnModuleNodeHandle hGenerator)
	XnStatus (XN_CALLBACK_TYPE *RegisterToGenerationRunningChange)(XnModuleNodeHandle hGenerator
	XnStatus (XN_CALLBACK_TYPE *RegisterToNewDataAvailable)(XnModuleNodeHandle hGenerator
	XnStatus (XN_CALLBACK_TYPE *UpdateData)(XnModuleNodeHandle hGenerator)
	XnUInt32 (XN_CALLBACK_TYPE *GetDataSize)(XnModuleNodeHandle hGenerator)
	XnUInt32 (XN_CALLBACK_TYPE *GetFrameID)(XnModuleNodeHandle hGenerator)
	XnUInt64 (XN_CALLBACK_TYPE *GetTimestamp)(XnModuleNodeHandle hGenerator)
Public Attributes
XnModuleStateChangedHandler	handler
XnCallbackHandle	hCallback
XnModuleAlternativeViewPointInterface *	pAlternativeViewPointInterface
XnModuleStateChangedHandler void *	pCookie
XnModuleFrameSyncInterface *	pFrameSyncInterface
XnModuleStateChangedHandler void XnCallbackHandle *	phCallback
XnModuleMirrorInterface *	pMirrorInterface
XnUInt64 *	pnTimestamp
XnModuleProductionNodeInterface *	pProductionNodeInterface
XnModuleSeekingInterface *	pSeekingInterface

Detailed Description

The interface of a generator.

Definition at line 458 of file XnModuleInterface.h.

Member Function Documentation

XnModuleGeneratorInterface::void ( XN_CALLBACK_TYPE * StopGenerating )

Stops generation of the output.

Parameters:

hGenerator [in] A handle to the instance to stop generating.

XnModuleGeneratorInterface::void ( XN_CALLBACK_TYPE * UnregisterFromGenerationRunningChange )

Unregisters a callback function which was registered using RegisterToGenerationRunningChange().

Parameters:

hGenerator	[in] A handle to the instance.
hCallback	[in] The handle to the callback returned from RegisterToGenerationRunningChange().

XnModuleGeneratorInterface::void ( XN_CALLBACK_TYPE * UnregisterFromNewDataAvailable )

Unregisters a callback function which was registered using RegisterToNewDataAvailable().

Parameters:

hGenerator	[in] A handle to the instance.
hCallback	[in] The handle to the callback returned from RegisterToNewDataAvailable().

XnModuleGeneratorInterface::XnBool ( XN_CALLBACK_TYPE * IsGenerating )

Checks if the generator is currently generating.

Parameters:

hGenerator [in] A handle to the instance.

XnModuleGeneratorInterface::XnBool ( XN_CALLBACK_TYPE * IsNewDataAvailable )

Checks whether this node has new data (and so a call to xn::Generator::WaitAndUpdateData() will not block).

Parameters:

hGenerator	[in] A handle to the instance to be updated.
pnTimestamp	[out] If new data is available, the timestamp of that data.

XnModuleGeneratorInterface::XnStatus ( XN_CALLBACK_TYPE * StartGenerating )

Starts generation of the output.

Parameters:

hGenerator [in] A handle to the instance to start generating.

XnModuleGeneratorInterface::XnStatus ( XN_CALLBACK_TYPE * RegisterToGenerationRunningChange )

Registers a callback function to be called when generation starts or stops.

Parameters:

hGenerator	[in] A handle to the instance.
handler	[in] A pointer to a function that will be called when generation starts/stops.
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 UnregisterFromGenerationRunningChange().

XnModuleGeneratorInterface::XnStatus ( XN_CALLBACK_TYPE * RegisterToNewDataAvailable )

Registers a callback function to be called when new data is available.

Parameters:

handler	[in] A pointer to a function that will be called when new data is available.
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 UnregisterFromNewDataAvailable().

XnModuleGeneratorInterface::XnStatus ( XN_CALLBACK_TYPE * UpdateData )

Updates the data to the latest available one. This function will only be called AFTER the node notified OpenNI it has new data available.

Parameters:

hGenerator [in] A handle to the instance to be updated.

XnModuleGeneratorInterface::XnUInt32 ( XN_CALLBACK_TYPE * GetDataSize )

Gets the size of current data, in bytes.

Parameters:

hGenerator [in] A handle to the instance.

XnModuleGeneratorInterface::XnUInt32 ( XN_CALLBACK_TYPE * GetFrameID )

Gets the frame ID of current data.

Parameters:

hGenerator [in] A handle to the instance.