QVRWindowConfig Class Reference

Configuration of a QVRWindow. More...

#include <config.hpp>

Public Member Functions
	QVRWindowConfig ()
	Constructor.
const QString &	id () const
	Returns the unique id.
int	observerIndex () const
	Returns the index of the observer that views this window.
QVROutputMode	outputMode () const
	Returns the output mode of this window.
const QString &	outputPlugin () const
	Returns the output plugin specification of this window (may be empty).
int	initialDisplayScreen () const
	Returns the initial display screen on which the window will appear (-1 for default).
bool	initialFullscreen () const
	Returns whether this window is initially in fullscreen mode.
QPoint	initialPosition () const
	Returns the initial position of this window on the screen ((-1,-1) for default).
QSize	initialSize () const
	Returns the initial size of this window on the screen.
QRect	initialGeometry () const
	Returns the initial geometry of this window on the screen, composed from initialPosition() and initialSize().
bool	screenIsFixedToObserver () const
	Returns whether the screen wall represented by this window is fixed to its observer.
bool	screenIsGivenByCenter () const
	Returns whether the screen wall coordinates determined from its center or from three of its corners.
const QVector3D &	screenCornerBottomLeft () const
	Returns the virtual world coordinates of the bottom left corner of the screen wall.
const QVector3D &	screenCornerBottomRight () const
	Returns the virtual world coordinates of the bottom right corner of the screen wall.
const QVector3D &	screenCornerTopLeft () const
	Returns the virtual world coordinates of the top left corner of the screen wall.
const QVector3D &	screenCenter () const
	Returns the virtual world coordinates of the center of the screen wall.
float	renderResolutionFactor () const
	Returns the render resolution factor.

Friends
class	QVRConfig

Detailed Description

Configuration of a QVRWindow.

A window is displayed on a display screen (in Qt terminology) and has a position and size on that display screen.

For the purpose of Virtual Reality rendering, a window represents a screen wall given in virtual world coordinates. The function screenIsGivenByCenter() determines whether these coordinates are determined from virtual world coordinates of the screen wall center, or from virtual world coordinates of the screen's bottom left, bottom right, and top left corners.

The Qt display screen and the virtual world screen wall should not be mixed up.

Constructor & Destructor Documentation

QVRWindowConfig()

QVRWindowConfig::QVRWindowConfig

(

)

Constructor.

Member Function Documentation

id()

const QString & QVRWindowConfig::id ( ) const

inline

Returns the unique id.

initialDisplayScreen()

int QVRWindowConfig::initialDisplayScreen ( ) const

inline

Returns the initial display screen on which the window will appear (-1 for default).

initialFullscreen()

bool QVRWindowConfig::initialFullscreen ( ) const

inline

Returns whether this window is initially in fullscreen mode.

initialGeometry()

QRect QVRWindowConfig::initialGeometry ( ) const

inline

Returns the initial geometry of this window on the screen, composed from initialPosition() and initialSize().

initialPosition()

QPoint QVRWindowConfig::initialPosition ( ) const

inline

Returns the initial position of this window on the screen ((-1,-1) for default).

initialSize()

QSize QVRWindowConfig::initialSize ( ) const

inline

Returns the initial size of this window on the screen.

observerIndex()

int QVRWindowConfig::observerIndex ( ) const

inline

Returns the index of the observer that views this window.

outputMode()

QVROutputMode QVRWindowConfig::outputMode ( ) const

inline

Returns the output mode of this window.

outputPlugin()

const QString & QVRWindowConfig::outputPlugin ( ) const

inline

Returns the output plugin specification of this window (may be empty).

renderResolutionFactor()

float QVRWindowConfig::renderResolutionFactor ( ) const

inline

Returns the render resolution factor.

A window can show scenes that were rendered at a different resolution than the actual window size. This is useful for example if a control window does not need to look good and can render at lower resolution to save time. The window size will be multiplied by this factor to get the resolution of the rendering textures. Example: a 800x600 window with a render resolution factor 0.5 will cause the application to render into a 400x300 texture which is then upscaled to 800x600 for display.

screenCenter()

const QVector3D & QVRWindowConfig::screenCenter ( ) const

inline

Returns the virtual world coordinates of the center of the screen wall.

screenCornerBottomLeft()

const QVector3D & QVRWindowConfig::screenCornerBottomLeft ( ) const

inline

Returns the virtual world coordinates of the bottom left corner of the screen wall.

screenCornerBottomRight()

const QVector3D & QVRWindowConfig::screenCornerBottomRight ( ) const

inline

Returns the virtual world coordinates of the bottom right corner of the screen wall.

screenCornerTopLeft()

const QVector3D & QVRWindowConfig::screenCornerTopLeft ( ) const

inline

Returns the virtual world coordinates of the top left corner of the screen wall.

screenIsFixedToObserver()

bool QVRWindowConfig::screenIsFixedToObserver ( ) const

inline

Returns whether the screen wall represented by this window is fixed to its observer.

screenIsGivenByCenter()

bool QVRWindowConfig::screenIsGivenByCenter ( ) const

inline

Returns whether the screen wall coordinates determined from its center or from three of its corners.

When determining screen wall coordinates from center coordinates, the Qt display screen dimensions are queried.

Friends And Related Symbol Documentation

QVRConfig

friend class QVRConfig

friend

---

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

• config.hpp