IMouseInputCollector Interface Reference

Collects player-related inputs from a mouse. More...

Inheritance diagram for IMouseInputCollector:

Public Member Functions
float2	GetDeltaDegrees ()
	Gets the mouse delta in screen degrees. This delta is the same regardless of the screen size.
bool	GetLeftButtonPress ()
	Gets the left mouse button click state.
bool	GetLeftButtonWasPressed ()
	Gets the left mouse button was pressed state.
bool	GetLeftButtonWasReleased ()
	Gets the left mouse button release after pressed.
bool	GetRightButtonPress ()
	Gets the right mouse button click state.
bool	GetRightButtonWasPressed ()
	Gets the right mouse button was pressed state.
bool	GetRightButtonWasReleased ()
	Gets the right mouse button release after pressed.
Public Member Functions inherited from IInputCollector
void	Enable ()
	Enable the input collector, prompting it to set up and enable appropriate input actions.

Additional Inherited Members
Properties inherited from IInputCollector
bool	IsEnabled [get]
	True if the input collector has been enabled.

Detailed Description

Collects player-related inputs from a mouse.

Member Function Documentation

GetDeltaDegrees()

float2 GetDeltaDegrees

(

)

Gets the mouse delta in screen degrees. This delta is the same regardless of the screen size.

Implemented in MouseInputCollector.

GetLeftButtonPress()

bool GetLeftButtonPress

(

)

Gets the left mouse button click state.

Implemented in MouseInputCollector.

GetLeftButtonWasPressed()

bool GetLeftButtonWasPressed

(

)

Gets the left mouse button was pressed state.

Implemented in MouseInputCollector.

GetLeftButtonWasReleased()

bool GetLeftButtonWasReleased

(

)

Gets the left mouse button release after pressed.

Implemented in MouseInputCollector.

GetRightButtonPress()

bool GetRightButtonPress

(

)

Gets the right mouse button click state.

Implemented in MouseInputCollector.

GetRightButtonWasPressed()

bool GetRightButtonWasPressed

(

)

Gets the right mouse button was pressed state.

Implemented in MouseInputCollector.

GetRightButtonWasReleased()

bool GetRightButtonWasReleased

(

)

Gets the right mouse button release after pressed.

Implemented in MouseInputCollector.

---

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

• Runtime/Input/Collectors/MouseInputCollector.cs