glutio::CKeyboardEvent Class Reference
[GLUT I/O module]
Keyboard event node.
More...
#include <GlutIOModule.h>
Inherits fsf::CNode.
Collaboration diagram for glutio::CKeyboardEvent:
Public Member Functions | |
Creators | |
| CKeyboardEvent () | |
| Default constructor. | |
| CKeyboardEvent (fsf::CNode *pParent, fsf::Time tTime=0) | |
| 2-parameter constructor: parent and time stamp | |
| CKeyboardEvent (std::string &strName, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 3-parameter constructor: node name, parent and time stamp | |
| CKeyboardEvent (unsigned char key, int modif, int x, int y, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 6-parameter initialization constructor | |
| CKeyboardEvent (std::string &strName, unsigned char key, int modif, int x, int y, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 7-parameter initialization constructor | |
| CKeyboardEvent (int special, int modif, int x, int y, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 6-parameter initialization constructor | |
| CKeyboardEvent (std::string &strName, int special, int modif, int x, int y, fsf::CNode *pParent=NULL, fsf::Time tTime=0) | |
| 7-parameter initialization constructor | |
| CKeyboardEvent (const CKeyboardEvent &rhs) | |
| Copy constructor. | |
| virtual fsf::CNode * | clone () const |
Manipulators | |
| CKeyboardEvent & | operator= (const CKeyboardEvent &) |
| Assignment operator. | |
| void | setKey (unsigned char key) |
| Sets key value. | |
| void | setSpecial (int special) |
| Sets special character value. | |
| void | setModifier (int modif) |
| Sets modifier value. | |
| 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). | |
| bool | isSpecial () |
Returns true if the event was generated by a special key. | |
Accessors | |
| virtual void | getTypeID (std::string &str) const |
| Gets this node's factory mapping key. | |
| unsigned char | getKey () const |
| Gets key value. | |
| int | getSpecial () const |
| Gets special key value. | |
| int | getModifier () const |
| Gets modifier value. | |
| 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
Keyboard event node.Handles both ASCII characters and special keys
Constructor & Destructor Documentation
| glutio::CKeyboardEvent::CKeyboardEvent | ( | ) | [inline] |
Default constructor.
| glutio::CKeyboardEvent::CKeyboardEvent | ( | fsf::CNode * | pParent, | |
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
2-parameter constructor: parent and time stamp
| glutio::CKeyboardEvent::CKeyboardEvent | ( | std::string & | strName, | |
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
3-parameter constructor: node name, parent and time stamp
| glutio::CKeyboardEvent::CKeyboardEvent | ( | unsigned char | key, | |
| int | modif, | |||
| int | x, | |||
| int | y, | |||
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
6-parameter initialization constructor
| glutio::CKeyboardEvent::CKeyboardEvent | ( | std::string & | strName, | |
| unsigned char | key, | |||
| int | modif, | |||
| int | x, | |||
| int | y, | |||
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
7-parameter initialization constructor
| glutio::CKeyboardEvent::CKeyboardEvent | ( | int | special, | |
| int | modif, | |||
| int | x, | |||
| int | y, | |||
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
6-parameter initialization constructor
| glutio::CKeyboardEvent::CKeyboardEvent | ( | std::string & | strName, | |
| int | special, | |||
| int | modif, | |||
| int | x, | |||
| int | y, | |||
| fsf::CNode * | pParent = NULL, |
|||
| fsf::Time | tTime = 0 | |||
| ) | [inline] |
7-parameter initialization constructor
| glutio::CKeyboardEvent::CKeyboardEvent | ( | const CKeyboardEvent & | rhs | ) | [inline] |
Copy constructor.
Member Function Documentation
| virtual fsf::CNode* glutio::CKeyboardEvent::clone | ( | ) | const [inline, virtual] |
Reimplemented from fsf::CNode.
| unsigned char glutio::CKeyboardEvent::getKey | ( | ) | const [inline] |
Gets key value.
| int glutio::CKeyboardEvent::getModifier | ( | ) | const [inline] |
Gets modifier value.
| int glutio::CKeyboardEvent::getSpecial | ( | ) | const [inline] |
Gets special key value.
| virtual void glutio::CKeyboardEvent::getTypeID | ( | std::string & | str | ) | const [inline, virtual] |
| int glutio::CKeyboardEvent::getX | ( | ) | const [inline] |
Gets X coordinate of mouse pointer position (in window coordinates).
| int glutio::CKeyboardEvent::getY | ( | ) | const [inline] |
Gets y coordinate of mouse pointer position (in window coordinates).
| bool glutio::CKeyboardEvent::isSpecial | ( | ) | [inline] |
Returns true if the event was generated by a special key.
| CKeyboardEvent & CKeyboardEvent::operator= | ( | const CKeyboardEvent & | rhs | ) |
Assignment operator.
| void glutio::CKeyboardEvent::setKey | ( | unsigned char | key | ) | [inline] |
Sets key value.
| void glutio::CKeyboardEvent::setModifier | ( | int | modif | ) | [inline] |
Sets modifier value.
| void glutio::CKeyboardEvent::setSpecial | ( | int | special | ) | [inline] |
Sets special character value.
| void glutio::CKeyboardEvent::setX | ( | int | x | ) | [inline] |
Sets X coordinate of mouse pointer position (in window coordinates).
| void glutio::CKeyboardEvent::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:
