WPILibC++ 2024.3.1
frc2::POVButton Class Reference

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

#include <frc2/command/button/POVButton.h>

Inheritance diagram for frc2::POVButton:
frc2::Trigger

Public Member Functions

 POVButton (frc::GenericHID *joystick, int angle, int povNumber=0)
 Creates a POVButton that commands can be bound to. More...
 
- Public Member Functions inherited from frc2::Trigger
 Trigger (std::function< bool()> condition)
 Creates a new trigger based on the given condition. More...
 
 Trigger (frc::EventLoop *loop, std::function< bool()> condition)
 Creates a new trigger based on the given condition. More...
 
 Trigger ()
 Create a new trigger that is always false. More...
 
 Trigger (const Trigger &other)
 
Trigger OnTrue (Command *command)
 Starts the given command whenever the condition changes from false to true. More...
 
Trigger OnTrue (CommandPtr &&command)
 Starts the given command whenever the condition changes from false to true. More...
 
Trigger OnFalse (Command *command)
 Starts the given command whenever the condition changes from true to false. More...
 
Trigger OnFalse (CommandPtr &&command)
 Starts the given command whenever the condition changes from true to false. More...
 
Trigger WhileTrue (Command *command)
 Starts the given command when the condition changes to true and cancels it when the condition changes to false. More...
 
Trigger WhileTrue (CommandPtr &&command)
 Starts the given command when the condition changes to true and cancels it when the condition changes to false. More...
 
Trigger WhileFalse (Command *command)
 Starts the given command when the condition changes to false and cancels it when the condition changes to true. More...
 
Trigger WhileFalse (CommandPtr &&command)
 Starts the given command when the condition changes to false and cancels it when the condition changes to true. More...
 
Trigger ToggleOnTrue (Command *command)
 Toggles a command when the condition changes from false to true. More...
 
Trigger ToggleOnTrue (CommandPtr &&command)
 Toggles a command when the condition changes from false to true. More...
 
Trigger ToggleOnFalse (Command *command)
 Toggles a command when the condition changes from true to the low state. More...
 
Trigger ToggleOnFalse (CommandPtr &&command)
 Toggles a command when the condition changes from true to false. More...
 
Trigger operator&& (std::function< bool()> rhs)
 Composes two triggers with logical AND. More...
 
Trigger operator&& (Trigger rhs)
 Composes two triggers with logical AND. More...
 
Trigger operator|| (std::function< bool()> rhs)
 Composes two triggers with logical OR. More...
 
Trigger operator|| (Trigger rhs)
 Composes two triggers with logical OR. More...
 
Trigger operator! ()
 Composes a trigger with logical NOT. More...
 
Trigger Debounce (units::second_t debounceTime, frc::Debouncer::DebounceType type=frc::Debouncer::DebounceType::kRising)
 Creates a new debounced trigger from this trigger - it will become active when this trigger has been active for longer than the specified period. More...
 
bool Get () const
 Returns the current state of this trigger. More...
 

Detailed Description

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

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

This class is provided by the NewCommands VendorDep

See also
Trigger

Constructor & Destructor Documentation

◆ POVButton()

frc2::POVButton::POVButton ( frc::GenericHID joystick,
int  angle,
int  povNumber = 0 
)
inline

Creates a POVButton that commands can be bound to.

Parameters
joystickThe joystick on which the button is located.
angleThe angle of the POV corresponding to a button press.
povNumberThe number of the POV on the joystick.

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