Point2f.java

/*
 * Copyright (c) 2003-onwards Shaven Puppy Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Shaven Puppy' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.shavenpuppy.jglib;

import java.io.Serializable;

/**
 * Floating point 2d coordinate
 */
public class Point2f implements Serializable {

	private static final long serialVersionUID = 1L;

	/** The location */
	private float x, y;

	/**
	 * Constructor for Point.
	 */
	public Point2f() {
		super();
	}

	/**
	 * Constructor for Point.
	 */
	public Point2f(float x, float y) {
		setLocation(x, y);
	}

	/**
	 * Constructor for Point.
	 */
	public Point2f(Point2f p) {
		setLocation(p);
	}

	public void setLocation(float x, float y) {
		this.x = x;
		this.y = y;
	}

	public void setLocation(Point2f p) {
		this.x = p.getX();
		this.y = p.getY();
	}

	public void setX(float x) {
		this.x = x;
	}

	public void setY(float y) {
		this.y = y;
	}

	/**
	 * Translate a point.
	 * @param dx The translation to apply
	 * @param dy The translation to apply
	 */
	public void translate(float dx, float dy) {
		this.x += dx;
		this.y += dy;
	}

	/**
	 * Translate a point.
	 * @param p The translation to apply
	 */
	public void translate(Point2f p) {
		this.x += p.getX();
		this.y += p.getY();
	}

	/**
	 * Un-translate a point.
	 * @param p The translation to apply
	 */
	public void untranslate(Point2f p) {
		this.x -= p.getX();
		this.y -= p.getY();
	}

	/**
	 * Determines whether an instance of <code>Point2D</code> is equal
	 * to this point.  Two instances of <code>Point2D</code> are equal if
	 * the values of their <code>x</code> and <code>y</code> member
	 * fields, representing their position in the coordinate space, are
	 * the same.
	 * @param      obj   an object to be compared with this point
	 * @return     <code>true</code> if the object to be compared is
	 *                     an instance of <code>Point</code> and has
	 *                     the same values; <code>false</code> otherwise
	 */
	@Override
	public boolean equals(Object obj) {
		if (obj instanceof Point2f) {
			Point2f pt = (Point2f) obj;
			return (x == pt.x) && (y == pt.y);
		}
		return super.equals(obj);
	}

	/**
	 * Returns a string representation of this point and its location
	 * in the (<i>x</i>, <i>y</i>) coordinate space. This method is
	 * intended to be used only for debugging purposes, and the content
	 * and format of the returned string may vary between implementations.
	 * The returned string may be empty but may not be <code>null</code>.
	 *
	 * @return  a string representation of this point
	 */
	@Override
	public String toString() {
		return getClass().getName() + "[x=" + x + ",y=" + y + "]";
	}

	/**
	 * Returns the hash code for this <code>Point</code>.
	 *
	 * @return    a hash code for this <code>Point</code>
	 */
	@Override
	public int hashCode() {
		int sum = Float.floatToRawIntBits(x) + Float.floatToRawIntBits(y);
		return sum * (sum + 1) / 2 + (int) x;
	}

	public float getX() {
		return x;
	}

	public float getY() {
		return y;
	}

	public void getLocation(Point2f dest) {
		dest.setLocation(x, y);
	}

}