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

Mouse event node. More...

#include <GlutIOModule.h>

Inherits fsf::CNode.

Collaboration diagram for glutio::CMouseEvent:

Collaboration graph
[legend]

List of all members.

Public Member Functions

Creators
 CMouseEvent ()
 Default constructor.
 CMouseEvent (fsf::CNode *pParent, fsf::Time tTime=0)
 2-parameter constructor: parent and time stamp
 CMouseEvent (std::string &strName, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
 3-parameter constructor: noide name, parent and time stamp
 CMouseEvent (int button, int state, int x, int y, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
 6-parameter initialization constructor
 CMouseEvent (std::string &strName, int button, int state, int x, int y, fsf::CNode *pParent=NULL, fsf::Time tTime=0)
 7-parameter initialization constructor
 CMouseEvent (const CMouseEvent &rhs)
 Copy constructor.
Manipulators
CMouseEventoperator= (const CMouseEvent &)
 Assignment operator.
void setButton (int button)
 Sets button ID value.
void setState (int state)
 Sets button state.
void setX (int x)
 Sets X coordinate of mouse pointer position (in window coordinates).
void setY (int y)
 Sets Y coordinate of mouse pointer position (in window coordinates).
Accessors
virtual fsf::CNodeclone () const
 Cloning: necessary for run-time polymorphism.
virtual void getTypeID (std::string &str) const
 Gets this node's factory mapping key.
int getButton () const
 Gets button ID value.
int getState () const
 Gets button state.
int getX () const
 Gets X coordinate of mouse pointer position (in window coordinates).
int getY () const
 Gets Y coordinate of mouse pointer position (in window coordinates).


Detailed Description

Mouse event node.

Constructor & Destructor Documentation

glutio::CMouseEvent::CMouseEvent (  )  [inline]

Default constructor.

glutio::CMouseEvent::CMouseEvent ( fsf::CNode pParent,
fsf::Time  tTime = 0 
) [inline]

2-parameter constructor: parent and time stamp

glutio::CMouseEvent::CMouseEvent ( std::string &  strName,
fsf::CNode pParent = NULL,
fsf::Time  tTime = 0 
) [inline]

3-parameter constructor: noide name, parent and time stamp

glutio::CMouseEvent::CMouseEvent ( int  button,
int  state,
int  x,
int  y,
fsf::CNode pParent = NULL,
fsf::Time  tTime = 0 
) [inline]

6-parameter initialization constructor

glutio::CMouseEvent::CMouseEvent ( std::string &  strName,
int  button,
int  state,
int  x,
int  y,
fsf::CNode pParent = NULL,
fsf::Time  tTime = 0 
) [inline]

7-parameter initialization constructor

glutio::CMouseEvent::CMouseEvent ( const CMouseEvent rhs  )  [inline]

Copy constructor.


Member Function Documentation

virtual fsf::CNode* glutio::CMouseEvent::clone (  )  const [inline, virtual]

Cloning: necessary for run-time polymorphism.

Reimplemented from fsf::CNode.

int glutio::CMouseEvent::getButton (  )  const [inline]

Gets button ID value.

int glutio::CMouseEvent::getState (  )  const [inline]

Gets button state.

virtual void glutio::CMouseEvent::getTypeID ( std::string &  str  )  const [inline, virtual]

Gets this node's factory mapping key.

Reimplemented from fsf::CNode.

int glutio::CMouseEvent::getX (  )  const [inline]

Gets X coordinate of mouse pointer position (in window coordinates).

int glutio::CMouseEvent::getY (  )  const [inline]

Gets Y coordinate of mouse pointer position (in window coordinates).

CMouseEvent & CMouseEvent::operator= ( const CMouseEvent rhs  ) 

Assignment operator.

void glutio::CMouseEvent::setButton ( int  button  )  [inline]

Sets button ID value.

void glutio::CMouseEvent::setState ( int  state  )  [inline]

Sets button state.

void glutio::CMouseEvent::setX ( int  x  )  [inline]

Sets X coordinate of mouse pointer position (in window coordinates).

void glutio::CMouseEvent::setY ( int  y  )  [inline]

Sets Y coordinate of mouse pointer position (in window coordinates).


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