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

RGB Image Generator. More...

#include <OpenNIUtils.h>

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

Public Member Functions

 OpenNIRgbGenerator (int num)
 Creates RgbGenerator number num from Context. More...
 
 ~OpenNIRgbGenerator ()
 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::Img8uinitBuffer ()
 Creates an core::Img8u for ReadWriteBuffer. More...
 
MapGeneratorOptionsgetMapGeneratorOptions ()
 getter for MapGeneratorOptions More...
 

Private Attributes

xn::NodeInfo * m_DeviceInfo = NULL
 A NodeInfo for the used device. More...
 
xn::ImageGenerator * m_RgbGenerator = NULL
 the underlying rgb-image generator More...
 
unsigned int m_FrameId
 the id of the last grabbed frame More...
 
xn::DepthGenerator * m_DepthGenerator = NULL
 the underlying core::depth generator More...
 
xn::IRGenerator * m_IrGenerator = NULL
 
xn::ImageMetaData m_RgbMD
 a ImagehMetaData object holding image information More...
 
MapGeneratorOptionsm_Options = NULL
 pointer to internally used MapGeneratorOptions 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

RGB Image Generator.

Constructor & Destructor Documentation

◆ OpenNIRgbGenerator()

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

Creates RgbGenerator number num from Context.

◆ ~OpenNIRgbGenerator()

icl::io::icl_openni::OpenNIRgbGenerator::~OpenNIRgbGenerator ( )

Destructor frees all resouurces.

Member Function Documentation

◆ acquireImage()

bool icl::io::icl_openni::OpenNIRgbGenerator::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::OpenNIRgbGenerator::getGeneratorType ( )
virtual

tells the type of the Generator

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

◆ getMapGenerator()

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

returns underlying xn::MapGenerator instance

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

◆ getMapGeneratorOptions()

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

◆ initBuffer()

core::Img8u* icl::io::icl_openni::OpenNIRgbGenerator::initBuffer ( )
virtual

◆ newFrameAvailable()

bool icl::io::icl_openni::OpenNIRgbGenerator::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::OpenNIRgbGenerator::m_DepthGenerator = NULL
private

the underlying core::depth generator

The Xtion cam does not provide rgb images without depthGenerator being created.

◆ m_DeviceInfo

xn::NodeInfo* icl::io::icl_openni::OpenNIRgbGenerator::m_DeviceInfo = NULL
private

A NodeInfo for the used device.

◆ m_FrameId

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

the id of the last grabbed frame

◆ m_IrGenerator

xn::IRGenerator* icl::io::icl_openni::OpenNIRgbGenerator::m_IrGenerator = NULL
private

◆ m_Options

MapGeneratorOptions* icl::io::icl_openni::OpenNIRgbGenerator::m_Options = NULL
private

pointer to internally used MapGeneratorOptions

◆ m_RgbGenerator

xn::ImageGenerator* icl::io::icl_openni::OpenNIRgbGenerator::m_RgbGenerator = NULL
private

the underlying rgb-image generator

◆ m_RgbMD

xn::ImageMetaData icl::io::icl_openni::OpenNIRgbGenerator::m_RgbMD
private

a ImagehMetaData object holding image information


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