OpenNI 1.5.4: xn::IRGenerator Class Reference


#include <XnCppWrapper.h>

Inheritance diagram for xn::IRGenerator:

List of all members.

Public Member Functions

 IRGenerator (XnNodeHandle hNode=NULL)
 IRGenerator (const NodeWrapper &other)
XnStatus Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)
void GetMetaData (IRMetaData &metaData) const
const XnIRPixelGetIRMap () const

Detailed Description

Purpose: An IRGenerator node is a map generator that outputs infra-red maps.

Usage: Instantiate and create an IR generator node

Data output: IR maps

Constructor & Destructor Documentation

xn::IRGenerator::IRGenerator ( XnNodeHandle  hNode = NULL) [inline]


[in]hNodeNode handle
xn::IRGenerator::IRGenerator ( const NodeWrapper other) [inline]

Member Function Documentation

XnStatus xn::IRGenerator::Create ( Context context,
Query pQuery = NULL,
EnumerationErrors pErrors = NULL 
) [inline]

Creates an IRGenerator node from available production node alternatives.

See Understanding the Create() method for a detailed description about the operation of this method.

const XnIRPixel* xn::IRGenerator::GetIRMap ( ) const [inline]

Gets a pointer to the latest IR map.

void xn::IRGenerator::GetMetaData ( IRMetaData metaData) const [inline]

Gets the IR generator node's latest frame object, saving it in the xn::IRMetaData object. This frame object is a snapshot of the generated IR map data and its associated configuration information at a certain point in time. This saved frame object provides fast and easy access to the IR generator node's data and configuration information.

[out]metaDataStructure to be filled with the frame object.


This method is central in the use of the IRGenerator node. Once the IRGenerator node is generating data, after each 'Update Data' call, the application calls this method to get the node's frame object, which contains the data and all its associated properties.

The documentation for this class was generated from the following file:
Generated on Wed May 16 2012 10:16:07 for OpenNI 1.5.4 by   doxygen