Unigine.InputJoystick Class
This class handles joystick input. Generic joysticks can be hot-plugged. So, you can connect your joystick before or after create an instance of this class.
The InputJoystick class provides access to the following controller input:
- Axes detect movement along X and Y axes (if a joystick is two-axis, which is the most typical case) and along Z axis (if it is three-axis one). Two-axis joysticks are configured in such a way that left-to-right movement of the stick is mapped to the movement along the X axis, while movement from backward to forward (down-up) indicates movement along the Y axis. In case of 3D joystick, twisting the stick to the left (counter-clockwise) or to the right (clockwise) corresponds to movement along the Z axis.
Axes are quired for their states via getAxis(). To provide smooth interpolation between frames and avoid jerks, axis values can be filtered via setFilter(). - Buttons correspond to the controller's buttons and can be either pressed or released in the current frame, or continuously pressed for multiple frames in a row including the current one.
- POV (Point-Of-View) hat switches indicate the direction of view and support a number of positions such as left, right, up and down (similar to a D-pad).
InputJoystick Class
Properties
int PlayerIndex#
The index of player for the joystick. Some devices support connection of multiple players (e.g., XBox 360 supports up to four players connected through XBox 360 gamepads).
bool IsAvailable#
The value indicating if the joystick is available.
string Name#
The name of the joystick.
int Number#
The joystick number.
Input.DEVICE DeviceType#
The device type. One of the Input.DEVICE_*values indicating whether it is a wheel, throttle, or other device.
float Filter#
The filter value used to correct the current state of the joystick axis relative to the previous one:
- Filter value of 0 means there is no interpolation and the current value is not corrected.
- Filter value of 1 means the previous state is used instead of the current one.
int NumAxes#
The number of axes supported by the joystick.
int NumPovs#
The number of POV hat switches supported by the joystick.
int NumButtons#
The number of buttons supported by the joystick.
string Guid#
The GUID created on the basis of vendor and product identifiers and product version number. It enables you to identify device model (Controller XBox One, etc.), however, it will be the same for two identical models.
int Vendor#
The unique identifier of the device manufacturer (vendor). This can be very useful in case your application uses non-standard custom input devices to ensure proper configuration (dead zones, inverse flags, correction curves, etc.).
int Product#
The unique identifier for the product (GUID). This identifier is established by the manufacturer of the device. This can be very useful in case your application uses non-standard custom input devices to ensure proper configuration (dead zones, inverse flags, correction curves, etc.).
int ProductVersion#
The version of the product established by the manufacturer of the device. This can be very useful in case your application uses non-standard custom input devices to ensure proper configuration (dead zones, inverse flags, correction curves, etc.).
Members
float GetAxis ( uint axis ) #
Returns a state value for the axis win the specified number. It includes position of the joystick along the following axes: X, Y (two-axis joystick) and Z (three-axis joystick). When a joystick is in the center position, X and Y axes values are zero. Negative values indicate left or down; positive values indicate right or up.Arguments
- uint axis - Axis number.
Return value
Value in range [-1; 1].float GetAxisDelta ( uint axis ) #
Arguments
- uint axis - Axis number.
string GetAxisName ( uint axis ) #
Returns the name of a given axis by its number.Arguments
- uint axis - Axis number.
Return value
Axis name.Input.JOYSTICK_POV GetPov ( uint pov ) #
Returns a POV hat switch state. POV hats support the following positions: left, right, up and down.Arguments
- uint pov - POV hat number.
Return value
POV hat state. One of the JOYSTICK_POV values of the Input class.string GetPovName ( uint pov ) #
Returns the name of a given POV hat switch.Arguments
- uint pov - POV hat number.
Return value
POV hat name.bool IsButtonPressed ( uint key ) #
Returns a value indicating if the button with the specified number is pressed. Check this value to perform continuous actions.Arguments
- uint key - Button number.
Return value
true if the button with the specified number is pressed; otherwise - false (pressed).bool IsButtonDown ( uint key ) #
Returns a value indicating if the button with the specified number was pressed during the current frame.Arguments
- uint key - Button number.
Return value
true if the button with the specified number was pressed during the current frame; otherwise - false (pressed).bool IsButtonUp ( uint key ) #
Returns a value indicating if the button with the specified number was released during the current frame.Arguments
- uint key - Button number.
Return value
true if the button with the specified number was released during the current frame; otherwise - false.string GetButtonName ( uint button ) #
Returns the name of the button with the specified number.Arguments
- uint button - Button number.
Return value
Button name.InputEventJoyButton GetButtonEvent ( int button ) #
Returns the currently processed joystick button input event.Arguments
- int button - Button number.
Return value
Joystick button input event, or null if there are no events for the specified joystick button in the current frame.int GetButtonEvents ( int button, InputEventJoyButton[] OUT_events ) #
Returns the number of input events for the specified joystick button and puts the events to the specified output buffer.Arguments
- int button - Button number.
- InputEventJoyButton[]
OUT_events - Buffer with button input events.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
Return value
Number of input events for the specified joystick button.InputEventJoyPovMotion GetPovEvent ( int pov ) #
Returns the currently processed joystick POV hat input event.Arguments
- int pov - POV hat number.
Return value
Joystick POV hat input event, or null if there are no events for the specified joystick POV hat in the current frame.int GetPovEvents ( int pov, InputEventJoyPovMotion[] OUT_events ) #
Returns the number of input events for the specified joystick POV hat and puts the events to the specified output buffer.Arguments
- int pov - POV hat number.
- InputEventJoyPovMotion[]
OUT_events - Buffer with POV input events.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
Return value
Number of input events for the specified joystick POV hat.bool IsForceFeedbackEffectSupported ( Input.JOYSTICK_FORCE_FEEDBACK_EFFECT effect ) #
Returns the value indicating of the specified force feedback effect is supported by the joystick.Arguments
- Input.JOYSTICK_FORCE_FEEDBACK_EFFECT effect - Force feedback effect.
Return value
true if the specified force feedback effect is supported, otherwise false.void PlayForceFeedbackEffectConstant ( float force, float magnitude ) #
Applies the constant force-feedback effect with the specified parameters to the joystick. Force is applied at a constant level for the duration of the effect.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float magnitude - Modifier of force-feedback effect envelope (angular X direction).
void PlayForceFeedbackEffectRamp ( float force, float magnitude, uint64_t duration_us ) #
Applies the ramp force-feedback effect with the specified parameters to the joystick. Force is applied gradually by being increased or decreased over the duration of the effect.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float magnitude - Modifier of force-feedback effect envelope (angular X direction).
- uint64_t duration_us - Force-feedback effect duration, in microseconds.
void PlayForceFeedbackEffectSineWave ( float force, float frequency ) #
Applies the sine-wave force-feedback effect with the specified parameters to the joystick. Force is applied in a sine-wave pattern.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float frequency - Frequency of the force-feedback period, in hertz.
void PlayForceFeedbackEffectSquareWave ( float force, float frequency ) #
Applies the square-wave force-feedback effect with the specified parameters to the joystick. Force is applied in a square-wave pattern.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float frequency - Frequency of the force-feedback period, in hertz.
void PlayForceFeedbackEffectTriangleWave ( float force, float frequency ) #
Applies the triangle-wave force-feedback effect with the specified parameters to the joystick. Force is applied in a triangle-wave pattern.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float frequency - Frequency of the force-feedback period, in hertz.
void PlayForceFeedbackEffectSawtoothUpWave ( float force, float frequency ) #
Applies the upward-sawtooth-wave force-feedback effect with the specified parameters to the joystick. Force is applied in a upward-sawtooth-wave pattern.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float frequency - Frequency of the force-feedback period, in hertz.
void PlayForceFeedbackEffectSawtoothDownWave ( float force, float frequency ) #
Applies the downward-sawtooth-wave force-feedback effect with the specified parameters to the joystick. Force is applied in a downward-sawtooth-wave pattern.Arguments
- float force - Amount of force being applied by a force-feedback effect.
- float frequency - Frequency of the force-feedback period, in hertz.
void PlayForceFeedbackEffectSpring ( float force ) #
Applies the spring force-feedback effect with the specified force to the joystick. Force is applied in opposition to a set state.Arguments
- float force - Amount of force being applied by a force-feedback effect.
void PlayForceFeedbackEffectFriction ( float force ) #
Applies the friction force-feedback effect with the specified force to the joystick. Force is applied to mimic friction.Arguments
- float force - Amount of force being applied by a force-feedback effect.
void PlayForceFeedbackEffectDamper ( float force ) #
Applies the damper force-feedback effect with the specified force to the joystick. Force is applied to mimic a damper effect.Arguments
- float force - Amount of force being applied by a force-feedback effect.
void PlayForceFeedbackEffectInertia ( float force ) #
Applies the inertia force-feedback effect with the specified force to the joystick. Force is applied to mimic an inertia effect.Arguments
- float force - Amount of force being applied by a force-feedback effect.
void StopForceFeedbackEffect ( Input.JOYSTICK_FORCE_FEEDBACK_EFFECT effect ) #
Stops application of the specified type of force-feedback effect to the joystick.Arguments
- Input.JOYSTICK_FORCE_FEEDBACK_EFFECT effect - Type of a force-feedback effect.
bool IsForceFeedbackEffectPlaying ( Input.JOYSTICK_FORCE_FEEDBACK_EFFECT effect ) #
Returns the value indicating if the specified type of force-feedback effect is currently being applied.Arguments
- Input.JOYSTICK_FORCE_FEEDBACK_EFFECT effect - Type of a force-feedback effect.
Return value
true if the specified type of force-feedback effect is currently being applied, otherwise false.Last update:
2024-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)