gramods::gmGraphics::Eye Struct Reference

An indexed eye that can be rendered. More...

#include <Eye.hh>

Collaboration diagram for gramods::gmGraphics::Eye:

Public Member Functions
void	validate ()
	Check if the internal states are valid and throw exception if idx is not smaller than count. More...
bool	valid ()
	Returns true iff idx is smaller than count. More...
bool	operator< (const gramods::gmGraphics::Eye &e2) const
	Less than operator, returns true if this has lower count or lower idx than the other. More...
bool	operator== (const gramods::gmGraphics::Eye &e2) const
	Equals operator, returns true if this is identical to the other. More...

Public Attributes
size_t	idx
	The index of the specific eye, starting at zero (0). More...
size_t	count
	The total count of eyes of which the specified eye is one. More...

Static Public Attributes
static const Eye	MONO = { 0, 1 }
	Pre-defined Eye for monoscopic rendering. More...
static const Eye	LEFT = { 0, 2 }
	Pre-defined left Eye for stereoscopic rendering. More...
static const Eye	RIGHT = { 1, 2 }
	Pre-defined right Eye for stereoscopic rendering. More...

Detailed Description

An indexed eye that can be rendered.

See also

StereoscopicView

StereoscopicMultiplexer

Camera

Member Function Documentation

operator<()

bool gramods::gmGraphics::Eye::operator< ( const gramods::gmGraphics::Eye &  e2 ) const

inline

Less than operator, returns true if this has lower count or lower idx than the other.

operator==()

bool gramods::gmGraphics::Eye::operator== ( const gramods::gmGraphics::Eye &  e2 ) const

inline

Equals operator, returns true if this is identical to the other.

valid()

bool gramods::gmGraphics::Eye::valid ( )

inline

Returns true iff idx is smaller than count.

validate()

void gramods::gmGraphics::Eye::validate ( )

inline

Check if the internal states are valid and throw exception if idx is not smaller than count.

This may be called by any method that takes an Eye as an argument.

Member Data Documentation

count

size_t gramods::gmGraphics::Eye::count

The total count of eyes of which the specified eye is one.

idx

size_t gramods::gmGraphics::Eye::idx

The index of the specific eye, starting at zero (0).

LEFT

const Eye gramods::gmGraphics::Eye::LEFT = { 0, 2 }

static

Pre-defined left Eye for stereoscopic rendering.

MONO

const Eye gramods::gmGraphics::Eye::MONO = { 0, 1 }

static

Pre-defined Eye for monoscopic rendering.

RIGHT

const Eye gramods::gmGraphics::Eye::RIGHT = { 1, 2 }

static

Pre-defined right Eye for stereoscopic rendering.

---

The documentation for this struct was generated from the following files:

• /home/karlu/private/program/gramods/modules/gmGraphics/include/gmGraphics/Eye.hh
• /home/karlu/private/program/gramods/modules/gmGraphics/src/Eye.cpp