glutio::CGlutIO Class Reference
[GLUT I/O module]

Encpasulates OpenGL context and interfaces with GLUT library. More...

#include <GlutIOModule.h>

Collaboration diagram for glutio::CGlutIO:

Collaboration graph
[legend]

List of all members.

Static Public Member Functions

Manipulators
static void init (bool bKeyboard=true, bool bMouse=false, bool bMotion=false, bool bPassiveMotion=false, bool bJoystick=false)
 Initializes GLUT window and OpenGL context.
static void mainLoop ()
 Starts GLUT event processing loop.
static int getWidth ()
 Gets current window width.
static int getHeight ()
 Gets curretn window height.
static void registerListenKeyboardCell (CListenKeyboard *pKb)
 Registers keyboard input callback.
static void registerListenMouseCell (CListenMouse *pMs, bool bClick=true, bool bMotion=false, bool bActiveMotion=false)
 Registers mouse input callback.
static void registerListenJoystickCell (CListenJoystick *pJs, int pollInterval)
 Registers joystick input callback.
Callbacks
static void displayCb (void)
 Display callback.
static void idleCb ()
 Idle callback.
static void reshapeCb (int width, int height)
 Reshape callback.
static void keyCb (unsigned char key, int x, int y)
 Keyboard key pressed callback.
static void specialKeyCb (int key, int x, int y)
 Keyboard special key pressed callback.
static void mouseCb (int button, int state, int x, int y)
 Mouse click event callback.
static void motionCb (int x, int y)
 Mouse potion callback.
static void passiveMotionCb (int x, int y)
 Mouse passive motion callback.
static void joystickCb (unsigned int buttonMask, int x, int y, int z)
 Joystick callback.

Creators

static CGlutIOgetInstance ()
static void deleteInstance ()
 ~CGlutIO ()
 Destructor.


Detailed Description

Encpasulates OpenGL context and interfaces with GLUT library.

Follows the Singleton pattern


Constructor & Destructor Documentation

glutio::CGlutIO::~CGlutIO (  )  [inline]

Destructor.


Member Function Documentation

static void glutio::CGlutIO::deleteInstance (  )  [inline, static]

void CGlutIO::displayCb ( void   )  [static]

Display callback.

The display callback must be bound; really nothing general to do here.

..

static int glutio::CGlutIO::getHeight (  )  [inline, static]

Gets curretn window height.

static CGlutIO* glutio::CGlutIO::getInstance (  )  [inline, static]

static int glutio::CGlutIO::getWidth (  )  [inline, static]

Gets current window width.

void CGlutIO::idleCb (  )  [static]

Idle callback.

Forces the main thread to go to sleep so the GLUT main loop does not eat up all the CPU.

void CGlutIO::init ( bool  bKeyboard = true,
bool  bMouse = false,
bool  bMotion = false,
bool  bPassiveMotion = false,
bool  bJoystick = false 
) [static]

Initializes GLUT window and OpenGL context.

void CGlutIO::joystickCb ( unsigned int  buttonMask,
int  x,
int  y,
int  z 
) [static]

Joystick callback.

If a joystick input cell is bound, creates a joystick state node and puts it on the active stream.

void CGlutIO::keyCb ( unsigned char  key,
int  x,
int  y 
) [static]

Keyboard key pressed callback.

If a keyboard input cell is bound, creates a keyboard event node and puts it on the active stream.

static void glutio::CGlutIO::mainLoop (  )  [inline, static]

Starts GLUT event processing loop.

void CGlutIO::motionCb ( int  x,
int  y 
) [static]

Mouse potion callback.

If a mouse input cell is bound, creates a mouse event node and puts it on the active stream.

void CGlutIO::mouseCb ( int  button,
int  state,
int  x,
int  y 
) [static]

Mouse click event callback.

If a mouse input cell is bound, creates a mouse event node and puts it on the active stream.

void CGlutIO::passiveMotionCb ( int  x,
int  y 
) [static]

Mouse passive motion callback.

If a mouse input cell is bound, creates a mouse event node and puts it on the active stream.

void CGlutIO::registerListenJoystickCell ( CListenJoystick pJs,
int  pollInterval 
) [static]

Registers joystick input callback.

void CGlutIO::registerListenKeyboardCell ( CListenKeyboard pKb  )  [static]

Registers keyboard input callback.

void CGlutIO::registerListenMouseCell ( CListenMouse pMs,
bool  bClick = true,
bool  bMotion = false,
bool  bActiveMotion = false 
) [static]

Registers mouse input callback.

void CGlutIO::reshapeCb ( int  width,
int  height 
) [static]

Reshape callback.

Updates window width and height member variable.

void CGlutIO::specialKeyCb ( int  specialKey,
int  x,
int  y 
) [static]

Keyboard special key pressed callback.

If a keyboard input cell is bound, creates a keyboard event node and puts it on the active stream.


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

Generated on Thu Oct 21 12:39:20 2010 for MFSM Modules by  doxygen 1.5.9