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(), Ogre::SDLInput::getMouseButton(), and Ogre::GLXInput::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(), Ogre::GLXInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::GLXInput::initialise(), and Ogre::InputReader::triggerMouseButton().

long Ogre::MouseState::Xabs

| Absolute position of the mouse pointer. Definition at line 193 of file OgreInput.h. Referenced by Ogre::SDLInput::capture(), Ogre::GLXInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseAbsX(), Ogre::GLXInput::getMouseAbsX(), Ogre::GLXInput::GrabCursor(), and Ogre::GLXInput::initialise().

long Ogre::MouseState::Xrel

| Relative position of the mouse pointer. Definition at line 195 of file OgreInput.h. Referenced by Ogre::SDLInput::capture(), Ogre::GLXInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseRelX(), Ogre::SDLInput::getMouseRelX(), Ogre::GLXInput::getMouseRelX(), Ogre::GLXInput::initialise(), 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::GLXInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseAbsY(), Ogre::GLXInput::getMouseAbsY(), Ogre::GLXInput::GrabCursor(), and Ogre::GLXInput::initialise().

long Ogre::MouseState::Yrel

| Relative position of the mouse pointer. Definition at line 195 of file OgreInput.h. Referenced by Ogre::SDLInput::capture(), Ogre::GLXInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseRelY(), Ogre::SDLInput::getMouseRelY(), Ogre::GLXInput::getMouseRelY(), Ogre::GLXInput::initialise(), 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(), Ogre::Win32Input8::getMouseAbsZ(), Ogre::GLXInput::getMouseAbsZ(), and Ogre::GLXInput::initialise().

long Ogre::MouseState::Zrel

| Relative position of the mouse pointer. Definition at line 195 of file OgreInput.h. Referenced by Ogre::SDLInput::capture(), Ogre::GLXInput::capture(), Ogre::Win32Input8::captureMouse(), Ogre::Win32Input8::getMouseRelZ(), Ogre::SDLInput::getMouseRelZ(), Ogre::GLXInput::getMouseRelZ(), Ogre::GLXInput::initialise(), and Ogre::Win32Input8::initialiseImmediateMouse().

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

- OgreInput.h

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:16 2004