org.cell2d.control

Class ControllerDirectionControl

java.lang.Object

org.cell2d.control.Control

org.cell2d.control.ControllerControl

org.cell2d.control.ControllerDirectionControl

public class ControllerDirectionControl
extends ControllerControl

A ControllerDirectionControl is a ControllerControl that represents a Direction - up, down, left, or right - in which the primary axes of a game controller can be moved. A controller's primary axes are typically those of a directional pad or left control stick. A ControllerDirectionControl is considered pressed when the axes are moved into its Direction, relative to their neutral position, and released when they are moved out of its Direction. The axes can be in a pair of adjacent Directions, such as up and right, at the same time.

See Also:

Direction

Field Summary

Fields inherited from class org.cell2d.control.ControllerControl

MAX_CONTROLLERS

Constructor Summary

Constructors

Constructor and Description
ControllerDirectionControl(int controllerNum, Direction direction) Constructs a ControllerDirectionControl that represents the specified Direction on the primary axes of 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 ControllerDirectionControl that is equal to this ControllerDirectionControl.
Direction	getDirection() Returns this ControllerButtonControl's Direction.
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

Constructor Detail

ControllerDirectionControl

public ControllerDirectionControl(int controllerNum,
                                  Direction direction)
                           throws InvalidControlException

Constructs a ControllerDirectionControl that represents the specified Direction on the primary axes of the controller with the specified number.

Parameters:

controllerNum - The number of this ControllerDirectionControl's controller

direction - This ControllerDirectionControl's Direction

Throws:

InvalidControlException - if the specified controller number is invalid or the specified Direction is null

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 ControllerDirectionControl that is equal to this ControllerDirectionControl. Two ControllerDirectionControls are equal if and only if they represent the same Direction on the same controller.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to be compared with this ControllerDirectionControl

Returns:

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

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

getDirection

public final Direction getDirection()

Returns this ControllerButtonControl's Direction.

Returns:

This ControllerButtonControl's Direction