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

[SerializableAttribute]
public sealed class AxisCalibration

The AxisCalibration type exposes the following members.

Properties

	Name	Description
	applyRangeCalibration	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.
	calibratedMax	Gets or sets the maximum value. This can be used to transform the value to a new range.
	calibratedMin	Gets or sets the minimum value. This can be used to transform the value to a new range.
	calibratedZero	Gets or sets the zero value. This can be used to correct a non-zero resting state.
	deadZone	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.
	enabled	Enables or disables the Axis. A disabled Axis always returns a value of 0.
	invert	If true, the final value will be multiplied by -1. This can be used to correct an inverted Axis.
	sensitivity	Gets or sets the sensitivity value.
	sensitivityCurve	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.
	sensitivityType	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.

Methods

	Name	Description
	GetCalibratedValue(Single)	Calibrates the incoming value.
	GetCalibratedValue(Single, AxisRange)	Calibrates the incoming value.
	GetData	Gets a struct containing the calibration data.
	Reset	Resets all calibration setings to the hardware defaults.
	SetData	Sets the calibration data.