ou4

Class Position

java.lang.Object

ou4.Position

public class Position
extends java.lang.Object

A point representing a location in the coordinate matrix.

Constructor Summary

Constructors

Constructor and Description
Position(float xPos, float yPos) Construct and initialize a position.

Method Summary

Modifier and Type	Method and Description
static float	calculateDistance(Position a, Position b) Calculates the distance between two positions.
boolean	equals(java.lang.Object o) Checks if two Positions are the same
float	getX() Returns the x coordinate.
float	getY() Returns the y coordinate.
java.lang.String	toString() Creates a string of the position

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Position

public Position(float xPos,
                float yPos)

Construct and initialize a position.

Parameters:

xPos - The x coordinate.

yPos - The y coordinate.

Method Detail

getX

public float getX()

Returns the x coordinate.

Returns:

xPos The x coordinate.

getY

public float getY()

Returns the y coordinate.

Returns:

yPos The y coordinate.

equals

public boolean equals(java.lang.Object o)

Checks if two Positions are the same

Overrides:

equals in class java.lang.Object

Parameters:

o - Object to compare with

Returns:

true if objects are the same

calculateDistance

public static float calculateDistance(Position a,
                                      Position b)

Calculates the distance between two positions.

Parameters:

a - the first position

b - the second position

Returns:

nodeDistance the distance between the positions

toString

public java.lang.String toString()

Creates a string of the position

Overrides:

toString in class java.lang.Object

Returns:

String of containing position data.