AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

animal::MouseEvent Class Reference

#include <mouseEvent.h>

Inheritance diagram for animal::MouseEvent:

List of all members.

---

Detailed Description

The AnimalMouseEvent class describes a mouse event.

Definition at line 15 of file mouseEvent.h.

Public Member Functions
	MouseEvent (TypeInt type, int x, int y, ButtonStateInt button, ButtonStateInt state, Vec3 origine, Vec3 direction)
	Constructor. The x and y parameters specifie the position relative to the receiving widget.
virtual	~MouseEvent ()
	Destructor.
int	x () const
	Return the x-position of the mouse pointer, relative to the widget that received the event.
int	y () const
	Return the y-position of the mouse pointer, relative to the widget that received the event.
ButtonStateInt	button ()
	Return the button ( animal::ButtonState) that caused the event.
bool	isAccepted () const
	Return TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE.
void	accept ()
	Set the member AnimalKeyEvent::_accepted to true.
void	ignore ()
	Set the member AnimalKeyEvent::_accepted to false.
Vec3	pickingOrigine ()
	Get the picking origine.
Vec3	pickingDirection ()
	Get the picking direction.
Protected Attributes
bool	_accepted
int	_x
int	_y
ButtonStateInt	_button
Vec3	_pickingOrigine
Vec3	_pickingDirection

---

Constructor & Destructor Documentation

animal::MouseEvent::MouseEvent (  TypeInt  type, int  x, int  y, ButtonStateInt  button, ButtonStateInt  state, Vec3  origine, Vec3  direction )  [inline]

Constructor. The x and y parameters specifie the position relative to the receiving widget. Definition at line 19 of file mouseEvent.h. References _button, _pickingDirection, _pickingOrigine, _x, and _y.

virtual animal::MouseEvent::~MouseEvent (   )  [inline, virtual]

Destructor. Definition at line 30 of file mouseEvent.h.

---

Member Function Documentation

void animal::MouseEvent::accept (   )  [inline]

Set the member AnimalKeyEvent::_accepted to true. Definition at line 45 of file mouseEvent.h.

ButtonStateInt animal::MouseEvent::button (   )  [inline]

Return the button ( animal::ButtonState) that caused the event. Definition at line 39 of file mouseEvent.h. References _button.

void animal::MouseEvent::ignore (   )  [inline]

Set the member AnimalKeyEvent::_accepted to false. Definition at line 48 of file mouseEvent.h.

bool animal::MouseEvent::isAccepted (   )  const [inline]

Return TRUE if the receiver of the event wants to keep the key; otherwise returns FALSE. Definition at line 42 of file mouseEvent.h.

Vec3 animal::MouseEvent::pickingDirection (   )  [inline]

Get the picking direction. Definition at line 57 of file mouseEvent.h. References _pickingDirection.

Vec3 animal::MouseEvent::pickingOrigine (   )  [inline]

Get the picking origine. Definition at line 51 of file mouseEvent.h. References _pickingOrigine.

int animal::MouseEvent::x (   )  const [inline]

Return the x-position of the mouse pointer, relative to the widget that received the event. Definition at line 33 of file mouseEvent.h. References _x.

int animal::MouseEvent::y (   )  const [inline]

Return the y-position of the mouse pointer, relative to the widget that received the event. Definition at line 36 of file mouseEvent.h. References _y.

---

Member Data Documentation

bool animal::MouseEvent::_accepted [protected]

Definition at line 63 of file mouseEvent.h.

ButtonStateInt animal::MouseEvent::_button [protected]

Definition at line 66 of file mouseEvent.h. Referenced by button(), and MouseEvent().

Vec3 animal::MouseEvent::_pickingDirection [protected]

Definition at line 68 of file mouseEvent.h. Referenced by MouseEvent(), and pickingDirection().

Vec3 animal::MouseEvent::_pickingOrigine [protected]

Definition at line 67 of file mouseEvent.h. Referenced by MouseEvent(), and pickingOrigine().

int animal::MouseEvent::_x [protected]

Definition at line 64 of file mouseEvent.h. Referenced by MouseEvent(), and x().

int animal::MouseEvent::_y [protected]

Definition at line 65 of file mouseEvent.h. Referenced by MouseEvent(), and y().

---

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

• mouseEvent.h

---