org.cell2d.space

Enum CollisionResponse

java.lang.Object

java.lang.Enum<CollisionResponse>

org.cell2d.space.CollisionResponse

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CollisionResponse>

public enum CollisionResponse
extends java.lang.Enum<CollisionResponse>

A CollisionResponse is a possible response that a MobileObject can have to colliding with a solid surface.

See Also:

MobileObject

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE The MobileObject passes through the surface without its velocity changing and does not record the collision.
SLIDE The MobileObject's movement is blocked by the surface, and the component of its velocity toward the surface is eliminated.
STOP The MobileObject's movement is blocked by the surface, and its velocity is eliminated.

Method Summary

Modifier and Type	Method and Description
static CollisionResponse	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CollisionResponse[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final CollisionResponse NONE

The MobileObject passes through the surface without its velocity changing and does not record the collision.

SLIDE

public static final CollisionResponse SLIDE

The MobileObject's movement is blocked by the surface, and the component of its velocity toward the surface is eliminated.

STOP

public static final CollisionResponse STOP

The MobileObject's movement is blocked by the surface, and its velocity is eliminated.

Method Detail

values

public static CollisionResponse[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CollisionResponse c : CollisionResponse.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CollisionResponse valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null