Class to control a simulated PS4 controller. More...

#include <frc/simulation/PS4ControllerSim.h>

Inheritance diagram for frc::sim::PS4ControllerSim:

Public Member Functions
	PS4ControllerSim (const PS4Controller &joystick)
	Constructs from a PS4Controller object.

	PS4ControllerSim (int port)
	Constructs from a joystick port number.

void	SetLeftX (double value)
	Change the left X value of the controller's joystick.

void	SetLeftY (double value)
	Change the left Y value of the controller's joystick.

void	SetRightX (double value)
	Change the right X value of the controller's joystick.

void	SetRightY (double value)
	Change the right Y value of the controller's joystick.

void	SetL2Axis (double value)
	Change the value of the left trigger 2 axis on the controller.

void	SetR2Axis (double value)
	Change the value of the right trigger 2 axis on the controller.

void	SetSquareButton (bool value)
	Change the value of the square button on the controller.

void	SetCrossButton (bool value)
	Change the value of the cross button on the controller.

void	SetCircleButton (bool value)
	Change the value of the circle button on the controller.

void	SetTriangleButton (bool value)
	Change the value of the triangle button on the controller.

void	SetL1Button (bool value)
	Change the value of the left trigger 1 button on the controller.

void	SetR1Button (bool value)
	Change the value of the right trigger 1 button on the controller.

void	SetL2Button (bool value)
	Change the value of the left trigger 2 button on the controller.

void	SetR2Button (bool value)
	Change the value of the right trigger 2 button on the controller.

void	SetShareButton (bool value)
	Change the value of the share button on the controller.

void	SetOptionsButton (bool value)
	Change the value of the options button on the controller.

void	SetL3Button (bool value)
	Change the value of the L3 (left stick) button on the controller.

void	SetR3Button (bool value)
	Change the value of the R3 (right stick) button on the controller.

void	SetPSButton (bool value)
	Change the value of the PlayStation button on the controller.

void	SetTouchpadButton (bool value)
	Change the value of the touchpad button on the controller.

void	SetTouchpad (bool value)
	Change the value of the touchpad button on the controller.

Public Member Functions inherited from frc::sim::GenericHIDSim
	GenericHIDSim (const GenericHID &joystick)
	Constructs from a GenericHID object.

	GenericHIDSim (int port)
	Constructs from a joystick port number.

void	NotifyNewData ()
	Updates joystick data so that new values are visible to the user program.

void	SetRawButton (int button, bool value)
	Set the value of a given button.

void	SetRawAxis (int axis, double value)
	Set the value of a given axis.

void	SetPOV (int pov, int value)
	Set the value of a given POV.

void	SetPOV (int value)
	Set the value of the default POV (port 0).

void	SetAxisCount (int count)
	Set the axis count of this device.

void	SetPOVCount (int count)
	Set the POV count of this device.

void	SetButtonCount (int count)
	Set the button count of this device.

void	SetType (GenericHID::HIDType type)
	Set the type of this device.

void	SetName (const char *name)
	Set the name of this device.

void	SetAxisType (int axis, int type)
	Set the type of an axis.

bool	GetOutput (int outputNumber)
	Read the output of a button.

int64_t	GetOutputs ()
	Get the encoded 16-bit integer that passes button values.

double	GetRumble (GenericHID::RumbleType type)
	Get the joystick rumble.

Additional Inherited Members
Protected Attributes inherited from frc::sim::GenericHIDSim
int	m_port
	GenericHID port.

Detailed Description

Class to control a simulated PS4 controller.

Constructor & Destructor Documentation

◆ PS4ControllerSim() [1/2]

frc::sim::PS4ControllerSim::PS4ControllerSim ( const PS4Controller & joystick )

explicit

Constructs from a PS4Controller object.

Parameters

joystick controller to simulate

◆ PS4ControllerSim() [2/2]

frc::sim::PS4ControllerSim::PS4ControllerSim ( int port )

explicit

Constructs from a joystick port number.

Parameters

port	port number

Member Function Documentation

◆ SetCircleButton()

void frc::sim::PS4ControllerSim::SetCircleButton ( bool value )

Change the value of the circle button on the controller.

Parameters

value the new value

◆ SetCrossButton()

void frc::sim::PS4ControllerSim::SetCrossButton ( bool value )

Change the value of the cross button on the controller.

Parameters

value the new value

◆ SetL1Button()

void frc::sim::PS4ControllerSim::SetL1Button ( bool value )

Change the value of the left trigger 1 button on the controller.

Parameters

value the new value

◆ SetL2Axis()

void frc::sim::PS4ControllerSim::SetL2Axis ( double value )

Change the value of the left trigger 2 axis on the controller.

Parameters

value the new value

◆ SetL2Button()

void frc::sim::PS4ControllerSim::SetL2Button ( bool value )

Change the value of the left trigger 2 button on the controller.

Parameters

value the new value

◆ SetL3Button()

void frc::sim::PS4ControllerSim::SetL3Button ( bool value )

Change the value of the L3 (left stick) button on the controller.

Parameters

value the new value

◆ SetLeftX()

void frc::sim::PS4ControllerSim::SetLeftX ( double value )

Change the left X value of the controller's joystick.

Parameters

value the new value

◆ SetLeftY()

void frc::sim::PS4ControllerSim::SetLeftY ( double value )

Change the left Y value of the controller's joystick.

Parameters

value the new value

◆ SetOptionsButton()

void frc::sim::PS4ControllerSim::SetOptionsButton ( bool value )

Change the value of the options button on the controller.

Parameters

value the new value

◆ SetPSButton()

void frc::sim::PS4ControllerSim::SetPSButton ( bool value )

Change the value of the PlayStation button on the controller.

Parameters

value the new value

◆ SetR1Button()

void frc::sim::PS4ControllerSim::SetR1Button ( bool value )

Change the value of the right trigger 1 button on the controller.

Parameters

value the new value

◆ SetR2Axis()

void frc::sim::PS4ControllerSim::SetR2Axis ( double value )

Change the value of the right trigger 2 axis on the controller.

Parameters

value the new value

◆ SetR2Button()

void frc::sim::PS4ControllerSim::SetR2Button ( bool value )

Change the value of the right trigger 2 button on the controller.

Parameters

value the new value

◆ SetR3Button()

void frc::sim::PS4ControllerSim::SetR3Button ( bool value )

Change the value of the R3 (right stick) button on the controller.

Parameters

value the new value

◆ SetRightX()

void frc::sim::PS4ControllerSim::SetRightX ( double value )

Change the right X value of the controller's joystick.

Parameters

value the new value

◆ SetRightY()

void frc::sim::PS4ControllerSim::SetRightY ( double value )

Change the right Y value of the controller's joystick.

Parameters

value the new value

◆ SetShareButton()

void frc::sim::PS4ControllerSim::SetShareButton ( bool value )

Change the value of the share button on the controller.

Parameters

value the new value

◆ SetSquareButton()

void frc::sim::PS4ControllerSim::SetSquareButton ( bool value )

Change the value of the square button on the controller.

Parameters

value the new value

◆ SetTouchpad()

void frc::sim::PS4ControllerSim::SetTouchpad ( bool value )

Change the value of the touchpad button on the controller.

Parameters

value the new value

Deprecated: Use SetTouchpadButton instead. This function is deprecated for removal to make function names consistent to allow the HID classes to be automatically generated.

◆ SetTouchpadButton()

void frc::sim::PS4ControllerSim::SetTouchpadButton ( bool value )

Change the value of the touchpad button on the controller.

Parameters

value the new value

◆ SetTriangleButton()

void frc::sim::PS4ControllerSim::SetTriangleButton ( bool value )

Change the value of the triangle button on the controller.

Parameters

value the new value

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

frc/simulation/PS4ControllerSim.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PS4ControllerSim() [1/2]

◆ PS4ControllerSim() [2/2]

Member Function Documentation

◆ SetCircleButton()

◆ SetCrossButton()

◆ SetL1Button()

◆ SetL2Axis()

◆ SetL2Button()

◆ SetL3Button()

◆ SetLeftX()

◆ SetLeftY()

◆ SetOptionsButton()

◆ SetPSButton()

◆ SetR1Button()

◆ SetR2Axis()

◆ SetR2Button()

◆ SetR3Button()

◆ SetRightX()

◆ SetRightY()

◆ SetShareButton()

◆ SetSquareButton()

◆ SetTouchpad()

◆ SetTouchpadButton()

◆ SetTriangleButton()