Wrapper for a viewer and eye bound to a display config. DOES NOT provide lifetime management for the associated display config! More...

Public Member Functions
bool	getPose (OSVR_Pose3 &pose)
	Attempt to get the eye pose. More...

bool	getViewMatrix (OSVR_MatrixConventions flags, double mat[OSVR_MATRIX_SIZE])
	Attempt to get the view matrix. More...

bool	getViewMatrix (OSVR_MatrixConventions flags, float mat[OSVR_MATRIX_SIZE])

Child-related methods
OSVR_SurfaceCount	getNumSurfaces () const

Surface	getSurface (OSVR_SurfaceCount surface) const

Iteration methods
template<typename F >
void	forEachSurface (F OSVR_CLIENTKIT_FUNCTOR_REF functor)

Identification getters
OSVR_DisplayConfig	getDisplayConfig () const

OSVR_ViewerCount	getViewerID () const

OSVR_EyeCount	getEyeID () const

Related Functions
(Note that these are not member functions.)
bool	operator== (Eye const &lhs, Eye const &rhs)
	Equality operator for clientkit::Eye. More...

bool	operator!= (Eye const &lhs, Eye const &rhs)
	Inequality operator for clientkit::Eye. More...

Detailed Description

Wrapper for a viewer and eye bound to a display config. DOES NOT provide lifetime management for the associated display config!

Definition at line 248 of file Display.h.

Member Function Documentation

bool osvr::clientkit::Eye::getPose ( OSVR_Pose3 & pose )

inline

Attempt to get the eye pose.

Returns: false if there was an error in the input parameters or if no pose is yet available

Definition at line 280 of file Display.h.

bool osvr::clientkit::Eye::getViewMatrix	(	OSVR_MatrixConventions	flags,
		double	mat[OSVR_MATRIX_SIZE]
	)

inline

Attempt to get the view matrix.

Returns: false if there was an error in the input parameters or if no pose (and thus view) is yet available.

Definition at line 290 of file Display.h.

bool osvr::clientkit::Eye::getViewMatrix	(	OSVR_MatrixConventions	flags,
		float	mat[OSVR_MATRIX_SIZE]
	)

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 298 of file Display.h.

template<typename F >

void osvr::clientkit::Eye::forEachSurface ( F OSVR_CLIENTKIT_FUNCTOR_REF functor )

inline

For each display surface seen by the given eye of the given viewer...

Definition at line 308 of file Display.h.

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