org.cell2d.control

Class ControllerButtonControl

java.lang.Object

org.cell2d.control.Control

org.cell2d.control.ControllerControl

org.cell2d.control.ControllerButtonControl

public class ControllerButtonControl
extends ControllerControl

A ControllerButtonControl is a ControllerControl that represents a button on a game controller. The button is specified by a number that ranges from 0 to MAX_BUTTONS - 1 inclusive.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BUTTONS The maximum number of buttons on each controller that Cell2D recognizes.

Fields inherited from class org.cell2d.control.ControllerControl

MAX_CONTROLLERS

Constructor Summary

Constructors

Constructor and Description
ControllerButtonControl(int controllerNum, int buttonNum) Constructs a ControllerButtonControl that represents the button with the specified number on the controller with the specified number.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether the specified object is a ControllerButtonControl that is equal to this ControllerButtonControl.
int	getButtonNum() Returns the number of this ControllerButtonControl's button.
java.lang.String	getName() Returns a short, descriptive, and unique String name for this Control.
int	hashCode()

Methods inherited from class org.cell2d.control.ControllerControl

getControllerNum

Methods inherited from class org.cell2d.control.Control

getControl

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_BUTTONS

public static final int MAX_BUTTONS

The maximum number of buttons on each controller that Cell2D recognizes.

See Also:

Constant Field Values

Constructor Detail

ControllerButtonControl

public ControllerButtonControl(int controllerNum,
                               int buttonNum)
                        throws InvalidControlException

Constructs a ControllerButtonControl that represents the button with the specified number on the controller with the specified number.

Parameters:

controllerNum - The number of this ControllerButtonControl's controller

buttonNum - The number of this ControllerButtonControl's button

Throws:

InvalidControlException - if the specified controller or button number is invalid

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Returns whether the specified object is a ControllerButtonControl that is equal to this ControllerButtonControl. Two ControllerButtonControls are equal if and only if they represent the same button on the same controller.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to be compared with this ControllerButtonControl

Returns:

Whether the specified object is a ControllerButtonControl that is equal to this ControllerButtonControl

getName

public java.lang.String getName()

Description copied from class: Control

Returns a short, descriptive, and unique String name for this Control. The name will be no more than 6 characters long and contain only ASCII characters and no whitespace. Two distinct Control objects have the same name if and only if they are equal.

Specified by:

getName in class Control

Returns:

This Control's name

getButtonNum

public final int getButtonNum()

Returns the number of this ControllerButtonControl's button.

Returns:

The number of this ControllerButtonControl's button