read

(To be removed) Read status of joystick button, axes and pov

read will be removed in a future release. For more information, see Version History.

Syntax

[a,b,p] = read(joy)
[a,b,p] = read(joy,f)


Description

[a,b,p] = read(joy) reads the status of axes, buttons, and point of views (POVs) of the specified joystick.

[a,b,p] = read(joy,f) additionally applies feedback forces to a force-feedback joystick.

Input Arguments

joy — Joystick object

vrjoystick object

Joystick, specified as a vrjoystick object.

n — Axis number

real positive scalar | real positive vector

Axis number of joystick, specified as a scalar or a vector.

f — Force feedback to be applied

scalar | vector

Force feedback to be applied to joystick axis, specified as a scalar or a vector in the range [-1,1]. Values of f should be in range of -1 to 1, and the number of elements in f should either match the number of elements of n, or f can be a scalar to be applied to all the axes specified by n.

Output Arguments

a — Status of joystick

real positive scalar in the range [-1, 1]

Status of joystick axis, returned as a real positive scalar in the range [-1,1]. If n is a vector, multiple buttons are returned.

b — Status of button

0 | 1

Status of joystick button, returned as either 0 or 1. If n is a vector, multiple buttons are returned.

p — Point of view

real scalar

Point of view, returned as a real scalar in degrees. When a value of -1 is no axis is selected.

Version History

Introduced in R2007b

R2025a: To be removed

The read function will be removed in a future release. Use sim3d.io.Joystick object instead.