WPILibC++  2020.3.2-60-g3011ebe
frc2::JoystickButton Class Reference

A class used to bind command scheduling to joystick button presses. More...

#include <JoystickButton.h>

Inheritance diagram for frc2::JoystickButton:
frc2::Button frc2::Trigger

Public Member Functions

 JoystickButton (frc::GenericHID *joystick, int buttonNumber)
 Creates a JoystickButton that commands can be bound to. More...
 
- Public Member Functions inherited from frc2::Button
 Button (std::function< bool()> isPressed)
 Create a new button that is pressed when the given condition is true. More...
 
 Button ()=default
 Create a new button that is pressed active (default constructor) - activity can be further determined by subclass code.
 
Button WhenPressed (Command *command, bool interruptible=true)
 Binds a command to start when the button is pressed. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Button WhenPressed (T &&command, bool interruptible=true)
 Binds a command to start when the button is pressed. More...
 
Button WhenPressed (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements)
 Binds a runnable to execute when the button is pressed. More...
 
Button WhenPressed (std::function< void()> toRun, wpi::ArrayRef< Subsystem * > requirements={})
 Binds a runnable to execute when the button is pressed. More...
 
Button WhileHeld (Command *command, bool interruptible=true)
 Binds a command to be started repeatedly while the button is pressed, and cancelled when it is released. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Button WhileHeld (T &&command, bool interruptible=true)
 Binds a command to be started repeatedly while the button is pressed, and cancelled when it is released. More...
 
Button WhileHeld (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements)
 Binds a runnable to execute repeatedly while the button is pressed. More...
 
Button WhileHeld (std::function< void()> toRun, wpi::ArrayRef< Subsystem * > requirements={})
 Binds a runnable to execute repeatedly while the button is pressed. More...
 
Button WhenHeld (Command *command, bool interruptible=true)
 Binds a command to be started when the button is pressed, and cancelled when it is released. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Button WhenHeld (T &&command, bool interruptible=true)
 Binds a command to be started when the button is pressed, and cancelled when it is released. More...
 
Button WhenReleased (Command *command, bool interruptible=true)
 Binds a command to start when the button is released. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Button WhenReleased (T &&command, bool interruptible=true)
 Binds a command to start when the button is pressed. More...
 
Button WhenReleased (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements)
 Binds a runnable to execute when the button is released. More...
 
Button WhenReleased (std::function< void()> toRun, wpi::ArrayRef< Subsystem * > requirements={})
 Binds a runnable to execute when the button is released. More...
 
Button ToggleWhenPressed (Command *command, bool interruptible=true)
 Binds a command to start when the button is pressed, and be cancelled when it is pressed again. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Button ToggleWhenPressed (T &&command, bool interruptible=true)
 Binds a command to start when the button is pressed, and be cancelled when it is pessed again. More...
 
Button CancelWhenPressed (Command *command)
 Binds a command to be cancelled when the button is pressed. More...
 
- Public Member Functions inherited from frc2::Trigger
 Trigger (std::function< bool()> isActive)
 Create a new trigger that is active when the given condition is true. More...
 
 Trigger ()
 Create a new trigger that is never active (default constructor) - activity can be further determined by subclass code.
 
 Trigger (const Trigger &other)
 
Trigger WhenActive (Command *command, bool interruptible=true)
 Binds a command to start when the trigger becomes active. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Trigger WhenActive (T &&command, bool interruptible=true)
 Binds a command to start when the trigger becomes active. More...
 
Trigger WhenActive (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements)
 Binds a runnable to execute when the trigger becomes active. More...
 
Trigger WhenActive (std::function< void()> toRun, wpi::ArrayRef< Subsystem * > requirements={})
 Binds a runnable to execute when the trigger becomes active. More...
 
Trigger WhileActiveContinous (Command *command, bool interruptible=true)
 Binds a command to be started repeatedly while the trigger is active, and cancelled when it becomes inactive. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Trigger WhileActiveContinous (T &&command, bool interruptible=true)
 Binds a command to be started repeatedly while the trigger is active, and cancelled when it becomes inactive. More...
 
Trigger WhileActiveContinous (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements)
 Binds a runnable to execute repeatedly while the trigger is active. More...
 
Trigger WhileActiveContinous (std::function< void()> toRun, wpi::ArrayRef< Subsystem * > requirements={})
 Binds a runnable to execute repeatedly while the trigger is active. More...
 
Trigger WhileActiveOnce (Command *command, bool interruptible=true)
 Binds a command to be started when the trigger becomes active, and cancelled when it becomes inactive. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Trigger WhileActiveOnce (T &&command, bool interruptible=true)
 Binds a command to be started when the trigger becomes active, and cancelled when it becomes inactive. More...
 
Trigger WhenInactive (Command *command, bool interruptible=true)
 Binds a command to start when the trigger becomes inactive. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Trigger WhenInactive (T &&command, bool interruptible=true)
 Binds a command to start when the trigger becomes inactive. More...
 
Trigger WhenInactive (std::function< void()> toRun, std::initializer_list< Subsystem * > requirements)
 Binds a runnable to execute when the trigger becomes inactive. More...
 
Trigger WhenInactive (std::function< void()> toRun, wpi::ArrayRef< Subsystem * > requirements={})
 Binds a runnable to execute when the trigger becomes inactive. More...
 
Trigger ToggleWhenActive (Command *command, bool interruptible=true)
 Binds a command to start when the trigger becomes active, and be cancelled when it again becomes active. More...
 
template<class T , typename = std::enable_if_t<std::is_base_of_v< Command, std::remove_reference_t<T>>>>
Trigger ToggleWhenActive (T &&command, bool interruptible=true)
 Binds a command to start when the trigger becomes active, and be cancelled when it again becomes active. More...
 
Trigger CancelWhenActive (Command *command)
 Binds a command to be cancelled when the trigger becomes active. More...
 
Trigger operator&& (Trigger rhs)
 Composes two triggers with logical AND. More...
 
Trigger operator|| (Trigger rhs)
 Composes two triggers with logical OR. More...
 
Trigger operator! ()
 Composes a trigger with logical NOT. More...
 

Detailed Description

A class used to bind command scheduling to joystick button presses.

Can be composed with other buttons with the operators in Trigger.

See also
Trigger

Constructor & Destructor Documentation

◆ JoystickButton()

frc2::JoystickButton::JoystickButton ( frc::GenericHID joystick,
int  buttonNumber 
)
inlineexplicit

Creates a JoystickButton that commands can be bound to.

Parameters
joystickThe joystick on which the button is located.
buttonNumberThe number of the button on the joystic.

The documentation for this class was generated from the following file: