WPILibC++
unspecified
|
This class provides an easy way to link commands to OI inputs. More...
#include <Button.h>
Public Member Functions | |
virtual void | WhenPressed (Command *command) |
Specifies the command to run when a button is first pressed. More... | |
virtual void | WhileHeld (Command *command) |
Specifies the command to be scheduled while the button is pressed. More... | |
virtual void | WhenReleased (Command *command) |
Specifies the command to run when the button is released. More... | |
virtual void | CancelWhenPressed (Command *command) |
Cancels the specificed command when the button is pressed. More... | |
virtual void | ToggleWhenPressed (Command *command) |
Toggle the specified command when the button is pressed. More... | |
![]() | |
bool | Grab () |
virtual bool | Get ()=0 |
void | WhenActive (Command *command) |
void | WhileActive (Command *command) |
void | WhenInactive (Command *command) |
void | CancelWhenActive (Command *command) |
void | ToggleWhenActive (Command *command) |
void | InitTable (std::shared_ptr< ITable > subtable) override |
Initializes a table for this sendable object. More... | |
std::shared_ptr< ITable > | GetTable () const override |
std::string | GetSmartDashboardType () const override |
Additional Inherited Members | |
![]() | |
std::shared_ptr< ITable > | m_table |
This class provides an easy way to link commands to OI inputs.
It is very easy to link a button to a command. For instance, you could link the trigger button of a joystick to a "score" command.
This class represents a subclass of Trigger that is specifically aimed at buttons on an operator interface as a common use case of the more generalized Trigger objects. This is a simple wrapper around Trigger with the method names renamed to fit the Button object use.
|
virtual |
Cancels the specificed command when the button is pressed.
command | The command to be canceled |
|
virtual |
Toggle the specified command when the button is pressed.
command | The command to be toggled |
|
virtual |
Specifies the command to run when a button is first pressed.
command | The pointer to the command to run |
|
virtual |
Specifies the command to run when the button is released.
The command will be scheduled a single time.
command | The pointer to the command to run |
|
virtual |
Specifies the command to be scheduled while the button is pressed.
The command will be scheduled repeatedly while the button is pressed and will be canceled when the button is released.
command | The pointer to the command to run |