OpenNI 1.3.2
Public Member Functions | List of all members
xn::Generator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::Generator:
Inheritance graph

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 ()
- Public Member Functions inherited from xn::ProductionNode
 ProductionNode (XnNodeHandle hNode=NULL)
 ProductionNode (const NodeWrapper &other)
NodeInfo GetInfo () const
XnStatus AddNeededNode (ProductionNode &needed)
XnStatus RemoveNeededNode (ProductionNode &needed)
XnBool IsCapabilitySupported (const XnChar *strCapabilityName) const
XnStatus SetIntProperty (const XnChar *strName, XnUInt64 nValue)
XnStatus SetRealProperty (const XnChar *strName, XnDouble dValue)
XnStatus SetStringProperty (const XnChar *strName, const XnChar *strValue)
XnStatus SetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, const void *pBuffer)
XnStatus GetIntProperty (const XnChar *strName, XnUInt64 &nValue) const
XnStatus GetRealProperty (const XnChar *strName, XnDouble &dValue) const
XnStatus GetStringProperty (const XnChar *strName, XnChar *csValue, XnUInt32 nBufSize) const
XnStatus GetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, void *pBuffer) const
XnStatus LockForChanges (XnLockHandle *phLock)
void UnlockForChanges (XnLockHandle hLock)
XnStatus LockedNodeStartChanges (XnLockHandle hLock)
void LockedNodeEndChanges (XnLockHandle hLock)
const ErrorStateCapability GetErrorStateCap () const
ErrorStateCapability GetErrorStateCap ()
GeneralIntCapability GetGeneralIntCap (const XnChar *strCapability)
void GetContext (Context &context) const
- Public Member Functions inherited from xn::NodeWrapper
 NodeWrapper (XnNodeHandle hNode)
 NodeWrapper (const NodeWrapper &other)
NodeWrapperoperator= (const NodeWrapper &other)
 ~NodeWrapper ()
 operator XnNodeHandle () const
XnNodeHandle GetHandle () const
XnBool operator== (const NodeWrapper &other)
XnBool operator!= (const NodeWrapper &other)
XnBool IsValid () const
const XnChar * GetName () const
XnStatus AddRef ()
void Release ()
XnStatus Ref ()
void Unref ()
void SetHandle (XnNodeHandle hNode)
void TakeOwnership (XnNodeHandle hNode)

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: