Isle
Loading...
Searching...
No Matches
LegoMouseController Class Reference

[AI] Handles mouse input relevant to camera or entity control. More...

#include <legopointofviewcontroller.h>

Inheritance diagram for LegoMouseController:
Collaboration diagram for LegoMouseController:

Public Member Functions

 LegoMouseController ()
 [AI] Constructor initializing state of mouse button. [AI] More...
 
 ~LegoMouseController () override
 [AI] Destructor for mouse controller. [AI] More...
 
virtual void LeftDown (int, int)
 [AI] Invoked when the left mouse button is pressed. More...
 
virtual void LeftDrag (int, int)
 [AI] Invoked as the mouse drags while the left button is held. More...
 
virtual void LeftUp (int, int)
 [AI] Invoked when the left mouse button is released. More...
 
virtual void RightDown (int, int)
 [AI] Invoked when the right mouse button is pressed. More...
 
virtual void RightDrag (int, int)
 [AI] Invoked as the mouse drags while the right button is held. More...
 
virtual void RightUp (int, int)
 [AI] Invoked when the right mouse button is released. More...
 
BOOL GetIsButtonDown ()
 [AI] Returns whether any mouse button is currently in the 'down' state. More...
 
MxDouble GetButtonX ()
 [AI] Returns the X coordinate where the last mouse button event occurred. More...
 
MxDouble GetButtonY ()
 [AI] Returns the Y coordinate where the last mouse button event occurred. More...
 
- Public Member Functions inherited from MxCore
 MxCore ()
 [AI] Constructs a new MxCore object and assigns it a unique id. More...
 
virtual ~MxCore ()
 [AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More...
 
virtual MxLong Notify (MxParam &p_param)
 [AI] Virtual callback notification mechanism. More...
 
virtual MxResult Tickle ()
 [AI] Called by tickle managers to allow the object to update itself. More...
 
virtual const char * ClassName () const
 [AI] Returns the runtime class name of this object. More...
 
virtual MxBool IsA (const char *p_name) const
 [AI] Checks whether this object's class type or parents match the given name. More...
 
MxU32 GetId ()
 [AI] Gets the unique (per-process) id assigned to this object instance. More...
 

Detailed Description

[AI] Handles mouse input relevant to camera or entity control.

[AI]

[AI] LegoMouseController processes mouse button presses, drags, and releases for the left and right mouse buttons, maintaining the pressed state and the position at which the mouse was last pressed. It is designed as a base class for more specific controllers, such as LegoPointOfViewController. [AI]

Definition at line 26 of file legopointofviewcontroller.h.

Constructor & Destructor Documentation

◆ LegoMouseController()

LegoMouseController::LegoMouseController ( )

[AI] Constructor initializing state of mouse button. [AI]

Definition at line 23 of file legopovcontroller.cpp.

◆ ~LegoMouseController()

LegoMouseController::~LegoMouseController ( )
override

[AI] Destructor for mouse controller. [AI]

Definition at line 29 of file legopovcontroller.cpp.

Member Function Documentation

◆ GetButtonX()

MxDouble LegoMouseController::GetButtonX ( )
inline

[AI] Returns the X coordinate where the last mouse button event occurred.

[AI]

Definition at line 81 of file legopointofviewcontroller.h.

◆ GetButtonY()

MxDouble LegoMouseController::GetButtonY ( )
inline

[AI] Returns the Y coordinate where the last mouse button event occurred.

[AI]

Definition at line 86 of file legopointofviewcontroller.h.

◆ GetIsButtonDown()

BOOL LegoMouseController::GetIsButtonDown ( )
inline

[AI] Returns whether any mouse button is currently in the 'down' state.

[AI]

Definition at line 76 of file legopointofviewcontroller.h.

◆ LeftDown()

void LegoMouseController::LeftDown ( int  p_x,
int  p_y 
)
virtual

[AI] Invoked when the left mouse button is pressed.

[AI]

Parameters
x[AI] X coordinate in screen space. [AI]
y[AI] Y coordinate in screen space. [AI]

Reimplemented in LegoPointOfViewController.

Definition at line 34 of file legopovcontroller.cpp.

◆ LeftDrag()

void LegoMouseController::LeftDrag ( int  p_x,
int  p_y 
)
virtual

[AI] Invoked as the mouse drags while the left button is held.

[AI]

Parameters
x[AI] Current X coordinate. [AI]
y[AI] Current Y coordinate. [AI]

Reimplemented in LegoPointOfViewController.

Definition at line 50 of file legopovcontroller.cpp.

◆ LeftUp()

void LegoMouseController::LeftUp ( int  p_x,
int  p_y 
)
virtual

[AI] Invoked when the left mouse button is released.

[AI]

Parameters
x[AI] X coordinate where the button was released. [AI]
y[AI] Y coordinate where the button was released. [AI]

Reimplemented in LegoPointOfViewController.

Definition at line 42 of file legopovcontroller.cpp.

◆ RightDown()

void LegoMouseController::RightDown ( int  p_x,
int  p_y 
)
virtual

[AI] Invoked when the right mouse button is pressed.

[AI]

Parameters
x[AI] X coordinate in screen space. [AI]
y[AI] Y coordinate in screen space. [AI]

Reimplemented in LegoPointOfViewController.

Definition at line 57 of file legopovcontroller.cpp.

◆ RightDrag()

void LegoMouseController::RightDrag ( int  p_x,
int  p_y 
)
virtual

[AI] Invoked as the mouse drags while the right button is held.

[AI]

Parameters
x[AI] Current X coordinate. [AI]
y[AI] Current Y coordinate. [AI]

Reimplemented in LegoPointOfViewController.

Definition at line 73 of file legopovcontroller.cpp.

◆ RightUp()

void LegoMouseController::RightUp ( int  p_x,
int  p_y 
)
virtual

[AI] Invoked when the right mouse button is released.

[AI]

Parameters
x[AI] X coordinate where the button was released. [AI]
y[AI] Y coordinate where the button was released. [AI]

Reimplemented in LegoPointOfViewController.

Definition at line 65 of file legopovcontroller.cpp.


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