Click or drag to resize

MouseDevice Class

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 Hierarchy

Namespace:  Fusee.Engine.Core
Assembly:  Fusee.Engine.Core (in Fusee.Engine.Core.dll) Version: 0.7.0.0 (0.7.0.0)
Syntax
C#
public class MouseDevice : InputDevice

The MouseDevice type exposes the following members.

Constructors
  NameDescription
Public methodMouseDevice
Initializes a new instance of the MouseDevice class.
Top
Properties
  NameDescription
Public propertyAxesCount
Gets number of axes supported by this device.
(Inherited from InputDevice.)
Public propertyAxisDesc
Gets a description of the axis. This value can be used in user setup-dialogs or to match axes of devices of different categories.
(Inherited from InputDevice.)
Public propertyButtonCount
Gets the number of buttons supported by this device.
(Inherited from InputDevice.)
Public propertyButtonDesc
Gets the name of the button. This value can be used in user setup-dialogs or to match buttons of devices of different categories.
(Inherited from InputDevice.)
Public propertyCategory
Gets the category of this device. Device categories define a minimal common set of buttons and axes which are identical across all devices sharing the same category.
(Inherited from InputDevice.)
Public propertyDesc
Gets the human readable description of this device. This parameter can be used in user dialogs to identify devices.
(Inherited from InputDevice.)
Public propertyId
Gets an identifier. Implementors take care that this id is unique across all devices managed by a driver.
(Inherited from InputDevice.)
Public propertyIsConnected
Gets or sets a value indicating whether this device is connected.
(Inherited from InputDevice.)
Public propertyLeftButton
Retrieves the current state of the left mouse button.
Public propertyLeftButtonDesc
Retrieves information about the left mouse button.
Public propertyMiddleButton
Retrieves the current state of the middle mouse button.
Public propertyMiddleButtonDesc
Retrieves information about the middle mouse button.
Public propertyNewAxisID (Inherited from InputDevice.)
Public propertyPosition
Gets the current position relative to the upper left corner of the rendering window.
Public propertyPositionInt
Gets the current position relative to the upper left corner of the rendering window. The returned values are integers.
Public propertyRightButton
Retrieves the current state of the right mouse button.
Public propertyRightButtonDesc
Retrieves information about the right mouse button.
Public propertyVelocity
Retrieves the current mouse velocity (speed) on screen in pixels/second.
Public propertyVelocityInt
Retrieves the current mouse velocity (speed) on screen in pixels/second. Return values are integers.
Public propertyWheel
Gets the current wheel value.
Public propertyWheelDesc
Retrieves information about the mouse wheel axis.
Public propertyWheelVel
Retrieves the current mouse wheel velocity.
Public propertyWheelVelDesc
Retrieves information about the mouse wheel velocity axis.
Public propertyX
Gets the mouse's x value.
Public propertyXDesc
Retrieves information about the x axis.
Public propertyXVel
Retrieves the current mouse velocity in x direction.
Public propertyXVelDesc
Retrieves information about the x velocity axis.
Public propertyY
Gets the mouse's y value.
Public propertyYDesc
Retrieves information about the y axis.
Public propertyYVel
Retrieves the current mouse velocity in y direction.
Public propertyYVelDesc
Retrieves information about the y velocity axis.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAxis
Gets the value currently present at the given axis.
(Inherited from InputDevice.)
Public methodGetAxisDescription
Retrieves a description for the given axis
(Inherited from InputDevice.)
Public methodGetButton
Gets the current state of the given button.
(Inherited from InputDevice.)
Public methodGetButtonDescription
Retrieves a description for the given button.
(Inherited from InputDevice.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsButtonDown
Determines whether the button was pressed down right before or during the current frame. This value is true only for one frame even if the button is pressed longer than one frame.
(Inherited from InputDevice.)
Public methodIsButtonUp
Determines whether the button was released right before or during the current frame. This value is true only for one frame even if the button is released longer than one frame.
(Inherited from InputDevice.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPostRender (Inherited from InputDevice.)
Public methodRegisterCalculatedAxis
Registers a calculated axis. Calculated axes behave like axes exposed by the underlying hardware device but can be calculated from one or more existing axes or buttons.
(Inherited from InputDevice.)
Public methodRegisterSingleButtonAxis
Registers a calculated axis from a button. The axis' value changes between 0 and 1 as the user hits the button or releases it. The time it takes to change the value can be set.
(Inherited from InputDevice.)
Public methodRegisterTwoButtonAxis
Registers a calculated axis from two buttons. The axis' value changes between -1 and 1 as the user hits the button or releases it. The time it takes to change the value can be set.
(Inherited from InputDevice.)
Public methodRegisterVelocityAxis
Registers a calculated axis exhibiting the derivative after the time (Velocity) of the value on the specified original axis.
(Inherited from InputDevice.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventAxisValueChanged
Occurs when the value of a given axis has changed.
(Inherited from InputDevice.)
Public eventButtonValueChanged
Occurs when the value of a given button has changed.
(Inherited from InputDevice.)
Top
See Also