OpenNI 1.5.7
Public Attributes | List of all members
XnModuleGeneratorInterface Struct Reference

#include <XnModuleInterface.h>

Public Attributes

XnModuleProductionNodeInterfacepProductionNodeInterface
 
XnModuleNodeHandle hGenerator
 
XnModuleNodeHandle
XnModuleStateChangedHandler 
handler
 
XnModuleNodeHandle
XnModuleStateChangedHandler
void * 
pCookie
 
XnModuleNodeHandle
XnModuleStateChangedHandler
void XnCallbackHandle
phCallback
 
XnModuleNodeHandle XnCallbackHandle hCallback
 
XnModuleNodeHandle XnUInt64 * pnTimestamp
 
XnUInt32(* GetDataSize )(XnModuleNodeHandle hGenerator)
 
XnUInt64(* GetTimestamp )(XnModuleNodeHandle hGenerator)
 
XnUInt32(* GetFrameID )(XnModuleNodeHandle hGenerator)
 
XnModuleMirrorInterfacepMirrorInterface
 
XnModuleAlternativeViewPointInterfacepAlternativeViewPointInterface
 
void * pObsolete1
 
XnModuleFrameSyncInterfacepFrameSyncInterface
 
const void *(* GetData )(XnModuleNodeHandle hGenerator)
 

Detailed Description

The interface of a generator.

Member Data Documentation

const void*(* XnModuleGeneratorInterface::GetData)(XnModuleNodeHandle hGenerator)

Gets pointer to current data.

Parameters
hGenerator[in] A handle to the instance.
XnUInt32(* XnModuleGeneratorInterface::GetDataSize)(XnModuleNodeHandle hGenerator)

Gets the size of current data, in bytes.

Parameters
hGenerator[in] A handle to the instance.
XnUInt32(* XnModuleGeneratorInterface::GetFrameID)(XnModuleNodeHandle hGenerator)

Gets the frame ID of current data.

Parameters
hGenerator[in] A handle to the instance.
XnUInt64(* XnModuleGeneratorInterface::GetTimestamp)(XnModuleNodeHandle hGenerator)

Gets the timestamp of current data, in microseconds.

Parameters
hGenerator[in] A handle to the instance.
XnModuleNodeHandle XnModuleStateChangedHandler XnModuleGeneratorInterface::handler
XnModuleNodeHandle XnCallbackHandle XnModuleGeneratorInterface::hCallback
XnModuleNodeHandle XnModuleGeneratorInterface::hGenerator

Starts generation of the output.

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

Checks if the generator is currently generating.

Parameters
hGenerator[in] A handle to the instance.

Stops generation of the output.

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

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().

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().

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().

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().

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.

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.
XnModuleAlternativeViewPointInterface* XnModuleGeneratorInterface::pAlternativeViewPointInterface
XnModuleNodeHandle XnModuleStateChangedHandler void * XnModuleGeneratorInterface::pCookie
XnModuleFrameSyncInterface* XnModuleGeneratorInterface::pFrameSyncInterface
XnModuleNodeHandle XnModuleStateChangedHandler void XnCallbackHandle * XnModuleGeneratorInterface::phCallback
XnModuleMirrorInterface* XnModuleGeneratorInterface::pMirrorInterface
XnModuleNodeHandle XnUInt64* XnModuleGeneratorInterface::pnTimestamp
void* XnModuleGeneratorInterface::pObsolete1
XnModuleProductionNodeInterface* XnModuleGeneratorInterface::pProductionNodeInterface

Contains production node interface.


The documentation for this struct was generated from the following file: