Gorgon Game Engine
Gorgon::Input::Mouse Namespace Reference

Enumerations

enum  Button {
  None, Left, Right, Middle,
  X1, X2, X3, X4,
  X5, X6, All
}
 Lists the mouse button constants. More...
 
enum  EventType {
  HitCheck, Over, Move, MovePressed,
  Out, Down, DownPressed, Click,
  Up, Scroll_Vert, Scroll_Hor, Zoom,
  Rotate
}
 The type of a mouse event. More...
 
enum  ScrollType { Vertical, Horizontal, Zoom }
 

Functions

 DefineEnumStrings (Button, {Button::Left, "Left"}, {Button::Right, "Right"}, {Button::Middle, "Middle"}, {Button::X1, "X1"}, {Button::X2, "X2"}, {Button::X3, "X3"}, {Button::X4, "X4"}, {Button::X5, "X5"}, {Button::X6, "X6"},)
 
Button operator& (Button l, Button r)
 
bool operator&& (Button l, Button r)
 
Button operator| (Button l, Button r)
 
Button operator~ (Button l)
 

Enumeration Type Documentation

◆ Button

enum Button

Lists the mouse button constants.

Enumerator
None 
Left 
Right 
Middle 
X1 
X2 
X3 
X4 
X5 
X6 
All 

◆ EventType

enum EventType

The type of a mouse event.

Out/Up occurs if Over/Down is handled. Click occurs only if Down is not handled.

Enumerator
HitCheck 

Checks if the coordinate hits the layer, always called first.

Over 
Move 
MovePressed 

Move event while a button is pressed.

Out 
Down 
DownPressed 

Down event while a button is already pressed.

Click 
Up 
Scroll_Vert 
Scroll_Hor 
Zoom 
Rotate 

◆ ScrollType

enum ScrollType
Enumerator
Vertical 
Horizontal 
Zoom 

Function Documentation

◆ DefineEnumStrings()

Gorgon::Input::Mouse::DefineEnumStrings ( Button  ,
{Button::Left, "Left"}  ,
{Button::Right, "Right"}  ,
{Button::Middle, "Middle"}  ,
{Button::X1, "X1"}  ,
{Button::X2, "X2"}  ,
{Button::X3, "X3"}  ,
{Button::X4, "X4"}  ,
{Button::X5, "X5"}  ,
{Button::X6, "X6"}   
)

References Left.

◆ operator&()

Button Gorgon::Input::Mouse::operator& ( Button  l,
Button  r 
)

◆ operator&&()

bool Gorgon::Input::Mouse::operator&& ( Button  l,
Button  r 
)

◆ operator|()

Button Gorgon::Input::Mouse::operator| ( Button  l,
Button  r 
)

◆ operator~()

Button Gorgon::Input::Mouse::operator~ ( Button  l)