#include <XnCppWrapper.h>
Public Member Functions | |
Generator (XnNodeHandle hNode=NULL) | |
XnStatus | StartGenerating () |
XnBool | IsGenerating () const |
XnStatus | StopGenerating () |
XnStatus | RegisterToGenerationRunningChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback) |
void | UnregisterFromGenerationRunningChange (XnCallbackHandle hCallback) |
XnStatus | RegisterToNewDataAvailable (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback) |
void | UnregisterFromNewDataAvailable (XnCallbackHandle hCallback) |
XnBool | IsNewDataAvailable (XnUInt64 *pnTimestamp=NULL) |
XnStatus | WaitAndUpdateData () |
XnBool | IsDataNew () const |
XnUInt32 | GetDataSize () const |
XnUInt64 | GetTimestamp () const |
XnUInt32 | GetFrameID () const |
MirrorCapability | GetMirrorCap () |
AlternativeViewPointCapability | GetAlternativeViewPointCap () |
FrameSyncCapability | GetFrameSyncCap () |
Base class for all generator nodes
xn::Generator::Generator | ( | XnNodeHandle | hNode = NULL |
) | [inline] |
Ctor
hNode | [in] Node handle |
AlternativeViewPointCapability xn::Generator::GetAlternativeViewPointCap | ( | ) | [inline] |
Gets an AlternativeViewPointCapability object for accessing Alternative View Point functionality. It is the application responsibility to check first if XN_CAPABILITY_ALTERNATIVE_VIEW_POINT is supported by calling IsCapabilitySupported().
XnUInt32 xn::Generator::GetDataSize | ( | ) | const [inline] |
Gets the size of current data, in bytes.
For full details and usage, see xnGetDataSizeXnUInt32 xn::Generator::GetFrameID | ( | ) | const [inline] |
Gets the frame ID of current data.
For full details and usage, see xnGetFrameIDFrameSyncCapability xn::Generator::GetFrameSyncCap | ( | ) | [inline] |
Gets an FrameSyncCapability object for accessing Frame Sync functionality. It is the application responsibility to check first if XN_CAPABILITY_FRAME_SYNC is supported by calling IsCapabilitySupported().
MirrorCapability xn::Generator::GetMirrorCap | ( | ) | [inline] |
Gets an MirrorCapability object for accessing Mirror functionality. It is the application responsibility to check first if XN_CAPABILITY_MIRROR is supported by calling IsCapabilitySupported().
XnUInt64 xn::Generator::GetTimestamp | ( | ) | const [inline] |
Gets the timestamp of current data, in microseconds.
For full details and usage, see xnGetTimestampXnBool xn::Generator::IsDataNew | ( | ) | const [inline] |
Checks whether current data is new. Meaning, did the data change on the last call to xnWaitAndUpdateAll(), xnWaitOneUpdateAll() or xnWaitAndUpdateData().
For full details and usage, see xnIsDataNewXnBool xn::Generator::IsGenerating | ( | ) | const [inline] |
Checks if this node is currently generating.
For full details and usage, see xnIsGeneratingXnBool xn::Generator::IsNewDataAvailable | ( | XnUInt64 * | pnTimestamp = NULL |
) | [inline] |
Checks whether this node has new data (and so a call to xnWaitAndUpdateData() will not block).
For full details and usage, see xnIsNewDataAvailableXnStatus xn::Generator::RegisterToGenerationRunningChange | ( | StateChangedHandler | handler, | |
void * | pCookie, | |||
XnCallbackHandle & | hCallback | |||
) | [inline] |
Registers a callback function to be called when generation starts or stops.
For full details and usage, see xnRegisterToGenerationRunningChangeXnStatus xn::Generator::RegisterToNewDataAvailable | ( | StateChangedHandler | handler, | |
void * | pCookie, | |||
XnCallbackHandle & | hCallback | |||
) | [inline] |
Registers a callback function to be called when new data is available.
For full details and usage, see xnRegisterToNewDataAvailableXnStatus xn::Generator::StartGenerating | ( | ) | [inline] |
Starts generation of the output. This will also cause all dependencies to start generating.
For full details and usage, see xnStartGeneratingXnStatus xn::Generator::StopGenerating | ( | ) | [inline] |
Stops generation of the output.
For full details and usage, see xnStopGeneratingvoid xn::Generator::UnregisterFromGenerationRunningChange | ( | XnCallbackHandle | hCallback | ) | [inline] |
Unregisters a callback function which was registered using xnRegisterToGenerationRunningChange().
For full details and usage, see xnUnregisterFromGenerationRunningChangevoid xn::Generator::UnregisterFromNewDataAvailable | ( | XnCallbackHandle | hCallback | ) | [inline] |
Unregisters a callback function which was registered using xnRegisterToNewDataAvailable().
For full details and usage, see xnUnregisterFromNewDataAvailableXnStatus xn::Generator::WaitAndUpdateData | ( | ) | [inline] |
Updates the data to the latest available one. If needed, the call will block until new data is available.
For full details and usage, see xnWaitAndUpdateData