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 ()
bool	IsMiddle ()
bool	IsRight ()
bool	IsUnknown ()

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

Properties
uint	Index [get]
static MouseButton	Left = new MouseButton(1) [get]
static MouseButton	Middle = new MouseButton(2) [get]
static MouseButton	Right = new MouseButton(3) [get]
static MouseButton	Unknown = new MouseButton(0) [get]

Detailed Description

Represents a mouse button in the controller API.

2020.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton.

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.

index

the mouse button index.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton::MouseButton.

Member Function Documentation

Equals() [1/2]

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

inline

Equals() [2/2]

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

inline

rhs

the MouseButton that this MouseButton is being compared to.

true if the MouseButtons are equal

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton::operator==.

GetHashCode()

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

inline

IsLeft()

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

inline

if the button is the left mouse button

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton::isLeft.

IsMiddle()

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

inline

if the button is the middle mouse button

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton::isMiddle.

IsRight()

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

inline

if the button is the right mouse button

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton::isRight.

IsUnknown()

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

inline

if the button is unknown

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseButton::isUnknown.

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

Left

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

staticget

Middle

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

staticget

Right

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

staticget

Unknown

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

staticget