Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::DisplaySettings Class Reference

DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing. More...

Inheritance diagram for osg::DisplaySettings:

Inheritance graph
[legend]
List of all members.

Public Types

enum  StereoMode { QUAD_BUFFER, ANAGLYPHIC, HORIZONTAL_SPLIT, VERTICAL_SPLIT }
enum  SplitStereoHorizontalEyeMapping { LEFT_EYE_LEFT_VIEWPORT, LEFT_EYE_RIGHT_VIEWPORT }
enum  SplitStereoVerticalEyeMapping { LEFT_EYE_TOP_VIEWPORT, LEFT_EYE_BOTTOM_VIEWPORT }

Public Methods

 DisplaySettings ()
 DisplaySettings (std::vector< std::string > &commandLine)
 DisplaySettings (const DisplaySettings &vs)
virtual ~DisplaySettings ()
DisplaySettings & operator= (const DisplaySettings &vs)
void merge (const DisplaySettings &vs)
void setDefaults ()
void readEnvironmentalVariables ()
void readCommandLine (std::vector< std::string > &commandLine)
 read the command line string list, removing any matched control sequences.

void setStereo (const bool on)
const bool getStereo () const
void setStereoMode (const StereoMode mode)
const StereoMode getStereoMode () const
void setEyeSeparation (const float eyeSeparation)
const float getEyeSeparation () const
void setScreenDistance (const float distance)
const float getScreenDistance () const
void setSplitStereoHorizontalEyeMapping (SplitStereoHorizontalEyeMapping m)
SplitStereoHorizontalEyeMapping getSplitStereoHorizontalEyeMapping () const
void setSplitStereoHorizontalSeparation (const int s)
const int getSplitStereoHorizontalSeparation () const
void setSplitStereoVerticalEyeMapping (SplitStereoVerticalEyeMapping m)
SplitStereoVerticalEyeMapping getSplitStereoVerticalEyeMapping () const
void setSplitStereoVerticalSeparation (const int s)
const int getSplitStereoVerticalSeparation () const
void setScreenHeight (const float height)
const float getScreenHeight () const
void setDoubleBuffer (const bool flag)
const bool getDoubleBuffer () const
void setRGB (const bool flag)
const bool getRGB () const
void setDepthBuffer (const bool flag)
const bool getDepthBuffer () const
void setMinimumNumAlphaBits (const unsigned int bits)
const unsigned int getMinimumNumAlphaBits () const
const bool getAlphaBuffer () const
void setMinimumNumStencilBits (const unsigned int bits)
const unsigned int getMinimumNumStencilBits () const
const bool getStencilBuffer () const
void setMaxNumberOfGraphicsContexts (const int num)
const int getMaxNumberOfGraphicsContexts () const

Static Public Methods

DisplaySettings * instance ()
 Maintain a DisplaySettings singleton for objects to querry at runtime.


Protected Methods

void copy (const DisplaySettings &vs)

Protected Attributes

bool _stereo
StereoMode _stereoMode
float _eyeSeparation
float _screenDistance
float _screenHeight
SplitStereoHorizontalEyeMapping _splitStereoHorizontalEyeMapping
int _splitStereoHorizontalSeparation
SplitStereoVerticalEyeMapping _splitStereoVerticalEyeMapping
int _splitStereoVerticalSeparation
bool _doubleBuffer
bool _RGB
bool _depthBuffer
unsigned int _minimumNumberAlphaBits
unsigned int _minimumNumberStencilBits
int _maxNumOfGraphicsContexts

Detailed Description

DisplaySettings class for encapsulating what visuals are required and have been set up, and the status of stereo viewing.


Member Enumeration Documentation

enum osg::DisplaySettings::SplitStereoHorizontalEyeMapping
 

Enumeration values:
LEFT_EYE_LEFT_VIEWPORT 
LEFT_EYE_RIGHT_VIEWPORT 

enum osg::DisplaySettings::SplitStereoVerticalEyeMapping
 

Enumeration values:
LEFT_EYE_TOP_VIEWPORT 
LEFT_EYE_BOTTOM_VIEWPORT 

enum osg::DisplaySettings::StereoMode
 

Enumeration values:
QUAD_BUFFER 
ANAGLYPHIC 
HORIZONTAL_SPLIT 
VERTICAL_SPLIT 


Constructor & Destructor Documentation

osg::DisplaySettings::DisplaySettings   [inline]
 

osg::DisplaySettings::DisplaySettings std::vector< std::string > &    commandLine [inline]
 

osg::DisplaySettings::DisplaySettings const DisplaySettings &    vs
 

virtual osg::DisplaySettings::~DisplaySettings   [virtual]
 


Member Function Documentation

void osg::DisplaySettings::copy const DisplaySettings &    vs [protected]
 

const bool osg::DisplaySettings::getAlphaBuffer   const [inline]
 

const bool osg::DisplaySettings::getDepthBuffer   const [inline]
 

const bool osg::DisplaySettings::getDoubleBuffer   const [inline]
 

const float osg::DisplaySettings::getEyeSeparation   const [inline]
 

const int osg::DisplaySettings::getMaxNumberOfGraphicsContexts   const [inline]
 

const unsigned int osg::DisplaySettings::getMinimumNumAlphaBits   const [inline]
 

const unsigned int osg::DisplaySettings::getMinimumNumStencilBits   const [inline]
 

const bool osg::DisplaySettings::getRGB   const [inline]
 

const float osg::DisplaySettings::getScreenDistance   const [inline]
 

const float osg::DisplaySettings::getScreenHeight   const [inline]
 

SplitStereoHorizontalEyeMapping osg::DisplaySettings::getSplitStereoHorizontalEyeMapping   const [inline]
 

const int osg::DisplaySettings::getSplitStereoHorizontalSeparation   const [inline]
 

SplitStereoVerticalEyeMapping osg::DisplaySettings::getSplitStereoVerticalEyeMapping   const [inline]
 

const int osg::DisplaySettings::getSplitStereoVerticalSeparation   const [inline]
 

const bool osg::DisplaySettings::getStencilBuffer   const [inline]
 

const bool osg::DisplaySettings::getStereo   const [inline]
 

const StereoMode osg::DisplaySettings::getStereoMode   const [inline]
 

DisplaySettings* osg::DisplaySettings::instance   [static]
 

Maintain a DisplaySettings singleton for objects to querry at runtime.

void osg::DisplaySettings::merge const DisplaySettings &    vs
 

DisplaySettings& osg::DisplaySettings::operator= const DisplaySettings &    vs
 

void osg::DisplaySettings::readCommandLine std::vector< std::string > &    commandLine
 

read the command line string list, removing any matched control sequences.

void osg::DisplaySettings::readEnvironmentalVariables  
 

void osg::DisplaySettings::setDefaults  
 

void osg::DisplaySettings::setDepthBuffer const bool    flag [inline]
 

void osg::DisplaySettings::setDoubleBuffer const bool    flag [inline]
 

void osg::DisplaySettings::setEyeSeparation const float    eyeSeparation [inline]
 

void osg::DisplaySettings::setMaxNumberOfGraphicsContexts const int    num [inline]
 

void osg::DisplaySettings::setMinimumNumAlphaBits const unsigned int    bits [inline]
 

void osg::DisplaySettings::setMinimumNumStencilBits const unsigned int    bits [inline]
 

void osg::DisplaySettings::setRGB const bool    flag [inline]
 

void osg::DisplaySettings::setScreenDistance const float    distance [inline]
 

void osg::DisplaySettings::setScreenHeight const float    height [inline]
 

void osg::DisplaySettings::setSplitStereoHorizontalEyeMapping SplitStereoHorizontalEyeMapping    m [inline]
 

void osg::DisplaySettings::setSplitStereoHorizontalSeparation const int    s [inline]
 

void osg::DisplaySettings::setSplitStereoVerticalEyeMapping SplitStereoVerticalEyeMapping    m [inline]
 

void osg::DisplaySettings::setSplitStereoVerticalSeparation const int    s [inline]
 

void osg::DisplaySettings::setStereo const bool    on [inline]
 

void osg::DisplaySettings::setStereoMode const StereoMode    mode [inline]
 


Member Data Documentation

bool osg::DisplaySettings::_depthBuffer [protected]
 

bool osg::DisplaySettings::_doubleBuffer [protected]
 

float osg::DisplaySettings::_eyeSeparation [protected]
 

int osg::DisplaySettings::_maxNumOfGraphicsContexts [protected]
 

unsigned int osg::DisplaySettings::_minimumNumberAlphaBits [protected]
 

unsigned int osg::DisplaySettings::_minimumNumberStencilBits [protected]
 

bool osg::DisplaySettings::_RGB [protected]
 

float osg::DisplaySettings::_screenDistance [protected]
 

float osg::DisplaySettings::_screenHeight [protected]
 

SplitStereoHorizontalEyeMapping osg::DisplaySettings::_splitStereoHorizontalEyeMapping [protected]
 

int osg::DisplaySettings::_splitStereoHorizontalSeparation [protected]
 

SplitStereoVerticalEyeMapping osg::DisplaySettings::_splitStereoVerticalEyeMapping [protected]
 

int osg::DisplaySettings::_splitStereoVerticalSeparation [protected]
 

bool osg::DisplaySettings::_stereo [protected]
 

StereoMode osg::DisplaySettings::_stereoMode [protected]
 


The documentation for this class was generated from the following file:
Generated at Wed Sep 18 13:55:27 2002 for the Open Scene Graph by doxygen 1.2.16.