model.environment.position

Class Position

java.lang.Object

model.environment.position.Position

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Vector

public class Position
extends java.lang.Object
implements java.lang.Cloneable

Position in the 2D plain.

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
private static float	epsilon An error tolerance.
static Position	NO_POSITION Holder to indicate no position.
float	x The x position.
float	y The y position.

Constructor Summary

Constructors

Constructor and Description
Position(double x, double y) Creates a new position.
Position(float x, float y) Creates a new position.

Method Summary

Modifier and Type	Method and Description
Position	clone()
float	distanceTo(Position other) The distance to another position.
boolean	equals(java.lang.Object other) Checks if this position is the same as an other position.
int	hashCode()
private float	round(double value, int precision) Rounds a value to a certain precision.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_POSITION

public static final Position NO_POSITION

Holder to indicate no position.

epsilon

private static final float epsilon

An error tolerance.

See Also:

Constant Field Values

x

public final float x

The x position.

y

public final float y

The y position.

Constructor Detail

Position

public Position(double x,
                double y)

Creates a new position.

Parameters:

x - x position.

y - y position.

Position

public Position(float x,
                float y)

Creates a new position.

Parameters:

x - x position.

y - y position.

Method Detail

clone

public Position clone()

Overrides:

clone in class java.lang.Object

distanceTo

public float distanceTo(Position other)

The distance to another position.

Parameters:

other - The other position.

Returns:

The distance.

equals

public boolean equals(java.lang.Object other)

Checks if this position is the same as an other position.

Overrides:

equals in class java.lang.Object

Parameters:

other - The other position.

Returns:

True if they are equal, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

round

private float round(double value,
                    int precision)

Rounds a value to a certain precision.

Parameters:

value - The value.

precision - The precision.

Returns:

The rounded value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object