Click or drag to resize

AxisDescription Structure

A structure describing an input device's axis.

Namespace:  Fusee.Engine.Common
Assembly:  Fusee.Engine.Common (in Fusee.Engine.Common.dll) Version: 0.7.0.0 (0.7.0.0)
Syntax
C#
public struct AxisDescription

The AxisDescription type exposes the following members.

Methods
  NameDescription
Public methodEquals
Indicates whether this instance and a specified object are equal.
(Inherited from ValueType.)
Public methodGetHashCode
Returns the hash code for this instance.
(Inherited from ValueType.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns the fully qualified type name of this instance.
(Inherited from ValueType.)
Top
Fields
  NameDescription
Public fieldBounded
Indicating if the axis' values are within a defined range. Depending on this value MinValueOrAxis and MaxValueOrAxis contain either constant range bounds or other axes' Ids delivering the (possibly changing) range values.
Public fieldDirection
The direction of the axis (used with devices exhibiting two- or more-dimensional input such as joysticks on gamepads, mouse, etc).
Public fieldId
The identifier of the axis. Use this identifier to query values. An axis' Id might be different than the order of occurrence (index) of the axis when enumerated from the device.
Public fieldMaxValueOrAxis
The maximum value returned by the axis. If Bounded is Constant this field contains constant value. If Bounded is OtherAxis this field contains the Id of the axis keeping the (possibly changing) maximum value. In this case cast this value to integer before passing it to InputDevice methods.
Public fieldMinValueOrAxis
The minimum value returned by the axis. If Bounded is Constant this field contains constant value. If Bounded is OtherAxis this field contains the Id of the axis keeping the (possibly changing) minimum value. In this case cast this value to integer before passing it to InputDevice methods.
Public fieldName
The human readable name of the axis.
Public fieldNature
The nature of the axis.
Top
See Also