Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
openni::SensorInfo Class Reference

#include <OpenNI.h>

Public Member Functions

SensorType getSensorType () const
 
const Array< VideoMode > & getSupportedVideoModes () const
 

Private Member Functions

void _setInternal (const OniSensorInfo *pInfo)
 
SensorInfooperator= (const SensorInfo &)
 
 SensorInfo (const SensorInfo &)
 
 SensorInfo ()
 
 SensorInfo (const OniSensorInfo *pInfo)
 

Private Attributes

const OniSensorInfom_pInfo
 
Array< VideoModem_videoModes
 

Friends

class Device
 
class VideoStream
 

Detailed Description

The SensorInfo class encapsulates all info related to a specific sensor in a specific device. A Device object holds a SensorInfo object for each sensor it contains. A VideoStream object holds one SensorInfo object, describing the sensor used to produce that stream.

A given SensorInfo object will contain the type of the sensor (Depth, IR or Color), and a list of all video modes that the sensor can support. Each available video mode will have a single VideoMode object that can be queried to get the details of that mode.

SensorInfo objects should be the only source of VideoMode objects for the vast majority of application programs.

Application programs will never directly instantiate objects of type SensorInfo. In fact, no public constructors are provided. SensorInfo objects should be obtained either from a Device or VideoStream, and in turn be used to provide available video modes for that sensor.

Definition at line 314 of file OpenNI.h.

Constructor & Destructor Documentation

openni::SensorInfo::SensorInfo ( const SensorInfo )
private
openni::SensorInfo::SensorInfo ( )
inlineprivate

Definition at line 336 of file OpenNI.h.

openni::SensorInfo::SensorInfo ( const OniSensorInfo pInfo)
inlineprivate

Definition at line 338 of file OpenNI.h.

Member Function Documentation

void openni::SensorInfo::_setInternal ( const OniSensorInfo pInfo)
inlineprivate

Definition at line 343 of file OpenNI.h.

SensorType openni::SensorInfo::getSensorType ( ) const
inline

Provides the sensor type of the sensor this object is associated with.

Returns
Type of the sensor.

Definition at line 321 of file OpenNI.h.

const Array<VideoMode>& openni::SensorInfo::getSupportedVideoModes ( ) const
inline

Provides a list of video modes that this sensor can support. This function is the recommended method to be used by applications to obtain VideoMode objects.

Returns
Reference to an array of VideoMode objects, one for each supported video mode.

Definition at line 330 of file OpenNI.h.

SensorInfo& openni::SensorInfo::operator= ( const SensorInfo )
private

Friends And Related Function Documentation

friend class Device
friend

Definition at line 360 of file OpenNI.h.

friend class VideoStream
friend

Definition at line 359 of file OpenNI.h.

Member Data Documentation

const OniSensorInfo* openni::SensorInfo::m_pInfo
private

Definition at line 356 of file OpenNI.h.

Array<VideoMode> openni::SensorInfo::m_videoModes
private

Definition at line 357 of file OpenNI.h.


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


libfreenect
Author(s): Hector Martin, Josh Blake, Kyle Machulis, OpenKinect community
autogenerated on Thu Jun 6 2019 19:25:39