ihs.apcs.spacebattle

Class Point

java.lang.Object

ihs.apcs.spacebattle.Point

public class Point
extends java.lang.Object

Represents a point in space as an (x, y) coordinate.

Since:

0.1

Constructor Summary

Constructors

Constructor and Description
Point(double[] coords) Creates a new point from an array.
Point(double x, double y) Creates a new point with the given coordinates.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Point other)
int	getAngleTo(Point other) Gets the absolute angle between this and another Point in space.
Point	getClosestMappedPoint(Point other, int width, int height) Maps the other point across world boundaries to return the closest form of the given point.
double	getDistanceTo(Point other) Gets the distance from this to another Point in space using the standard distance formula.
Point	getPointAt(double angle, double distance) Returns a new point which represents the location at the given angle and distance away from this point.
double	getX() Gets the x-coordinate of this point.
double	getY() Gets the y-coordinate of this point.
boolean	isCloseTo(Point other, double tolerance) Returns true if the given point's X & Y values are within the tolerance of this point's X & Y values.
boolean	isInEllipse(Point center, int major, int minor, int orientation) Checks if this point is in an Ellipse with the given center point, major/minor axis lengths at the given orientation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Point

public Point(double x,
     double y)

Creates a new point with the given coordinates.

Parameters:

x - the x-coordinate

y - the y-coordinate

Point

public Point(double[] coords)

Creates a new point from an array. The first element of the array is considered to be the x-coordinate and the second element is the y-coordinate.

Parameters:

coords - the coordinates of the point

Method Detail

getX

public double getX()

Gets the x-coordinate of this point.

Returns:

the x-coordinate

getY

public double getY()

Gets the y-coordinate of this point.

Returns:

the y-coordinate

getDistanceTo

public double getDistanceTo(Point other)

Gets the distance from this to another Point in space using the standard distance formula.

Parameters:

other - the location to which to calculate the distance

Returns:

the distance between this point and other

getAngleTo

public int getAngleTo(Point other)

Gets the absolute angle between this and another Point in space. More specifically, calculates the counter-clockwise angle from due east (0 degrees) to a line containing both this and other.

To determine the amount of rotation necessary to face the argument, a ship's current orientation should be subtracted from the result of this method.

Parameters:

other - the location to which to calculate the angle

Returns:

the absolute angle from this to other

getPointAt

public Point getPointAt(double angle,
               double distance)

Returns a new point which represents the location at the given angle and distance away from this point.

Parameters:

angle - from due east (0 degrees)

distance - from this point

Returns:

a new Point the given angle/distance away from this point

Since:

1.2

isInEllipse

public boolean isInEllipse(Point center,
                  int major,
                  int minor,
                  int orientation)

Checks if this point is in an Ellipse with the given center point, major/minor axis lengths at the given orientation.

Parameters:

center - of the ellipse

major - axis length

minor - axis length

orientation - angle of the major axis

Returns:

true if this point is within the specified ellipse

Since:

1.2

getClosestMappedPoint

public Point getClosestMappedPoint(Point other,
                          int width,
                          int height)

Maps the other point across world boundaries to return the closest form of the given point. Note: This point may map outside the bounds of the world, it should only be used for orientation purposes and distance only.

Parameters:

other - point to map from this one

width - of the world

height - of the world

Returns:

form of the point that is closest to this one

Since:

1.2

isCloseTo

public boolean isCloseTo(Point other,
                double tolerance)

Returns true if the given point's X & Y values are within the tolerance of this point's X & Y values. This is a 'box' test.

Parameters:

other - location to test against

tolerance - amount to test in range against

Returns:

true if the points are close to one another.

Since:

1.2

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(Point other)