## Copyright (C) 2021 John Donoghue <john.donoghue@ieee.org>
##
## This program is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program.  If not, see
## <https://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {} {@var{joy} =} button (@var{joy}, @var{id})
## Get the value of button @var{id} on joystick @var{joy}.
##
## @subsubheading Inputs
## @var{joy} - a previously opened joystick object@*
## @var{id} - a positive numeric id for the joystick button to use@*
##
## @var{id} an be a vector of IDs to allow retrieving multiple buttons.
##
## @subsubheading Outputs
## @var{value} - value of the button (0 or 1).@*
##
## @var{value} will be a vector of values when getting multiple buttons.
##
## @subsubheading Examples
## Open device 1 and get value of button 1
## @example
## @code {
## joy = vrjoystick(1);
## val = button(joy, 1)
## }
## @end example
##
## @seealso{vrjoystick}
## @end deftypefn

function val = button(joy, id)

  if nargin < 2 || !isnumeric(id)
    print_usage();
  endif

  if isvector(id) && length(id) > 1
    val = [];
    for i = 1:length(id)
      val(end+1) = __joystick_button__(joy, id(i));
    endfor
  else
    val = __joystick_button__(joy, id);
  endif

endfunction
