xn::MapMetaData Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::MapMetaData:

List of all members.

Public Member Functions
XnStatus	AllocateData (XnUInt32 nXRes, XnUInt32 nYRes)
XnUInt32	BytesPerPixel () const
XnUInt32	FPS () const
XnUInt32 &	FPS ()
XnUInt32	FullXRes () const
XnUInt32 &	FullXRes ()
XnUInt32	FullYRes () const
XnUInt32 &	FullYRes ()
const XnMapMetaData *	GetUnderlying () const
XnMapMetaData *	GetUnderlying ()
	MapMetaData (XnPixelFormat format, const XnUInt8 **ppData)
XnPixelFormat	PixelFormat () const
XnStatus	ReAdjust (XnUInt32 nXRes, XnUInt32 nYRes, const XnUInt8 *pExternalBuffer)
XnUInt32	XOffset () const
XnUInt32 &	XOffset ()
XnUInt32	XRes () const
XnUInt32 &	XRes ()
XnUInt32	YOffset () const
XnUInt32 &	YOffset ()
XnUInt32	YRes () const
XnUInt32 &	YRes ()
Protected Member Functions
XnPixelFormat &	PixelFormatImpl ()
Private Member Functions
	MapMetaData (const MapMetaData &other)
MapMetaData &	operator= (const MapMetaData &)
Private Attributes
XnMapMetaData	m_map

---

Detailed Description

Represents a MetaData object for generators producing pixel-map-based outputs

Definition at line 221 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::MapMetaData::MapMetaData	(	XnPixelFormat	format,
		const XnUInt8 **	ppData
	)		[inline]

Ctor. Meant to be used by inheriting classes.

Parameters:

format	[in] Pixel Format
ppData	[in] A pointer to the data member of the meta data object

Definition at line 230 of file XnCppWrapper.h.

xn::MapMetaData::MapMetaData

(

const MapMetaData &

other

)

[inline, private]

---

Member Function Documentation

XnStatus xn::MapMetaData::AllocateData	(	XnUInt32	nXRes,
		XnUInt32	nYRes
	)		[inline]

Allocated a writable buffer. If a previous buffer was allocated it will be freed (or reused if possible). Also see conc_meta_data.

Parameters:

nXRes	[in] The number of required columns in the map.
nYRes	[in] The number of required rows in the map.

Definition at line 305 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::BytesPerPixel

(

)

const [inline]

Gets the number of bytes each pixel occupies.

Definition at line 281 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::FPS

(

)

const [inline]

Gets the FPS in which frame was generated.

Definition at line 268 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::FPS

(

)

[inline]

Gets the FPS in which frame was generated.

Definition at line 270 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::FullXRes

(

)

const [inline]

Gets the number of columns in the full frame (entire field-of-view, ignoring cropping).

Definition at line 258 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::FullXRes

(

)

[inline]

Gets the number of columns in the full frame (entire field-of-view, ignoring cropping).

Definition at line 260 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::FullYRes

(

)

const [inline]

Gets the number of rows in the full frame (entire field-of-view, ignoring cropping).

Definition at line 263 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::FullYRes

(

)

[inline]

Gets the number of rows in the full frame (entire field-of-view, ignoring cropping).

Definition at line 265 of file XnCppWrapper.h.

const XnMapMetaData* xn::MapMetaData::GetUnderlying

(

)

const [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::OutputMetaData.

Reimplemented in xn::SceneMetaData, xn::IRMetaData, xn::ImageMetaData, and xn::DepthMetaData.

Definition at line 276 of file XnCppWrapper.h.

XnMapMetaData* xn::MapMetaData::GetUnderlying

(

)

[inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::OutputMetaData.

Reimplemented in xn::SceneMetaData, xn::IRMetaData, xn::ImageMetaData, and xn::DepthMetaData.

Definition at line 278 of file XnCppWrapper.h.

MapMetaData& xn::MapMetaData::operator=

(

const MapMetaData &

)

[private]

XnPixelFormat xn::MapMetaData::PixelFormat

(

)

const [inline]

Gets the pixel format of the pixel-map.

Reimplemented in xn::ImageMetaData.

Definition at line 273 of file XnCppWrapper.h.

XnPixelFormat& xn::MapMetaData::PixelFormatImpl

(

)

[inline, protected]

Definition at line 350 of file XnCppWrapper.h.

XnStatus xn::MapMetaData::ReAdjust	(	XnUInt32	nXRes,
		XnUInt32	nYRes,
		const XnUInt8 *	pExternalBuffer
	)		[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.

Definition at line 328 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::XOffset

(

)

const [inline]

Gets the offset, in columns, of the buffer within the field of view (0 if cropping is off).

Definition at line 248 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::XOffset

(

)

[inline]

Gets the offset, in columns, of the buffer within the field of view (0 if cropping is off).

Definition at line 250 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::XRes

(

)

const [inline]

Gets the actual number of columns in the frame (after cropping)

Definition at line 238 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::XRes

(

)

[inline]

Gets the actual number of columns in the frame (after cropping)

Definition at line 240 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::YOffset

(

)

const [inline]

Gets the offset, in rows, of the buffer within the field of view (0 if cropping is off).

Definition at line 253 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::YOffset

(

)

[inline]

Gets the offset, in rows, of the buffer within the field of view (0 if cropping is off).

Definition at line 255 of file XnCppWrapper.h.

XnUInt32 xn::MapMetaData::YRes

(

)

const [inline]

Gets the actual number of rows in the frame (after cropping)

Definition at line 243 of file XnCppWrapper.h.

XnUInt32& xn::MapMetaData::YRes

(

)

[inline]

Gets the actual number of rows in the frame (after cropping)

Definition at line 245 of file XnCppWrapper.h.

---

Member Data Documentation

XnMapMetaData xn::MapMetaData::m_map [private]

Definition at line 358 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h