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

#include <XnCppWrapper.h>

Inheritance diagram for xn::MapGenerator:
Inheritance graph

Public Member Functions

 MapGenerator (XnNodeHandle hNode=NULL)
 
 MapGenerator (const NodeWrapper &other)
 
XnUInt32 GetSupportedMapOutputModesCount () const
 
XnStatus GetSupportedMapOutputModes (XnMapOutputMode *aModes, XnUInt32 &nCount) const
 
XnStatus SetMapOutputMode (const XnMapOutputMode &OutputMode)
 
XnStatus GetMapOutputMode (XnMapOutputMode &OutputMode) const
 
XnUInt32 GetBytesPerPixel () const
 
XnStatus RegisterToMapOutputModeChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
 
void UnregisterFromMapOutputModeChange (XnCallbackHandle hCallback)
 
const CroppingCapability GetCroppingCap () const
 
CroppingCapability GetCroppingCap ()
 
GeneralIntCapability GetBrightnessCap ()
 
GeneralIntCapability GetContrastCap ()
 
GeneralIntCapability GetHueCap ()
 
GeneralIntCapability GetSaturationCap ()
 
GeneralIntCapability GetSharpnessCap ()
 
GeneralIntCapability GetGammaCap ()
 
GeneralIntCapability GetWhiteBalanceCap ()
 
GeneralIntCapability GetBacklightCompensationCap ()
 
GeneralIntCapability GetGainCap ()
 
GeneralIntCapability GetPanCap ()
 
GeneralIntCapability GetTiltCap ()
 
GeneralIntCapability GetRollCap ()
 
GeneralIntCapability GetZoomCap ()
 
GeneralIntCapability GetExposureCap ()
 
GeneralIntCapability GetIrisCap ()
 
GeneralIntCapability GetFocusCap ()
 
GeneralIntCapability GetLowLightCompensationCap ()
 
AntiFlickerCapability GetAntiFlickerCap ()
 
- Public Member Functions inherited from xn::Generator
 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 Map Generators

Constructor & Destructor Documentation

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

Ctor

Parameters
hNode[in] Node handle
xn::MapGenerator::MapGenerator ( const NodeWrapper other)
inline

Member Function Documentation

AntiFlickerCapability xn::MapGenerator::GetAntiFlickerCap ( )
inline

Gets an AntiFlickerCapability object for accessing Anti Flicker functionality. It is the application responsibility to check first if XN_CAPABILITY_ANTI_FLICKER is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetBacklightCompensationCap ( )
inline

Gets an GeneralIntCapability object for accessing BacklightCompensation functionality. It is the application responsibility to check first if XN_CAPABILITY_BACKLIGHT_COMPENSATION is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetBrightnessCap ( )
inline

Gets an GeneralIntCapability object for accessing Brightness functionality. It is the application responsibility to check first if XN_CAPABILITY_BRIGHTNESS is supported by calling IsCapabilitySupported().

XnUInt32 xn::MapGenerator::GetBytesPerPixel ( ) const
inline

Gets the number of bytes per pixel for this map generator.

For full details and usage, see xnGetBytesPerPixel

GeneralIntCapability xn::MapGenerator::GetContrastCap ( )
inline

Gets an GeneralIntCapability object for accessing Contrast functionality. It is the application responsibility to check first if XN_CAPABILITY_CONTRAST is supported by calling IsCapabilitySupported().

const CroppingCapability xn::MapGenerator::GetCroppingCap ( ) const
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().

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

GeneralIntCapability xn::MapGenerator::GetExposureCap ( )
inline

Gets an GeneralIntCapability object for accessing Exposure functionality. It is the application responsibility to check first if XN_CAPABILITY_EXPOSURE is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetFocusCap ( )
inline

Gets an GeneralIntCapability object for accessing Focus functionality. It is the application responsibility to check first if XN_CAPABILITY_FOCUS is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetGainCap ( )
inline

Gets an GeneralIntCapability object for accessing Gain functionality. It is the application responsibility to check first if XN_CAPABILITY_GAIN is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetGammaCap ( )
inline

Gets an GeneralIntCapability object for accessing Gamma functionality. It is the application responsibility to check first if XN_CAPABILITY_GAMMA is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetHueCap ( )
inline

Gets an GeneralIntCapability object for accessing Hue functionality. It is the application responsibility to check first if XN_CAPABILITY_HUE is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetIrisCap ( )
inline

Gets an GeneralIntCapability object for accessing Iris functionality. It is the application responsibility to check first if XN_CAPABILITY_IRIS is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetLowLightCompensationCap ( )
inline

Gets an GeneralIntCapability object for accessing Low Light Compensation functionality. It is the application responsibility to check first if XN_CAPABILITY_LOW_LIGHT_COMPENSATION 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

GeneralIntCapability xn::MapGenerator::GetPanCap ( )
inline

Gets an GeneralIntCapability object for accessing Pan functionality. It is the application responsibility to check first if XN_CAPABILITY_PAN is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetRollCap ( )
inline

Gets an GeneralIntCapability object for accessing Roll functionality. It is the application responsibility to check first if XN_CAPABILITY_ROLL is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetSaturationCap ( )
inline

Gets an GeneralIntCapability object for accessing Saturation functionality. It is the application responsibility to check first if XN_CAPABILITY_SATURATION is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetSharpnessCap ( )
inline

Gets an GeneralIntCapability object for accessing Sharpness functionality. It is the application responsibility to check first if XN_CAPABILITY_SHARPNESS is supported by calling IsCapabilitySupported().

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

GeneralIntCapability xn::MapGenerator::GetTiltCap ( )
inline

Gets an GeneralIntCapability object for accessing Tilt functionality. It is the application responsibility to check first if XN_CAPABILITY_TILT is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetWhiteBalanceCap ( )
inline

Gets an GeneralIntCapability object for accessing WhiteBalance functionality. It is the application responsibility to check first if XN_CAPABILITY_COLOR_TEMPERATURE is supported by calling IsCapabilitySupported().

GeneralIntCapability xn::MapGenerator::GetZoomCap ( )
inline

Gets an GeneralIntCapability object for accessing Zoom functionality. It is the application responsibility to check first if XN_CAPABILITY_ZOOM is supported by calling IsCapabilitySupported().

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: