Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::io::icl_openni::OpenNIDepthGenerator Class Reference

Depth Image Generator. More...

#include <OpenNIUtils.h>

Inheritance diagram for icl::io::icl_openni::OpenNIDepthGenerator:
icl::io::icl_openni::OpenNIMapGenerator icl::io::icl_openni::ReadWriteBufferHandler< core::ImgBase >

Public Member Functions

 OpenNIDepthGenerator (int num)
 Creates DepthGenerator number num from Context. More...
 
 ~OpenNIDepthGenerator ()
 Destructor frees all resouurces. More...
 
bool acquireImage (core::ImgBase *dest)
 grab function grabs an image returns whether grabbing worked More...
 
bool newFrameAvailable ()
 checks whether a new frame is available More...
 
Generators getGeneratorType ()
 tells the type of the Generator More...
 
xn::MapGenerator * getMapGenerator ()
 returns underlying xn::MapGenerator instance More...
 
core::ImgBaseinitBuffer ()
 Creates an core::Img16s for ReadWriteBuffer. More...
 
MapGeneratorOptionsgetMapGeneratorOptions ()
 getter for MapGeneratorOptions More...
 

Private Attributes

xn::DepthGenerator * m_DepthGenerator
 the underlying core::depth generator More...
 
xn::DepthMetaData m_DepthMD
 a DepthMetaData object holding image information More...
 
MapGeneratorOptionsm_Options
 pointer to internally used MapGeneratorOptions More...
 
unsigned int m_FrameId
 the id of the last grabbed frame More...
 

Additional Inherited Members

- Public Types inherited from icl::io::icl_openni::OpenNIMapGenerator
enum  Generators { RGB, DEPTH, IR, NOT_SPECIFIED = -1 }
 an enum listing all supported data generators More...
 
- Static Public Member Functions inherited from icl::io::icl_openni::OpenNIMapGenerator
static OpenNIMapGeneratorcreateGenerator (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

Depth Image Generator.

Constructor & Destructor Documentation

◆ OpenNIDepthGenerator()

icl::io::icl_openni::OpenNIDepthGenerator::OpenNIDepthGenerator ( int  num)

Creates DepthGenerator number num from Context.

◆ ~OpenNIDepthGenerator()

icl::io::icl_openni::OpenNIDepthGenerator::~OpenNIDepthGenerator ( )

Destructor frees all resouurces.

Member Function Documentation

◆ acquireImage()

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

grab function grabs an image returns whether grabbing worked

Implements icl::io::icl_openni::OpenNIMapGenerator.

◆ getGeneratorType()

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

tells the type of the Generator

Implements icl::io::icl_openni::OpenNIMapGenerator.

◆ getMapGenerator()

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

returns underlying xn::MapGenerator instance

Implements icl::io::icl_openni::OpenNIMapGenerator.

◆ getMapGeneratorOptions()

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

◆ initBuffer()

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

◆ newFrameAvailable()

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

checks whether a new frame is available

Implements icl::io::icl_openni::OpenNIMapGenerator.

Member Data Documentation

◆ m_DepthGenerator

xn::DepthGenerator* icl::io::icl_openni::OpenNIDepthGenerator::m_DepthGenerator
private

the underlying core::depth generator

◆ m_DepthMD

xn::DepthMetaData icl::io::icl_openni::OpenNIDepthGenerator::m_DepthMD
private

a DepthMetaData object holding image information

◆ m_FrameId

unsigned int icl::io::icl_openni::OpenNIDepthGenerator::m_FrameId
private

the id of the last grabbed frame

◆ m_Options

MapGeneratorOptions* icl::io::icl_openni::OpenNIDepthGenerator::m_Options
private

pointer to internally used MapGeneratorOptions


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