Class CommandGameCubeController

java.lang.Object
org.wpilib.command3.button.CommandGameCubeController

public class CommandGameCubeController extends Object
A version of GameCubeController with Trigger factories for command-based.
See Also:
  • Constructor Details

    • CommandGameCubeController

      public CommandGameCubeController(int port)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the default scheduler using its default event loop.
      Parameters:
      port - The port index on the Driver Station that the controller is plugged into.
    • CommandGameCubeController

      public CommandGameCubeController(GameCubeController controller)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the default scheduler using its default event loop.
      Parameters:
      controller - The GameCubeController object to use for this controller.
    • CommandGameCubeController

      public CommandGameCubeController(Scheduler scheduler, int port)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the given scheduler using its default event loop.
      Parameters:
      scheduler - The scheduler that should execute the triggered commands.
      port - The port index on the Driver Station that the controller is plugged into.
    • CommandGameCubeController

      public CommandGameCubeController(Scheduler scheduler, GameCubeController controller)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the given scheduler using its default event loop.
      Parameters:
      scheduler - The scheduler that should execute the triggered commands.
      controller - The GameCubeController object to use for this controller.
  • Method Details

    • getHID

      public CommandGenericHID getHID()
      Get the underlying CommandGenericHID object.
      Returns:
      the wrapped CommandGenericHID object
    • getController

      public GameCubeController getController()
      Get the wrapped controller object.
      Returns:
      the wrapped controller object
    • a

      public Trigger a()
      Constructs a Trigger instance around the A button's digital signal.
      Returns:
      a Trigger instance representing the A button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • a

      public Trigger a(EventLoop loop)
      Constructs a Trigger instance around the A button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the A button's digital signal attached to the given loop.
    • x

      public Trigger x()
      Constructs a Trigger instance around the X button's digital signal.
      Returns:
      a Trigger instance representing the X button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • x

      public Trigger x(EventLoop loop)
      Constructs a Trigger instance around the X button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the X button's digital signal attached to the given loop.
    • b

      public Trigger b()
      Constructs a Trigger instance around the B button's digital signal.
      Returns:
      a Trigger instance representing the B button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • b

      public Trigger b(EventLoop loop)
      Constructs a Trigger instance around the B button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the B button's digital signal attached to the given loop.
    • y

      public Trigger y()
      Constructs a Trigger instance around the Y button's digital signal.
      Returns:
      a Trigger instance representing the Y button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • y

      public Trigger y(EventLoop loop)
      Constructs a Trigger instance around the Y button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Y button's digital signal attached to the given loop.
    • start

      public Trigger start()
      Constructs a Trigger instance around the Start button's digital signal.
      Returns:
      a Trigger instance representing the Start button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • start

      public Trigger start(EventLoop loop)
      Constructs a Trigger instance around the Start button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Start button's digital signal attached to the given loop.
    • Z

      public Trigger Z()
      Constructs a Trigger instance around the Z button's digital signal.
      Returns:
      a Trigger instance representing the Z button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • Z

      public Trigger Z(EventLoop loop)
      Constructs a Trigger instance around the Z button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Z button's digital signal attached to the given loop.
    • dpadUp

      public Trigger dpadUp()
      Constructs a Trigger instance around the Dpad Up button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Up button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • dpadUp

      public Trigger dpadUp(EventLoop loop)
      Constructs a Trigger instance around the Dpad Up button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Up button's digital signal attached to the given loop.
    • dpadDown

      public Trigger dpadDown()
      Constructs a Trigger instance around the Dpad Down button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Down button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • dpadDown

      public Trigger dpadDown(EventLoop loop)
      Constructs a Trigger instance around the Dpad Down button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Down button's digital signal attached to the given loop.
    • dpadLeft

      public Trigger dpadLeft()
      Constructs a Trigger instance around the Dpad Left button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Left button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • dpadLeft

      public Trigger dpadLeft(EventLoop loop)
      Constructs a Trigger instance around the Dpad Left button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Left button's digital signal attached to the given loop.
    • dpadRight

      public Trigger dpadRight()
      Constructs a Trigger instance around the Dpad Right button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Right button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • dpadRight

      public Trigger dpadRight(EventLoop loop)
      Constructs a Trigger instance around the Dpad Right button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Right button's digital signal attached to the given loop.
    • L

      public Trigger L()
      Constructs a Trigger instance around the L button's digital signal.
      Returns:
      a Trigger instance representing the L button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • L

      public Trigger L(EventLoop loop)
      Constructs a Trigger instance around the L button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the L button's digital signal attached to the given loop.
    • R

      public Trigger R()
      Constructs a Trigger instance around the R button's digital signal.
      Returns:
      a Trigger instance representing the R button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:
    • R

      public Trigger R(EventLoop loop)
      Constructs a Trigger instance around the R button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the R button's digital signal attached to the given loop.
    • LTrigger

      public Trigger LTrigger(double threshold, EventLoop loop)
      Constructs a Trigger instance around the axis value of the L Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      loop - the event loop instance to attach the Trigger to.
      Returns:
      a Trigger instance that is true when the L Trigger axis exceeds the provided threshold, attached to the given event loop
    • LTrigger

      public Trigger LTrigger(double threshold)
      Constructs a Trigger instance around the axis value of the L Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      Returns:
      a Trigger instance that is true when the L Trigger axis exceeds the provided threshold, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
    • LTrigger

      public Trigger LTrigger()
      Constructs a Trigger instance around the axis value of the L Trigger. The returned trigger will be true when the axis value is greater than 0.5.
      Returns:
      a Trigger instance that is true when the L Trigger axis exceeds 0.5, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
    • RTrigger

      public Trigger RTrigger(double threshold, EventLoop loop)
      Constructs a Trigger instance around the axis value of the R Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      loop - the event loop instance to attach the Trigger to.
      Returns:
      a Trigger instance that is true when the R Trigger axis exceeds the provided threshold, attached to the given event loop
    • RTrigger

      public Trigger RTrigger(double threshold)
      Constructs a Trigger instance around the axis value of the R Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      Returns:
      a Trigger instance that is true when the R Trigger axis exceeds the provided threshold, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
    • RTrigger

      public Trigger RTrigger()
      Constructs a Trigger instance around the axis value of the R Trigger. The returned trigger will be true when the axis value is greater than 0.5.
      Returns:
      a Trigger instance that is true when the R Trigger axis exceeds 0.5, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
    • getLeftX

      public double getLeftX()
      Get the Left X value of the controller.
      Returns:
      The axis value.
    • getLeftY

      public double getLeftY()
      Get the Left Y value of the controller.
      Returns:
      The axis value.
    • getCStickX

      public double getCStickX()
      Get the C Stick X value of the controller.
      Returns:
      The axis value.
    • getCStickY

      public double getCStickY()
      Get the C Stick Y value of the controller.
      Returns:
      The axis value.
    • getLTrigger

      public double getLTrigger()
      Get the L Trigger value of the controller.
      Returns:
      The axis value.
    • getRTrigger

      public double getRTrigger()
      Get the R Trigger value of the controller.
      Returns:
      The axis value.