xn::Generator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::Generator:

List of all members.

Public Member Functions
	Generator (XnNodeHandle hNode=NULL)
AlternativeViewPointCapability	GetAlternativeViewPointCap ()
XnUInt32	GetDataSize () const
XnUInt32	GetFrameID () const
FrameSyncCapability	GetFrameSyncCap ()
MirrorCapability	GetMirrorCap ()
XnUInt64	GetTimestamp () const
XnBool	IsDataNew () const
XnBool	IsGenerating () const
XnBool	IsNewDataAvailable (XnUInt64 *pnTimestamp=NULL)
XnStatus	RegisterToGenerationRunningChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	RegisterToNewDataAvailable (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	StartGenerating ()
XnStatus	StopGenerating ()
void	UnregisterFromGenerationRunningChange (XnCallbackHandle hCallback)
void	UnregisterFromNewDataAvailable (XnCallbackHandle hCallback)
XnStatus	WaitAndUpdateData ()

---

Detailed Description

Base class for all generator nodes

Definition at line 1893 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::Generator::Generator

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

Definition at line 1901 of file XnCppWrapper.h.

---

Member Function Documentation

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

Definition at line 2022 of file XnCppWrapper.h.

XnUInt32 xn::Generator::GetDataSize

(

)

const [inline]

Gets the size of current data, in bytes.

For full details and usage, see xnGetDataSize

Definition at line 1986 of file XnCppWrapper.h.

XnUInt32 xn::Generator::GetFrameID

(

)

const [inline]

Gets the frame ID of current data.

For full details and usage, see xnGetFrameID

Definition at line 2002 of file XnCppWrapper.h.

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

Definition at line 2032 of file XnCppWrapper.h.

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

Definition at line 2012 of file XnCppWrapper.h.

XnUInt64 xn::Generator::GetTimestamp

(

)

const [inline]

Gets the timestamp of current data, in microseconds.

For full details and usage, see xnGetTimestamp

Definition at line 1994 of file XnCppWrapper.h.

XnBool 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 xnIsDataNew

Definition at line 1978 of file XnCppWrapper.h.

XnBool xn::Generator::IsGenerating

(

)

const [inline]

Checks if this node is currently generating.

For full details and usage, see xnIsGenerating

Definition at line 1914 of file XnCppWrapper.h.

XnBool 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 xnIsNewDataAvailable

Definition at line 1962 of file XnCppWrapper.h.

XnStatus 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 xnRegisterToGenerationRunningChange

Definition at line 1930 of file XnCppWrapper.h.

XnStatus 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 xnRegisterToNewDataAvailable

Definition at line 1946 of file XnCppWrapper.h.

XnStatus xn::Generator::StartGenerating

(

)

[inline]

Starts generation of the output. This will also cause all dependencies to start generating.

For full details and usage, see xnStartGenerating

Definition at line 1906 of file XnCppWrapper.h.

XnStatus xn::Generator::StopGenerating

(

)

[inline]

Stops generation of the output.

For full details and usage, see xnStopGenerating

Definition at line 1922 of file XnCppWrapper.h.

void xn::Generator::UnregisterFromGenerationRunningChange

(

XnCallbackHandle

hCallback

)

[inline]

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

For full details and usage, see xnUnregisterFromGenerationRunningChange

Definition at line 1938 of file XnCppWrapper.h.

void xn::Generator::UnregisterFromNewDataAvailable

(

XnCallbackHandle

hCallback

)

[inline]

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

For full details and usage, see xnUnregisterFromNewDataAvailable

Definition at line 1954 of file XnCppWrapper.h.

XnStatus 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

Definition at line 1970 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h