OIS::MouseState Struct Reference

#include <OISMouse.h>

Collaboration diagram for OIS::MouseState:

[legend]

List of all members.

Public Member Functions
	MouseState ()
bool	buttonDown (MouseButtonID button) const
	Button down test.
void	clear ()
	Clear all the values.
Public Attributes
int	width
int	height
Axis	X
	X Axis component.
Axis	Y
	Y Axis Component.
Axis	Z
	Z Axis Component.
int	buttons
	represents all buttons - bit position indicates button down

---

Detailed Description

Represents the state of the mouse All members are valid for both buffered and non buffered mode

Definition at line 41 of file OISMouse.h.

---

Constructor & Destructor Documentation

OIS::MouseState::MouseState

(

)

[inline]

Definition at line 43 of file OISMouse.h.

---

Member Function Documentation

bool OIS::MouseState::buttonDown

(

MouseButtonID

button

)

const [inline]

Button down test.

Definition at line 63 of file OISMouse.h.

void OIS::MouseState::clear

(

)

[inline]

Clear all the values.

Definition at line 69 of file OISMouse.h.

Referenced by OIS::Win32Mouse::_initialize(), OIS::SDLMouse::_initialize(), OIS::MacMouse::_initialize(), and OIS::LinuxMouse::_initialize().

---

Member Data Documentation

int OIS::MouseState::width [mutable]

Represents the height/width of your display area.. used if mouse clipping or mouse grabbed in case of X11 - defaults to 50.. Make sure to set this and change when your size changes..

Definition at line 43 of file OISMouse.h.

Referenced by OIS::LinuxMouse::_processXEvents(), OIS::Win32Mouse::capture(), and OIS::LinuxMouse::capture().

int OIS::MouseState::height [mutable]

Definition at line 43 of file OISMouse.h.

Referenced by OIS::LinuxMouse::_processXEvents(), OIS::Win32Mouse::capture(), and OIS::LinuxMouse::capture().

Axis OIS::MouseState::X

X Axis component.

Definition at line 51 of file OISMouse.h.

Referenced by OIS::Win32Mouse::capture(), OIS::LinuxMouse::capture(), handleNonBufferedMouse(), and EventHandler::mouseMoved().

Axis OIS::MouseState::Y

Y Axis Component.

Definition at line 54 of file OISMouse.h.

Referenced by OIS::Win32Mouse::capture(), OIS::LinuxMouse::capture(), handleNonBufferedMouse(), and EventHandler::mouseMoved().

Axis OIS::MouseState::Z

Z Axis Component.

Definition at line 57 of file OISMouse.h.

Referenced by OIS::LinuxMouse::_processXEvents(), OIS::Win32Mouse::capture(), OIS::LinuxMouse::capture(), handleNonBufferedMouse(), and EventHandler::mouseMoved().

int OIS::MouseState::buttons

represents all buttons - bit position indicates button down

Definition at line 60 of file OISMouse.h.

Referenced by OIS::Win32Mouse::_doMouseClick(), OIS::LinuxMouse::_processXEvents(), OIS::SDLMouse::capture(), and handleNonBufferedMouse().

---

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

• E:/Download/ois-1.0RC1/includes/OISMouse.h

---