Click or drag to resize

AxisCalibration Class

Holds calibration information for a controller axis.
Inheritance Hierarchy
SystemObject
  RewiredAxisCalibration

Namespace:  Rewired
Assembly:  Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
[SerializableAttribute]
public sealed class AxisCalibration

The AxisCalibration type exposes the following members.

Properties
  NameDescription
Public propertyapplyRangeCalibration
If enabled, calibratedMin, calibratedMax, and calibratedZero will be used to convert the value to a new range. If disabled, calibratedMin, calibratedMax, and calibratedZero will have no effect on the final value.
Public propertycalibratedMax
Gets or sets the maximum value. This can be used to transform the value to a new range.
Public propertycalibratedMin
Gets or sets the minimum value. This can be used to transform the value to a new range.
Public propertycalibratedZero
Gets or sets the zero value. This can be used to correct a non-zero resting state.
Public propertydeadZone
Gets or sets the dead zone. If the Axis's absolute value is less than or equal to the dead zone, it will return 0.
Public propertyenabled
Enables or disables the Axis. A disabled Axis always returns a value of 0.
Public propertyinvert
If true, the final value will be multiplied by -1. This can be used to correct an inverted Axis.
Public propertysensitivity
Gets or sets the sensitivity value.
Public propertysensitivityCurve
Gets or sets the sensitivity curve. The curve has no effect unless sensitivityType is set to Curve. Curve should have a time of 0 - 1 if using Radial, -1 to +1 or 0 to 1 if using Axial.
Public propertysensitivityType
Determines how sensitivity will be calculated. If sensitivityType is set to Multiplier or Power, the sensitivity property is used to calculate the value. If sensitivityType is set to Curve, the sensitivityCurve property is used to calculate the value.
Top
Methods
  NameDescription
Public methodGetCalibratedValue(Single)
Calibrates the incoming value.
Public methodGetCalibratedValue(Single, AxisRange)
Calibrates the incoming value.
Public methodGetData
Gets a struct containing the calibration data.
Public methodReset
Resets all calibration setings to the hardware defaults.
Public methodSetData
Sets the calibration data.
Top
See Also