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

#include <XnCppWrapper.h>

Inheritance diagram for xn::GeneralIntCapability:
Inheritance graph

Public Member Functions

 GeneralIntCapability (XnNodeHandle hNode, const XnChar *strCap)
 
 GeneralIntCapability (const NodeWrapper &node)
 
void GetRange (XnInt32 &nMin, XnInt32 &nMax, XnInt32 &nStep, XnInt32 &nDefault, XnBool &bIsAutoSupported) const
 
XnInt32 Get ()
 
XnStatus Set (XnInt32 nValue)
 
XnStatus RegisterToValueChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
 
void UnregisterFromValueChange (XnCallbackHandle hCallback)
 
- Public Member Functions inherited from xn::Capability
 Capability (XnNodeHandle hNode)
 
 Capability (const NodeWrapper &node)
 
- 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

Allows access to general integer capabilities functions. see General Int Capability for additional details.

Constructor & Destructor Documentation

xn::GeneralIntCapability::GeneralIntCapability ( XnNodeHandle  hNode,
const XnChar *  strCap 
)
inline

Ctor

Parameters
hNode[in] Node handle
strCap[in] Name of the capability
xn::GeneralIntCapability::GeneralIntCapability ( const NodeWrapper node)
inline

Member Function Documentation

XnInt32 xn::GeneralIntCapability::Get ( )
inline

Gets the current value of this capability.

For full details and usage, see xnGetGeneralIntValue

void xn::GeneralIntCapability::GetRange ( XnInt32 &  nMin,
XnInt32 &  nMax,
XnInt32 &  nStep,
XnInt32 &  nDefault,
XnBool &  bIsAutoSupported 
) const
inline

Gets the range of this capability values.

For full details and usage, see xnGetGeneralIntRange

XnStatus xn::GeneralIntCapability::RegisterToValueChange ( StateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle hCallback 
)
inline

Registers a callback function to values changes.

For full details and usage, see xnRegisterToGeneralIntValueChange

XnStatus xn::GeneralIntCapability::Set ( XnInt32  nValue)
inline

Sets the current value of this capability.

For full details and usage, see xnSetGeneralIntValue

void xn::GeneralIntCapability::UnregisterFromValueChange ( XnCallbackHandle  hCallback)
inline

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

For full details and usage, see xnUnregisterFromGeneralIntValueChange


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