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

#include <XnCppWrapper.h>

Inheritance diagram for xn::DepthMetaData:
[legend]

List of all members.

Public Member Functions

 DepthMetaData ()
void InitFrom (const DepthMetaData &other)
XnStatus InitFrom (const DepthMetaData &other, XnUInt32 nXRes, XnUInt32 nYRes, const XnDepthPixel *pExternalBuffer)
XnStatus CopyFrom (const DepthMetaData &other)
XnStatus ReAdjust (XnUInt32 nXRes, XnUInt32 nYRes, const XnDepthPixel *pExternalBuffer=NULL)
XnDepthPixel ZRes () const
XnDepthPixelZRes ()
const XnDepthPixelData () const
const XnDepthPixel *& Data ()
XnDepthPixelWritableData ()
const xn::DepthMap & DepthMap () const
xn::DepthMap & WritableDepthMap ()
const XnDepthPixeloperator[] (XnUInt32 nIndex) const
const XnDepthPixeloperator() (XnUInt32 x, XnUInt32 y) const
const XnDepthMetaDataGetUnderlying () const
XnDepthMetaDataGetUnderlying ()

Detailed Description

Represents a MetaData object for generators producing depth-maps.


Constructor & Destructor Documentation

xn::DepthMetaData::DepthMetaData (  )  [inline]

Ctor.


Member Function Documentation

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

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

Parameters:
other [in] source object
const XnDepthPixel*& xn::DepthMetaData::Data (  )  [inline]

Gets a pointer to the data.

Reimplemented from xn::OutputMetaData.

const XnDepthPixel* xn::DepthMetaData::Data (  )  const [inline]

Gets a pointer to the data.

Reimplemented from xn::OutputMetaData.

const xn::DepthMap& xn::DepthMetaData::DepthMap (  )  const [inline]

Gets a light object wrapping the depth-map.

XnDepthMetaData* xn::DepthMetaData::GetUnderlying (  )  [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::MapMetaData.

const XnDepthMetaData* xn::DepthMetaData::GetUnderlying (  )  const [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::MapMetaData.

XnStatus xn::DepthMetaData::InitFrom ( const DepthMetaData other,
XnUInt32  nXRes,
XnUInt32  nYRes,
const XnDepthPixel 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::DepthMetaData::InitFrom ( const DepthMetaData other  )  [inline]

Shallow-Copies a Depth 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 XnDepthPixel& xn::DepthMetaData::operator() ( XnUInt32  x,
XnUInt32  y 
) const [inline]

Gets the value of the pixel

Parameters:
x [in] X-coordinate of the pixel in the map
y [in] Y-coordinate of the pixel in the map
const XnDepthPixel& xn::DepthMetaData::operator[] ( XnUInt32  nIndex  )  const [inline]

Gets the value of the pixel

Parameters:
nIndex [in] The index of the pixel in the buffer.
XnStatus xn::DepthMetaData::ReAdjust ( XnUInt32  nXRes,
XnUInt32  nYRes,
const XnDepthPixel 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.

XnDepthPixel* xn::DepthMetaData::WritableData (  )  [inline]

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

Reimplemented from xn::OutputMetaData.

xn::DepthMap& xn::DepthMetaData::WritableDepthMap (  )  [inline]

Gets a light object wrapping the writable depth-map.

XnDepthPixel& xn::DepthMetaData::ZRes (  )  [inline]

Gets the resolution of the depth axis (i.e. DepthGenerator::GetDeviceMaxDepth() + 1)

XnDepthPixel xn::DepthMetaData::ZRes (  )  const [inline]

Gets the resolution of the depth axis (i.e. DepthGenerator::GetDeviceMaxDepth() + 1)


The documentation for this class was generated from the following file:
Generated on Fri Nov 9 22:59:09 2012 for OpenNI 1.3.2 by  doxygen 1.6.3