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

Ogre::MouseState Struct Reference

Structure representing a snapshot of the state of the mouse input controller. More...

#include <OgreInput.h>

List of all members.

Public Methods

long isButtonDown (uchar button) const
 Retrieves the pressed state of a mouse button.


Public Attributes

long Xabs
 Absolute position of the mouse pointer.

long Yabs
 Absolute position of the mouse pointer.

long Zabs
 Absolute position of the mouse pointer.

long Xrel
 Relative position of the mouse pointer.

long Yrel
 Relative position of the mouse pointer.

long Zrel
 Relative position of the mouse pointer.

long Buttons
 The buttons that have been pressed.

Detailed Description

Structure representing a snapshot of the state of the mouse input controller.

Definition at line 190 of file OgreInput.h.

Member Function Documentation

long Ogre::MouseState::isButtonDown (  uchar    button )  const
 

Retrieves the pressed state of a mouse button.

Definition at line 201 of file OgreInput.h.

References Ogre::uchar.

Referenced by Ogre::Win32Input8::getMouseButton(), and Ogre::SDLInput::getMouseButton().

Member Data Documentation

long Ogre::MouseState::Buttons
 

The buttons that have been pressed.

Each bit maps to a mouse button.

Definition at line 198 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), and Ogre::Win32Input8::captureMouse().

long Ogre::MouseState::Xabs
 

Absolute position of the mouse pointer.

Definition at line 193 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), Ogre::Win32Input8::captureMouse(), and Ogre::Win32Input8::getMouseAbsX().

long Ogre::MouseState::Xrel
 

Relative position of the mouse pointer.

Definition at line 195 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseRelX(), and Ogre::Win32Input8::initialiseImmediateMouse().

long Ogre::MouseState::Yabs
 

Absolute position of the mouse pointer.

Definition at line 193 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), Ogre::Win32Input8::captureMouse(), and Ogre::Win32Input8::getMouseAbsY().

long Ogre::MouseState::Yrel
 

Relative position of the mouse pointer.

Definition at line 195 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseRelY(), and Ogre::Win32Input8::initialiseImmediateMouse().

long Ogre::MouseState::Zabs
 

Absolute position of the mouse pointer.

Definition at line 193 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), Ogre::Win32Input8::captureMouse(), and Ogre::Win32Input8::getMouseAbsZ().

long Ogre::MouseState::Zrel
 

Relative position of the mouse pointer.

Definition at line 195 of file OgreInput.h.

Referenced by Ogre::SDLInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseRelZ(), and Ogre::Win32Input8::initialiseImmediateMouse().

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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:18:38 2004