Luciad.Input.Mouse.MouseButton Struct Reference

Represents a mouse button in the controller API. More...

Inheritance diagram for Luciad.Input.Mouse.MouseButton:

Public Member Functions
	MouseButton (uint index)
	Creates a new MouseButton with the given index. More...
bool	Equals (MouseButton other)
override bool	Equals (object other)
override int	GetHashCode ()
bool	IsLeft ()
	Returns whether the button is the left mouse button. More...
bool	IsMiddle ()
	Returns whether the button is the middle mouse button. More...
bool	IsRight ()
	Returns whether the button is the right mouse button. More...
bool	IsUnknown ()
	Returns whether the button is unknown. More...

Static Public Member Functions
static bool	operator!= (MouseButton lhs, MouseButton rhs)
static bool	operator== (MouseButton lhs, MouseButton rhs)

Properties
uint	Index [get]
	The mouse button index. More...
static MouseButton	Left = new MouseButton(1) [get]
	Returns the left mouse button. More...
static MouseButton	Middle = new MouseButton(2) [get]
	Returns the middle mouse button. More...
static MouseButton	Right = new MouseButton(3) [get]
	Returns the right mouse button. More...
static MouseButton	Unknown = new MouseButton(0) [get]
	Returns an unknown mouse button. More...

Detailed Description

Represents a mouse button in the controller API.

Since

2020.1

Constructor & Destructor Documentation

MouseButton()

Luciad.Input.Mouse.MouseButton.MouseButton ( uint  index )

inline

Creates a new MouseButton with the given index.

The mouse button index maps to mouse buttons as follows:

• 0 => unknown button
• 1 => left mouse button (primary button)
• 2 => middle mouse button
• 3 => right mouse button

Unmapped values can be used to express a custom mouse button.

Parameters

index

the mouse button index.

Member Function Documentation

Equals() [1/2]

bool Luciad.Input.Mouse.MouseButton.Equals ( MouseButton  other )

inline

Equals() [2/2]

override bool Luciad.Input.Mouse.MouseButton.Equals ( object  other )

inline

Returns

true if the MouseButtons are equal

GetHashCode()

override int Luciad.Input.Mouse.MouseButton.GetHashCode ( )

inline

IsLeft()

bool Luciad.Input.Mouse.MouseButton.IsLeft ( )

inline

Returns whether the button is the left mouse button.

Returns

whether the button is the left mouse button.

IsMiddle()

bool Luciad.Input.Mouse.MouseButton.IsMiddle ( )

inline

Returns whether the button is the middle mouse button.

Returns

whether the button is the middle mouse button.

IsRight()

bool Luciad.Input.Mouse.MouseButton.IsRight ( )

inline

Returns whether the button is the right mouse button.

Returns

whether the button is the right mouse button.

IsUnknown()

bool Luciad.Input.Mouse.MouseButton.IsUnknown ( )

inline

Returns whether the button is unknown.

Returns

whether the button is unknown.

operator!=()

static bool Luciad.Input.Mouse.MouseButton.operator!= ( MouseButton  lhs, MouseButton  rhs  )

inlinestatic

operator==()

static bool Luciad.Input.Mouse.MouseButton.operator== ( MouseButton  lhs, MouseButton  rhs  )

inlinestatic

Property Documentation

Index

uint Luciad.Input.Mouse.MouseButton.Index

get

The mouse button index.

[get]

The mouse button index.

Left

MouseButton Luciad.Input.Mouse.MouseButton.Left = new MouseButton(1)

staticget

Returns the left mouse button.

Returns

the left mouse button.

Middle

MouseButton Luciad.Input.Mouse.MouseButton.Middle = new MouseButton(2)

staticget

Returns the middle mouse button.

Returns

the middle mouse button.

Right

MouseButton Luciad.Input.Mouse.MouseButton.Right = new MouseButton(3)

staticget

Returns the right mouse button.

Returns

the right mouse button.

Unknown

MouseButton Luciad.Input.Mouse.MouseButton.Unknown = new MouseButton(0)

staticget

Returns an unknown mouse button.

Returns

an unknown mouse button.