xn::Generator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::Generator:

List of all members.

Public Member Functions
	Generator (XnNodeHandle hNode=NULL)
	Generator (const NodeWrapper &other)
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) const
XnStatus	WaitAndUpdateData ()
XnBool	IsDataNew () const
const void *	GetData ()
XnUInt32	GetDataSize () const
XnUInt64	GetTimestamp () const
XnUInt32	GetFrameID () const
const MirrorCapability	GetMirrorCap () const
MirrorCapability	GetMirrorCap ()
const AlternativeViewPointCapability	GetAlternativeViewPointCap () const
AlternativeViewPointCapability	GetAlternativeViewPointCap ()
const FrameSyncCapability	GetFrameSyncCap () const
FrameSyncCapability	GetFrameSyncCap ()

---

Detailed Description

Base class for all generator nodes

---

Constructor & Destructor Documentation

xn::Generator::Generator

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

xn::Generator::Generator

(

const NodeWrapper &

other

)

[inline]

---

Member Function Documentation

const AlternativeViewPointCapability xn::Generator::GetAlternativeViewPointCap

(

)

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

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

const void* xn::Generator::GetData

(

)

[inline]

Gets the current data.

For full details and usage, see xnGetData

XnUInt32 xn::Generator::GetDataSize

(

)

const [inline]

Gets the size of current data, in bytes.

For full details and usage, see xnGetDataSize

XnUInt32 xn::Generator::GetFrameID

(

)

const [inline]

Gets the frame ID of current data.

For full details and usage, see xnGetFrameID

const FrameSyncCapability xn::Generator::GetFrameSyncCap

(

)

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

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

const MirrorCapability xn::Generator::GetMirrorCap

(

)

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

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 xnGetTimestamp

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

XnBool xn::Generator::IsGenerating

(

)

const [inline]

Checks if this node is currently generating.

For full details and usage, see xnIsGenerating

XnBool xn::Generator::IsNewDataAvailable

(

XnUInt64 *

pnTimestamp = NULL

)

const [inline]

Checks whether this node has new data (and so a call to xnWaitAndUpdateData() will not block).

For full details and usage, see xnIsNewDataAvailable

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

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

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

XnStatus xn::Generator::StopGenerating

(

)

[inline]

Stops generation of the output.

For full details and usage, see xnStopGenerating

void xn::Generator::UnregisterFromGenerationRunningChange

(

XnCallbackHandle

hCallback

)

[inline]

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

For full details and usage, see xnUnregisterFromGenerationRunningChange

void xn::Generator::UnregisterFromNewDataAvailable

(

XnCallbackHandle

hCallback

)

[inline]

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

For full details and usage, see xnUnregisterFromNewDataAvailable

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

---

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

• XnCppWrapper.h