Class MouseDevice

Special case of an InputDevice identifying itself as a Mouse. Defines convenience methods to access the typical mouse axes and buttons. Registers the mouse velocity derived axes.

Inheritance

System.Object

InputDevice

MouseDevice

Inherited Members

InputDevice.NewAxisID

InputDevice.IsConnected

InputDevice.Id

InputDevice.Desc

InputDevice.Category

InputDevice.AxesCount

InputDevice.AxisDesc

InputDevice.GetAxisDescription(Int32)

InputDevice.GetAxis(Int32)

InputDevice.GetAxisRaw(Int32)

InputDevice.SetAxisDeadzone(Int32, Single)

InputDevice.GetAxisDeadzone(Int32)

InputDevice.AxisValueChanged

InputDevice.ButtonCount

InputDevice.ButtonDesc

InputDevice.GetButtonDescription(Int32)

InputDevice.GetButton(Int32)

InputDevice.IsButtonDown(Int32)

InputDevice.IsButtonUp(Int32)

InputDevice.ButtonValueChanged

InputDevice.RegisterCalculatedAxis(AxisDescription, InputDevice.AxisValueCalculator, Single)

InputDevice.RegisterVelocityAxis(Int32, Int32, Int32, String, AxisDirection)

InputDevice.RegisterSingleButtonAxis(Int32, AxisDirection, Single, Single, Int32, String)

InputDevice.RegisterTwoButtonAxis(Int32, Int32, AxisDirection, Single, Single, Int32, String)

InputDevice.PostRender()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Fusee.Engine.Core

Assembly: Fusee.Engine.Core.dll

Syntax

public class MouseDevice : InputDevice

Constructors

MouseDevice(IInputDeviceImp)

Initializes a new instance of the MouseDevice class.

Declaration

public MouseDevice(IInputDeviceImp inpDeviceImp)

Parameters

Type	Name	Description
IInputDeviceImp	inpDeviceImp	The platform dependent connector to the underlying physical device.

Properties

LeftButton

Retrieves the current state of the left mouse button.

Declaration

public bool LeftButton { get; }

Property Value

Type	Description
System.Boolean	true if the left mouse button is currently pressed; otherwise, false.

LeftButtonDesc

Retrieves information about the left mouse button.

Declaration

public ButtonDescription LeftButtonDesc { get; }

Property Value

Type	Description
ButtonDescription	The description for the left mouse button.

MiddleButton

Retrieves the current state of the middle mouse button.

Declaration

public bool MiddleButton { get; }

Property Value

Type	Description
System.Boolean	true if the left middle button is currently pressed; otherwise, false.

MiddleButtonDesc

Retrieves information about the middle mouse button.

Declaration

public ButtonDescription MiddleButtonDesc { get; }

Property Value

Type	Description
ButtonDescription	The description for the middle mouse button.

Position

Gets the current position relative to the upper left corner of the rendering window.

Declaration

public float2 Position { get; }

Property Value

Type	Description
float2	The current position of the mouse.

PositionInt

Gets the current position relative to the upper left corner of the rendering window. The returned values are integers.

Declaration

public Point PositionInt { get; }

Property Value

Type	Description
Point	The mouse position. z contains the wheel's value.

RightButton

Retrieves the current state of the right mouse button.

Declaration

public bool RightButton { get; }

Property Value

Type	Description
System.Boolean	true if the left right button is currently pressed; otherwise, false.

RightButtonDesc

Retrieves information about the right mouse button.

Declaration

public ButtonDescription RightButtonDesc { get; }

Property Value

Type	Description
ButtonDescription	The description for the right mouse button.

Velocity

Retrieves the current mouse velocity (speed) on screen in pixels/second.

Declaration

public float2 Velocity { get; }

Property Value

Type	Description
float2	The mouse velocity.

VelocityInt

Retrieves the current mouse velocity (speed) on screen in pixels/second. Return values are integers.

Declaration

public Point VelocityInt { get; }

Property Value

Type	Description
Point	The mouse velocity. z contains the wheel velocity.

Wheel

Gets the current wheel value.

Declaration

public float Wheel { get; }

Property Value

Type	Description
System.Single	The wheel value.

WheelDesc

Retrieves information about the mouse wheel axis.

Declaration

public AxisDescription WheelDesc { get; }

Property Value

Type	Description
AxisDescription	The description for the mouse wheel axis.

WheelVel

Retrieves the current mouse wheel velocity.

Declaration

public float WheelVel { get; }

Property Value

Type	Description
System.Single	The velocity of the mouse wheel.

WheelVelDesc

Retrieves information about the mouse wheel velocity axis.

Declaration

public AxisDescription WheelVelDesc { get; }

Property Value

Type	Description
AxisDescription	The description for the mouse wheel velocity axis.

X

Gets the mouse's x value.

Declaration

public float X { get; }

Property Value

Type	Description
System.Single	Number of pixels from the left border of the rendering window to the current mouse position.

XDesc

Retrieves information about the x axis.

Declaration

public AxisDescription XDesc { get; }

Property Value

Type	Description
AxisDescription	The description for the x axis.

XVel

Retrieves the current mouse velocity in x direction.

Declaration

public float XVel { get; }

Property Value

Type	Description
System.Single	The x velocity.

XVelDesc

Retrieves information about the x velocity axis.

Declaration

public AxisDescription XVelDesc { get; }

Property Value

Type	Description
AxisDescription	The description for the x velocity axis.

Y

Gets the mouse's y value.

Declaration

public float Y { get; }

Property Value

Type	Description
System.Single	Number of pixels from the upper border of the rendering window to the current mouse position.

YDesc

Retrieves information about the y axis.

Declaration

public AxisDescription YDesc { get; }

Property Value

Type	Description
AxisDescription	The description for the y axis.

YVel

Retrieves the current mouse velocity in y direction.

Declaration

public float YVel { get; }

Property Value

Type	Description
System.Single	The y velocity.

YVelDesc

Retrieves information about the y velocity axis.

Declaration

public AxisDescription YVelDesc { get; }

Property Value

Type	Description
AxisDescription	The description for the y velocity axis.