Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions
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:
icl::io::icl_openni::ReadWriteBufferHandler< core::ImgBase > icl::io::icl_openni::OpenNIDepthGenerator icl::io::icl_openni::OpenNIIRGenerator icl::io::icl_openni::OpenNIRgbGenerator

List of all members.

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
virtual bool newFrameAvailable ()=0
 checks whether a new frame is available
virtual Generators getGeneratorType ()=0
 tells the type of the Generator
virtual xn::MapGenerator * getMapGenerator ()=0
 returns underlying xn::MapGenerator instance
virtual core::ImgBaseinitBuffer ()=0
 Creates an core::ImgBase for ReadWriteBuffer.
virtual MapGeneratorOptionsgetMapGeneratorOptions ()=0
 getter for MapGeneratorOptions

Static Public Member Functions

static OpenNIMapGeneratorcreateGenerator (std::string id)
 Creates the corresponding Generator.
static std::string getMapOutputModeInfo (xn::MapGenerator *gen)
 creates an info string for MapOutputModes of MapGenerator gen.
static std::string getCurrentMapOutputMode (xn::MapGenerator *gen)
 creates a string describing the current MapOutputMode

Detailed Description

abstract super-class of all Image generators


Member Enumeration Documentation

an enum listing all supported data generators

Enumerator:
RGB 
DEPTH 
IR 
NOT_SPECIFIED 

Member Function Documentation

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.

Creates the corresponding Generator.

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

creates a string describing the current MapOutputMode

virtual xn::MapGenerator* icl::io::icl_openni::OpenNIMapGenerator::getMapGenerator ( ) [pure virtual]
static std::string icl::io::icl_openni::OpenNIMapGenerator::getMapOutputModeInfo ( xn::MapGenerator *  gen) [static]

creates an info string for MapOutputModes of MapGenerator gen.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines