vr_driver.h File Reference

#include "vr_kit.h"
#include <string>
#include <map>
#include "lib_begin.h"
#include <cgv/config/lib_end.h>

Go to the source code of this file.

Classes
class	vr::vr_calibration_base
	base class with write access to driver calibration matrix More...
class	vr::vr_driver
	interface class for vr drivers. More...
struct	vr::driver_registry< T >
	use this template to register your own driver More...

Namespaces
	vr
	the vr namespace for virtual reality support

Functions
vr driver management
void	vr::register_driver (vr_driver *vrd)
	register a new driver
std::vector< vr_driver * > &	vr::get_vr_drivers ()
	return a vector with all registered vr drivers
vr kit management
std::vector< void * >	vr::scan_vr_kits ()
	iterate all registered vr drivers to scan for vr kits and return vector of vr kit handles
vr_kit *	vr::replace_by_index (int vr_kit_index, vr_kit *new_kit_ptr)
	scan vr kits and if one of given index exists replace it by passed kit and return index to replaced kit; in case of failure return 0 pointer
bool	vr::replace_by_pointer (vr_kit *old_kit_ptr, vr_kit *new_kit_ptr)
	scan vr kits and if one with given pointer exists, replace it by passed kit; return whether replacement was successful
vr_kit *	vr::get_vr_kit (void *handle)
	query a pointer to a vr kit by its device handle, function can return null pointer in case that no vr kit exists for given handle
bool	vr::unregister_vr_kit (void *handle, vr_kit *vr_kit_ptr)
	unregister a previously registered vr kit by handle and pointer
vr kit management
std::vector< void * >	vr::scan_vr_kits ()
	iterate all registered vr drivers to scan for vr kits and return vector of vr kit handles
vr_kit *	vr::replace_by_index (int vr_kit_index, vr_kit *new_kit_ptr)
	scan vr kits and if one of given index exists replace it by passed kit and return index to replaced kit; in case of failure return 0 pointer
bool	vr::replace_by_pointer (vr_kit *old_kit_ptr, vr_kit *new_kit_ptr)
	scan vr kits and if one with given pointer exists, replace it by passed kit; return whether replacement was successful
vr_kit *	vr::get_vr_kit (void *handle)
	query a pointer to a vr kit by its device handle, function can return null pointer in case that no vr kit exists for given handle
bool	vr::unregister_vr_kit (void *handle, vr_kit *vr_kit_ptr)
	unregister a previously registered vr kit by handle and pointer
vr kit management
std::vector< void * >	vr::scan_vr_kits ()
	iterate all registered vr drivers to scan for vr kits and return vector of vr kit handles
vr_kit *	vr::replace_by_index (int vr_kit_index, vr_kit *new_kit_ptr)
	scan vr kits and if one of given index exists replace it by passed kit and return index to replaced kit; in case of failure return 0 pointer
bool	vr::replace_by_pointer (vr_kit *old_kit_ptr, vr_kit *new_kit_ptr)
	scan vr kits and if one with given pointer exists, replace it by passed kit; return whether replacement was successful
vr_kit *	vr::get_vr_kit (void *handle)
	query a pointer to a vr kit by its device handle, function can return null pointer in case that no vr kit exists for given handle
bool	vr::unregister_vr_kit (void *handle, vr_kit *vr_kit_ptr)
	unregister a previously registered vr kit by handle and pointer

vr driver management
class CGV_API	vr::vr_driver
	forward declaration of vr driver class More...
std::vector< vr_driver * > &	vr::get_vr_drivers ()
	return a vector with all registered vr drivers
void	vr::register_driver (vr_driver *vrd)
	register a new driver

Detailed Description

defines the class vr::vr_driver class and gives access to the driver registry with the functions vr::register_driver() and vr::get_drivers(). Furthermore, vr kits can be scanned for in all registered drivers via the function vr::scan_vr_kits(), which returns a vector of device handles. The vr kits can be accessed from their device handles with the vr::get_vr_kit() function.