Struct AxisDescription

A structure describing an input device's axis.

Inherited Members

System.ValueType.Equals(System.Object)

System.ValueType.GetHashCode()

System.ValueType.ToString()

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

System.Object.GetType()

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

Namespace: Fusee.Engine.Common

Assembly: Fusee.Engine.Common.dll

Syntax

public struct AxisDescription

Fields

Bounded

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.

Declaration

public AxisBoundedType Bounded

Field Value

Type	Description
AxisBoundedType

Deadzone

The value at which the axis is assumed to be zero.

Declaration

public float Deadzone

Field Value

Type	Description
System.Single

Direction

The direction of the axis (used with devices exhibiting two- or more-dimensional input such as joysticks on gamepads, mouse, etc).

Declaration

public AxisDirection Direction

Field Value

Type	Description
AxisDirection

Id

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.

Declaration

public int Id

Field Value

Type	Description
System.Int32

MaxValueOrAxis

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.

Declaration

public float MaxValueOrAxis

Field Value

Type	Description
System.Single

MinValueOrAxis

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.

Declaration

public float MinValueOrAxis

Field Value

Type	Description
System.Single

Name

The human readable name of the axis.

Declaration

public string Name

Field Value

Type	Description
System.String

Nature

The nature of the axis.

Declaration

public AxisNature Nature

Field Value

Type	Description
AxisNature