diguyPluginMouseEvent Class Reference

#include <diguyPluginMouseEvent.h>

Public Types
enum	{   BUTTON_STATE_LEFT = 0x0001, BUTTON_STATE_RIGHT = 0x0002, BUTTON_STATE_MIDDLE = 0x0004, BUTTON_STATE_SHIFT = 0x0008,   BUTTON_STATE_CTRL = 0x0010, BUTTON_STATE_ALT = 0x0020 }
	This is an enumeration of the different button states reported by get_button_state(). More...

Public Member Functions
diguyView *	get_view ()
	This function returns the view in which the mouse event took place. More...
int	get_x ()
	This function returns the screen x coordinate at which the mouse event took place. More...
int	get_y ()
	This function returns the screen y coordinate at which the mouse event took place. More...
int	get_button_state ()
	This function returns state of the mouse buttons when the mouse event took place. More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
diguyView *	m_view
int	m_x
int	m_y
int	m_button_state
class	bdiScenarioPlugin
class	bdiScenarioEditor
	diguyPluginMouseEvent (diguyView *view, int x, int y, int button_state)
	~diguyPluginMouseEvent ()

Member Enumeration Documentation

anonymous enum

This is an enumeration of the different button states reported by get_button_state().

The values may be OR-ed together. e.g., the value 0x21 would indicate that the left mouse button was clicked while the ALT was down.

Usable From:

• C++
• Script

Enumerator
BUTTON_STATE_LEFT
BUTTON_STATE_RIGHT
BUTTON_STATE_MIDDLE
BUTTON_STATE_SHIFT
BUTTON_STATE_CTRL
BUTTON_STATE_ALT

Constructor & Destructor Documentation

diguyPluginMouseEvent::diguyPluginMouseEvent	(	diguyView *	view,
		int	x,
		int	y,
		int	button_state
	)

diguyPluginMouseEvent::~diguyPluginMouseEvent

(

)

Member Function Documentation

diguyView* diguyPluginMouseEvent::get_view

(

)

This function returns the view in which the mouse event took place.

Returns:

object of type diguyView

Callable From:

• C++

int diguyPluginMouseEvent::get_x

(

)

This function returns the screen x coordinate at which the mouse event took place.

Returns:

screen x coordinate

Callable From:

• C++

int diguyPluginMouseEvent::get_y

(

)

This function returns the screen y coordinate at which the mouse event took place.

Returns:

screen y coordinate

Callable From:

• C++

int diguyPluginMouseEvent::get_button_state

(

)

This function returns state of the mouse buttons when the mouse event took place.

Refer to the enumeration above for possible values.

Returns:

OR-ed together state of mouse buttons

Callable From:

• C++

Friends And Related Function Documentation

friend class bdiScenarioPlugin

friend

friend class bdiScenarioEditor

friend

Member Data Documentation

diguyView* diguyPluginMouseEvent::m_view

private

int diguyPluginMouseEvent::m_x

private

int diguyPluginMouseEvent::m_y

private

int diguyPluginMouseEvent::m_button_state

private

---

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

• E:/nightly/2751/include/diguyPluginMouseEvent.h