icl::io::icl_openni::OpenNIMapGenerator Class Reference

abstract super-class of all Image generators More...

#include <OpenNIUtils.h>

Inheritance diagram for icl::io::icl_openni::OpenNIMapGenerator:

Public Types
enum	Generators { RGB, DEPTH, IR, NOT_SPECIFIED = -1 }
	an enum listing all supported data generators More...

Public Member Functions
virtual bool	acquireImage (core::ImgBase *dest)=0
	grab function grabs an image returns whether grabbing worked More...
virtual bool	newFrameAvailable ()=0
	checks whether a new frame is available More...
virtual Generators	getGeneratorType ()=0
	tells the type of the Generator More...
virtual xn::MapGenerator *	getMapGenerator ()=0
	returns underlying xn::MapGenerator instance More...
virtual core::ImgBase *	initBuffer ()=0
	Creates an core::ImgBase for ReadWriteBuffer. More...
virtual MapGeneratorOptions *	getMapGeneratorOptions ()=0
	getter for MapGeneratorOptions More...

Static Public Member Functions
static OpenNIMapGenerator *	createGenerator (std::string id)
	Creates the corresponding Generator. More...
static std::string	getMapOutputModeInfo (xn::MapGenerator *gen)
	creates an info string for MapOutputModes of MapGenerator gen. More...
static std::string	getCurrentMapOutputMode (xn::MapGenerator *gen)
	creates a string describing the current MapOutputMode More...

Detailed Description

abstract super-class of all Image generators

Member Enumeration Documentation

Generators

enum icl::io::icl_openni::OpenNIMapGenerator::Generators

an enum listing all supported data generators

Enumerator
RGB
DEPTH
IR
NOT_SPECIFIED

Member Function Documentation

acquireImage()

virtual bool icl::io::icl_openni::OpenNIMapGenerator::acquireImage ( core::ImgBase *  dest )

pure virtual

grab function grabs an image returns whether grabbing worked

Implemented in icl::io::icl_openni::OpenNIIRGenerator, icl::io::icl_openni::OpenNIRgbGenerator, and icl::io::icl_openni::OpenNIDepthGenerator.

createGenerator()

static OpenNIMapGenerator* icl::io::icl_openni::OpenNIMapGenerator::createGenerator ( std::string  id )

static

Creates the corresponding Generator.

getCurrentMapOutputMode()

static std::string icl::io::icl_openni::OpenNIMapGenerator::getCurrentMapOutputMode ( xn::MapGenerator *  gen )

static

creates a string describing the current MapOutputMode

getGeneratorType()

virtual Generators icl::io::icl_openni::OpenNIMapGenerator::getGeneratorType ( )

pure virtual

tells the type of the Generator

Implemented in icl::io::icl_openni::OpenNIIRGenerator, icl::io::icl_openni::OpenNIRgbGenerator, and icl::io::icl_openni::OpenNIDepthGenerator.

getMapGenerator()

virtual xn::MapGenerator* icl::io::icl_openni::OpenNIMapGenerator::getMapGenerator ( )

pure virtual

returns underlying xn::MapGenerator instance

Implemented in icl::io::icl_openni::OpenNIIRGenerator, icl::io::icl_openni::OpenNIRgbGenerator, and icl::io::icl_openni::OpenNIDepthGenerator.

getMapGeneratorOptions()

virtual MapGeneratorOptions* icl::io::icl_openni::OpenNIMapGenerator::getMapGeneratorOptions ( )

pure virtual

getter for MapGeneratorOptions

Implemented in icl::io::icl_openni::OpenNIIRGenerator, icl::io::icl_openni::OpenNIRgbGenerator, and icl::io::icl_openni::OpenNIDepthGenerator.

getMapOutputModeInfo()

static std::string icl::io::icl_openni::OpenNIMapGenerator::getMapOutputModeInfo ( xn::MapGenerator *  gen )

static

creates an info string for MapOutputModes of MapGenerator gen.

initBuffer()

virtual core::ImgBase* icl::io::icl_openni::OpenNIMapGenerator::initBuffer ( )

pure virtual

Creates an core::ImgBase for ReadWriteBuffer.

Implements icl::io::icl_openni::ReadWriteBufferHandler< core::ImgBase >.

Implemented in icl::io::icl_openni::OpenNIIRGenerator, icl::io::icl_openni::OpenNIRgbGenerator, and icl::io::icl_openni::OpenNIDepthGenerator.

newFrameAvailable()

virtual bool icl::io::icl_openni::OpenNIMapGenerator::newFrameAvailable ( )

pure virtual

checks whether a new frame is available

Implemented in icl::io::icl_openni::OpenNIIRGenerator, icl::io::icl_openni::OpenNIRgbGenerator, and icl::io::icl_openni::OpenNIDepthGenerator.

---

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

• /Users/alneuman/vm/icl/ICLIO/src/ICLIO/OpenNIUtils.h