OpenNI 1.0.0

xn::MapGenerator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::MapGenerator:

List of all members.

Public Member Functions

 MapGenerator (XnNodeHandle hNode=NULL)
XnUInt32 GetSupportedMapOutputModesCount () const
XnStatus GetSupportedMapOutputModes (XnMapOutputMode *aModes, XnUInt32 &nCount) const
XnStatus SetMapOutputMode (const XnMapOutputMode &OutputMode)
XnStatus GetMapOutputMode (XnMapOutputMode &OutputMode) const
XnStatus RegisterToMapOutputModeChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromMapOutputModeChange (XnCallbackHandle hCallback)
CroppingCapability GetCroppingCap ()

Detailed Description

Base class for Map Generators


Constructor & Destructor Documentation

xn::MapGenerator::MapGenerator ( XnNodeHandle  hNode = NULL) [inline]

Ctor

Parameters:
hNode[in] Node handle

Member Function Documentation

CroppingCapability xn::MapGenerator::GetCroppingCap ( ) [inline]

Gets an CroppingCapability object for accessing Cropping functionality. It is the application responsibility to check first if XN_CAPABILITY_CROPPING is supported by calling IsCapabilitySupported().

XnStatus xn::MapGenerator::GetMapOutputMode ( XnMapOutputMode OutputMode) const [inline]

Gets the current output mode.

For full details and usage, see xnGetMapOutputMode

XnStatus xn::MapGenerator::GetSupportedMapOutputModes ( XnMapOutputMode aModes,
XnUInt32 &  nCount 
) const [inline]

Gets a list of all supported modes. The size of the array that should be passed can be obtained by calling xnGetSupportedMapOutputModesCount().

For full details and usage, see xnGetSupportedMapOutputModes

XnUInt32 xn::MapGenerator::GetSupportedMapOutputModesCount ( ) const [inline]

Gets the number of supported modes. This is useful for allocating an array that will be passed to xnGetSupportedMapOutputModes().

For full details and usage, see xnGetSupportedMapOutputModesCount

XnStatus xn::MapGenerator::RegisterToMapOutputModeChange ( StateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
) [inline]

Registers a callback function to mode changes.

For full details and usage, see xnRegisterToMapOutputModeChange

XnStatus xn::MapGenerator::SetMapOutputMode ( const XnMapOutputMode OutputMode) [inline]

Sets the output mode.

For full details and usage, see xnSetMapOutputMode

void xn::MapGenerator::UnregisterFromMapOutputModeChange ( XnCallbackHandle  hCallback) [inline]

Unregisters a callback function which was registered using xnRegisterToMapOutputModeChange.

For full details and usage, see xnUnregisterFromMapOutputModeChange


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