xn::IRMetaData Class Reference
[C++ Reference]

#include <XnCppWrapper.h>

Inheritance diagram for xn::IRMetaData:
[legend]

List of all members.

Public Member Functions

 IRMetaData ()
void InitFrom (const IRMetaData &other)
XnStatus InitFrom (const IRMetaData &other, XnUInt32 nXRes, XnUInt32 nYRes, const XnIRPixel *pExternalBuffer)
XnStatus CopyFrom (const IRMetaData &other)
XnStatus ReAdjust (XnUInt32 nXRes, XnUInt32 nYRes, const XnIRPixel *pExternalBuffer=NULL)
const XnIRPixelData () const
const XnIRPixel *& Data ()
XnIRPixelWritableData ()
const xn::IRMap & IRMap () const
xn::IRMap & WritableIRMap ()
const XnIRMetaDataGetUnderlying () const
XnIRMetaDataGetUnderlying ()

Detailed Description

Represents a MetaData object for generators producing infra-red-maps.


Constructor & Destructor Documentation

xn::IRMetaData::IRMetaData (  )  [inline]

Ctor.


Member Function Documentation

XnStatus xn::IRMetaData::CopyFrom ( const IRMetaData other  )  [inline]

Performs a deep-copy of another Meta Data object (including a duplication of the data buffer)

Parameters:
other [in] source object

const XnIRPixel*& xn::IRMetaData::Data (  )  [inline]

Gets a pointer to the data.

Reimplemented from xn::OutputMetaData.

const XnIRPixel* xn::IRMetaData::Data (  )  const [inline]

Gets a pointer to the data.

Reimplemented from xn::OutputMetaData.

XnIRMetaData* xn::IRMetaData::GetUnderlying (  )  [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::MapMetaData.

const XnIRMetaData* xn::IRMetaData::GetUnderlying (  )  const [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::MapMetaData.

XnStatus xn::IRMetaData::InitFrom ( const IRMetaData other,
XnUInt32  nXRes,
XnUInt32  nYRes,
const XnIRPixel pExternalBuffer 
) [inline]

Shallow copies another Depth Meta Data object, and then ReAdjust it.

Parameters:
other [in] source object
nXRes [in] requested number of columns in the map
nYRes [in] requested number of rows in the map
pExternalBuffer [in] Optional. An external buffer matching requested resolution. If NULL, A buffer will be allocated.

void xn::IRMetaData::InitFrom ( const IRMetaData other  )  [inline]

Shallow-Copies an IR Meta Data object. Note that the data buffer is not copied, and that both object will point to the same buffer.

Parameters:
other [in] source object.
const xn::IRMap& xn::IRMetaData::IRMap (  )  const [inline]

Gets a light object wrapping the IR map.

XnStatus xn::IRMetaData::ReAdjust ( XnUInt32  nXRes,
XnUInt32  nYRes,
const XnIRPixel pExternalBuffer = NULL 
) [inline]

Changes dimensions of the pixel-map.

Parameters:
nXRes [in] Number of columns in the map
nYRes [in] Number of rows in the map
pExternalBuffer [in] Optional. An external buffer to be used. If NULL is passed, a buffer will be allocated.

XnIRPixel* xn::IRMetaData::WritableData (  )  [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

Reimplemented from xn::OutputMetaData.

xn::IRMap& xn::IRMetaData::WritableIRMap (  )  [inline]

Gets a light object wrapping the writable IR map.


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

Generated on 11 Feb 2011 for OpenNI 1.0.0 by  doxygen 1.6.1