#include <OpenNI.h>

Public 成员函数
	Device ()

	Device (OniDeviceHandle handle)

	~Device ()

Status	open (const char *uri)

void	close ()

const DeviceInfo &	getDeviceInfo () const

bool	hasSensor (SensorType sensorType)

const SensorInfo *	getSensorInfo (SensorType sensorType)

OniDeviceHandle	_getHandle () const

PlaybackControl *	getPlaybackControl ()

Status	getProperty (int propertyId, void data, int dataSize) const

Status	setProperty (int propertyId, const void *data, int dataSize)

void	setGain (int gain)

int	getGain ()

bool	isImageRegistrationModeSupported (ImageRegistrationMode mode) const

ImageRegistrationMode	getImageRegistrationMode () const

Status	setImageRegistrationMode (ImageRegistrationMode mode)

bool	isValid () const

bool	isFile () const

Status	setDepthColorSyncEnabled (bool isEnabled)

bool	getDepthColorSyncEnabled ()

template<class T >
Status	setProperty (int propertyId, const T &value)

template<class T >
Status	getProperty (int propertyId, T *value) const

bool	isPropertySupported (int propertyId) const

Status	invoke (int commandId, void *data, int dataSize)

template<class T >
Status	invoke (int propertyId, T &value)

bool	isCommandSupported (int commandId) const

Status	_openEx (const char uri, const char mode)

详细描述

The Device object abstracts a specific device; either a single hardware device, or a file device holding a recording from a hardware device. It offers the ability to connect to the device, and obtain information about its configuration and the data streams it can offer.

It provides the means to query and change all configuration parameters that apply to the device as a whole. This includes enabling depth/color image registration and frame synchronization.

Devices are used when creating and initializing VideoStreams – you will need a valid pointer to a Device in order to use the VideoStream.create() function. This, along with configuration, is the primary use of this class for application developers.

Before devices can be created, OpenNI::initialize() must have been run to make the device drivers on the system available to the API.

构造及析构函数说明

◆ Device() [1/2]

openni::Device::Device ( )

inline

Default constructor. Creates a new empty Device object. This object will be invalid until it is initialized by calling its open() function.

◆ Device() [2/2]

openni::Device::Device ( OniDeviceHandle handle )

inlineexplicit

Handle constructor. Creates a Device object based on the given initialized handle. This object will not destroy the underlying handle when close() or destructor is called

◆ ~Device()

openni::Device::~Device ( )

inline

The destructor calls the close() function, but it is considered a best practice for applications to call close() manually on any Device that they run open() on.

成员函数说明

◆ close()

void openni::Device::close ( )

inline

Closes the device. This properly closes any files or shuts down hardware, as appropriate. This function is currently called by the destructor if not called manually by application code, but it is considered a best practice to manually close any device that was opened.

◆ getDeviceInfo()

const DeviceInfo& openni::Device::getDeviceInfo ( ) const

inline

Provides information about this device in the form of a DeviceInfo object. This object can be used to access the URI of the device, as well as various USB descriptor strings that might be useful to an application.

Note that valid device info will not be available if this device has not yet been opened. If you are trying to obtain a URI to open a device, use OpenNI::enumerateDevices() instead.

返回: DeviceInfo object for this Device

◆ getImageRegistrationMode()

ImageRegistrationMode openni::Device::getImageRegistrationMode ( ) const

inline

Gets the current image registration mode of this device. Image registration is used to properly superimpose two images from cameras located at different points in space. Please see the OpenNi 2.0 Programmer's Guide for more information about registration.

返回: Current image registration mode. See ImageRegistrationMode for possible return values.

◆ getPlaybackControl()

PlaybackControl* openni::Device::getPlaybackControl ( )

inline

Gets an object through which playback of a file device can be controlled.

返回: NULL if this device is not a file device.

◆ getProperty() [1/2]

template<class T >

Status openni::Device::getProperty	(	int	propertyId,
		T *	value
	)		const

inline

Checks a property that provides an arbitrary data type as its output. It is not expected that application code will need this function frequently, as all commonly used properties have higher level functions provided.

模板参数

[in]	T Data type of the value to be read.

参数

[in]	propertyId	The numerical ID of the property to be read.
[in,out]	value	Pointer to a place to store the value read from the property.

返回: Status code indicating success or failure of this operation.

◆ getProperty() [2/2]

Status openni::Device::getProperty	(	int	propertyId,
		void *	data,
		int *	dataSize
	)		const

inline

Get the value of a general property of the device. There are convenience functions for all the commonly used properties, such as image registration and frame synchronization. It is expected for this reason that this function will rarely be directly used by applications.

参数

[in]	propertyId	Numerical ID of the property you would like to check.
[out]	data	Place to store the value of the property.
[in,out]	dataSize	IN: Size of the buffer passed in the `data` argument. OUT: the actual written size.

返回: Status code indicating results of this operation.

◆ getSensorInfo()

const SensorInfo* openni::Device::getSensorInfo ( SensorType sensorType )

inline

Get the SensorInfo for a specific sensor type on this device. The SensorInfo is useful primarily for determining which video modes are supported by the sensor.

参数

[in] sensorType of sensor to get information about.

返回: SensorInfo object corresponding to the sensor type specified, or NULL if such a sensor is not available from this device.

◆ hasSensor()

bool openni::Device::hasSensor ( SensorType sensorType )

inline

This function checks to see if one of the specific sensor types defined in SensorType is available on this device. This allows an application to, for example, query for the presence of a depth sensor, or color sensor.

参数

[in] sensorType of sensor to query for

返回: true if the Device supports the sensor queried, false otherwise.

◆ invoke() [1/2]

Status openni::Device::invoke	(	int	commandId,
		void *	data,
		int	dataSize
	)

inline

Invokes a command that takes an arbitrary data type as its input. It is not expected that application code will need this function frequently, as all commonly used properties have higher level functions provided.

参数

[in]	commandId	Numerical code of the property to be invoked.
[in]	data	Data to be passed to the property.
[in]	dataSize	size of the buffer passed in `data`.

返回: Status code indicating success or failure of this operation.

◆ invoke() [2/2]

template<class T >

Status openni::Device::invoke	(	int	propertyId,
		T &	value
	)

inline

Invokes a command that takes an arbitrary data type as its input. It is not expected that application code will need this function frequently, as all commonly used properties have higher level functions provided.

模板参数

[in]	T Type of data to be passed to the property.

参数

[in]	propertyId	Numerical code of the property to be invoked.
[in]	value	Data to be passed to the property.

返回: Status code indicating success or failure of this operation.

◆ isCommandSupported()

bool openni::Device::isCommandSupported ( int commandId ) const

inline

Checks if a specific command is supported by the device.

参数

[in] commandId Command to be checked.

返回: true if the command is supported, false otherwise.

◆ isFile()

bool openni::Device::isFile ( ) const

inline

Checks whether this device is a file device (i.e. a recording).

返回: true if this is a file device, false otherwise.

◆ isImageRegistrationModeSupported()

bool openni::Device::isImageRegistrationModeSupported ( ImageRegistrationMode mode ) const

inline

Checks to see if this device can support registration of color video and depth video. Image registration is used to properly superimpose two images from cameras located at different points in space. Please see the OpenNi 2.0 Programmer's Guide for more information about registration.

返回: true if image registration is supported by this device, false otherwise.

◆ isPropertySupported()

bool openni::Device::isPropertySupported ( int propertyId ) const

inline

Checks if a specific property is supported by the device.

参数

[in] propertyId Property to be checked.

返回: true if the property is supported, false otherwise.

◆ isValid()

bool openni::Device::isValid ( ) const

inline

Checks whether this Device object is currently connected to an actual file or hardware device.

返回: true if the Device is connected, false otherwise.

◆ open()

Status openni::Device::open ( const char * uri )

inline

Opens a device. This can either open a device chosen arbitrarily from all devices on the system, or open a specific device selected by passing this function the device URI.

To open any device, simply pass the constantANY_DEVICE to this function. If multiple devices are connected to the system, then one of them will be opened. This procedure is most useful when it is known that exactly one device is (or can be) connected to the system. In that case, requesting a list of all devices and iterating through it would be a waste of effort.

If multiple devices are (or may be) connected to a system, then a URI will be required to select a specific device to open. There are two ways to obtain a URI: from a DeviceConnected event, or by calling OpenNI::enumerateDevices().

In the case of a DeviceConnected event, the OpenNI::Listener will be provided with a DeviceInfo object as an argument to its onDeviceConnected() function.
The DeviceInfo.getUri() function can then be used to obtain the URI.

If the application is not using event handlers, then it can also call the static function OpenNI::enumerateDevices(). This will return an array of DeviceInfo objects, one for each device currently available to the system. The application can then iterate through this list and select the desired device. The URI is again obtained via the DeviceInfo::getUri() function.

Standard codes of type Status are returned indicating whether opening was successful.

参数

[in] uri String containing the URI of the device to be opened, or ANY_DEVICE.

返回: Status code with the outcome of the open operation.

备注: For opening a recording file, pass the file path as a uri.

◆ setDepthColorSyncEnabled()

Status openni::Device::setDepthColorSyncEnabled ( bool isEnabled )

inline

Used to turn the depth/color frame synchronization feature on and off. When frame synchronization is enabled, the device will deliver depth and image frames that are separated in time by some maximum value. When disabled, the phase difference between depth and image frame generation cannot be guaranteed.

参数

[in] isEnabled Set to TRUE to enable synchronization, FALSE to disable it

返回: Status code indicating success or failure of this operation

◆ setImageRegistrationMode()

Status openni::Device::setImageRegistrationMode ( ImageRegistrationMode mode )

inline

Sets the image registration on this device. Image registration is used to properly superimpose two images from cameras located at different points in space. Please see the OpenNi 2.0 Programmer's Guide for more information about registration.

See ImageRegistrationMode for a list of valid settings to pass to this function.

It is a good practice to first check if the mode is supported by calling isImageRegistrationModeSupported().

参数

[in] mode Desired new value for the image registration mode.

返回: Status code for the operation.

◆ setProperty() [1/2]

template<class T >

Status openni::Device::setProperty	(	int	propertyId,
		const T &	value
	)

inline

Sets a property that takes an arbitrary data type as its input. It is not expected that application code will need this function frequently, as all commonly used properties have higher level functions provided.

模板参数

T	Type of data to be passed to the property.

参数

[in]	propertyId	The numerical ID of the property to be set.
[in]	value	Place to store the data to be written to the property.

返回: Status code indicating success or failure of this operation.

◆ setProperty() [2/2]

Status openni::Device::setProperty	(	int	propertyId,
		const void *	data,
		int	dataSize
	)

inline

Sets the value of a general property of the device. There are convenience functions for all the commonly used properties, such as image registration and frame synchronization. It is expected for this reason that this function will rarely be directly used by applications.

参数

[in]	propertyId	The numerical ID of the property to be set.
[in]	data	Place to store the data to be written to the property.
[in]	dataSize	Size of the data to be written to the property.

返回: Status code indicating results of this operation.

该类的文档由以下文件生成:

D:/16、基础SDK/OpenNI2SDK/doc-new/OpenNI2.3-SDK Doc/zh/Include/OpenNI.h

Public 成员函数

详细描述

构造及析构函数说明

◆ Device() [1/2]

◆ Device() [2/2]

◆ ~Device()

成员函数说明

◆ close()

◆ getDeviceInfo()

◆ getImageRegistrationMode()

◆ getPlaybackControl()

◆ getProperty() [1/2]

◆ getProperty() [2/2]

◆ getSensorInfo()

◆ hasSensor()

◆ invoke() [1/2]

◆ invoke() [2/2]

◆ isCommandSupported()

◆ isFile()

◆ isImageRegistrationModeSupported()

◆ isPropertySupported()

◆ isValid()

◆ open()

◆ setDepthColorSyncEnabled()

◆ setImageRegistrationMode()

◆ setProperty() [1/2]

◆ setProperty() [2/2]