QVR 4.0.1
A library to build Virtual Reality applications
Public Member Functions | Static Public Attributes | Friends | List of all members
QVRObserverConfig Class Reference

Configuration of a QVRObserver. More...

#include <config.hpp>

Public Member Functions

 QVRObserverConfig ()
 Constructor. More...
 
const QString & id () const
 Returns the unique id. More...
 
QVRNavigationType navigationType () const
 Returns the navigation type. More...
 
const QString & navigationParameters () const
 Returns navigation parameters. More...
 
QVRTrackingType trackingType () const
 Returns the tracking type. More...
 
const QString & trackingParameters () const
 Returns tracking parameters. More...
 
const QVector3D & initialNavigationPosition () const
 Returns the initial navigation position. More...
 
const QVector3D & initialNavigationForwardDirection () const
 Returns the initial navigation forward direction. More...
 
const QVector3D & initialNavigationUpDirection () const
 Returns the initial navigation upward direction. More...
 
QQuaternion initialNavigationOrientation () const
 Returns the initial navigation orientation, computed from forward and up direction. More...
 
float initialEyeDistance () const
 Returns the eye distance (interpupillary distance). More...
 
const QVector3D & initialTrackingPosition () const
 Returns the initial tracking position. More...
 
const QVector3D & initialTrackingForwardDirection () const
 Returns the initial tracking forward direction. More...
 
const QVector3D & initialTrackingUpDirection () const
 Returns the initial tracking upward direction. More...
 
QQuaternion initialTrackingOrientation () const
 Returns the initial tracking orientation, computed from forward and up direction. More...
 

Static Public Attributes

static constexpr float defaultEyeHeight = 1.76f - 0.15f
 Default eye height: average human height minus average human offset to eye. More...
 
static constexpr float defaultEyeDistance = 0.064f
 Default eye distance: average value for humans. More...
 

Friends

class QVRConfig
 

Detailed Description

Configuration of a QVRObserver.

Constructor & Destructor Documentation

◆ QVRObserverConfig()

QVRObserverConfig::QVRObserverConfig ( )

Constructor.

Member Function Documentation

◆ id()

const QString & QVRObserverConfig::id ( ) const
inline

Returns the unique id.

◆ initialEyeDistance()

float QVRObserverConfig::initialEyeDistance ( ) const
inline

Returns the eye distance (interpupillary distance).

◆ initialNavigationForwardDirection()

const QVector3D & QVRObserverConfig::initialNavigationForwardDirection ( ) const
inline

Returns the initial navigation forward direction.

◆ initialNavigationOrientation()

QQuaternion QVRObserverConfig::initialNavigationOrientation ( ) const
inline

Returns the initial navigation orientation, computed from forward and up direction.

◆ initialNavigationPosition()

const QVector3D & QVRObserverConfig::initialNavigationPosition ( ) const
inline

Returns the initial navigation position.

◆ initialNavigationUpDirection()

const QVector3D & QVRObserverConfig::initialNavigationUpDirection ( ) const
inline

Returns the initial navigation upward direction.

◆ initialTrackingForwardDirection()

const QVector3D & QVRObserverConfig::initialTrackingForwardDirection ( ) const
inline

Returns the initial tracking forward direction.

◆ initialTrackingOrientation()

QQuaternion QVRObserverConfig::initialTrackingOrientation ( ) const
inline

Returns the initial tracking orientation, computed from forward and up direction.

◆ initialTrackingPosition()

const QVector3D & QVRObserverConfig::initialTrackingPosition ( ) const
inline

Returns the initial tracking position.

◆ initialTrackingUpDirection()

const QVector3D & QVRObserverConfig::initialTrackingUpDirection ( ) const
inline

Returns the initial tracking upward direction.

◆ navigationParameters()

const QString & QVRObserverConfig::navigationParameters ( ) const
inline

Returns navigation parameters.

For QVR_Navigation_Stationary, parameters are ignored.

For QVR_Navigation_Device, the parameter is the id of the device to use.

For QVR_Navigation_WASDQE, parameters are currently ignored.

For QVR_Navigation_Custom, parameters are currently ignored by QVR, but may be used by applications.

◆ navigationType()

QVRNavigationType QVRObserverConfig::navigationType ( ) const
inline

Returns the navigation type.

◆ trackingParameters()

const QString & QVRObserverConfig::trackingParameters ( ) const
inline

Returns tracking parameters.

For QVR_Tracking_Stationary, parameters are ignored.

For QVR_Tracking_Device, the parameter is the id of the device to use. The pose of this device is interpreted as the pose of the center eye; left and right eye poses are computed from this and depend on the observer's eye distance. If two device ids are given, their poses are interpreted as the poses of the left and right eye and used directly.

For QVR_Tracking_Oculus, parameters are currently ignored.

For QVR_Tracking_Custom, parameters are currently ignored by QVR, but may be used by applications.

◆ trackingType()

QVRTrackingType QVRObserverConfig::trackingType ( ) const
inline

Returns the tracking type.

Friends And Related Function Documentation

◆ QVRConfig

friend class QVRConfig
friend

Member Data Documentation

◆ defaultEyeDistance

constexpr float QVRObserverConfig::defaultEyeDistance = 0.064f
staticconstexpr

Default eye distance: average value for humans.

◆ defaultEyeHeight

constexpr float QVRObserverConfig::defaultEyeHeight = 1.76f - 0.15f
staticconstexpr

Default eye height: average human height minus average human offset to eye.


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