com.github.ojil.core.Point Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojil-core Show documentation
Open Java Imaging Library.
There is a newer version: 0.0.11
/*
 * Point.java
 *
 * Created on September 9, 2006, 1:46 PM
 *
 * To change this template, choose Tools | Template Manager
 * and open the template in the editor.
 *
 * Copyright 2006 by Jon A. Webb
 *     This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Lesser General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Lesser General Public License for more details.
 *
 *    You should have received a copy of the Lesser GNU General Public License
 *    along with this program.  If not, see .
 *
 */

package com.github.ojil.core;

import java.io.Serializable;

/**
 * Point: an object holding a 2-dimensional point coordinate
 * 
 * @author webb
 */
public class Point implements Serializable {
    private static final long serialVersionUID = 2890838604858533735L;
    
    private int mnX;
    private int mnY;
    
    /**
     * Creates a new instance of Point
     *
     * @param mnX
     *            the Point's x position (column)
     * @param mnY
     *            the Point's y position (row)
     */
    public Point(final int nX, final int nY) {
        mnX = nX;
        mnY = nY;
    }
    
    /**
     * Offset a point by a 2-dimensional vector Vec2, returning modified point.
     * 
     * @param v
     *            Vec2 to offset this point by
     * @return modified Point
     */
    public Point add(final Vec2 v) {
        mnX += v.getX();
        mnY += v.getY();
        return this;
    }
    
    /**
     * Make a copy of this Point, so that modifications by other operations
     * don't affect the original.
     */
    @Override
    public Point clone() {
        return new Point(mnX, mnY);
    }
    
    /**
     * Compute a vector from another Point to this
     * 
     * @param pos
     *            starting point
     * @return a Vec2 which, when added to pos, will give this
     */
    public Vec2 diff(final Point pos) {
        return new Vec2(mnX - pos.mnX, mnY - pos.mnY);
    }
    
    /**
     * Returns true iff this Point equals the first parameter.
     */
    @Override
    public boolean equals(final Object o) {
        if (!(o instanceof Point)) {
            return false;
        }
        final Point p = (Point) o;
        return (mnX == p.mnX) && (mnY == p.mnY);
    }
    
    /**
     * Return the point's x-coordinate.
     * 
     * @return the horizontal position of the point.
     */
    public int getX() {
        return mnX;
    }
    
    /**
     * Return the point's y-coordinate.
     * 
     * @return the vertical position of the point.
     */
    public int getY() {
        return mnY;
    }
    
    @Override
    public int hashCode() {
        int hash = 5;
        hash = (67 * hash) + mnX;
        hash = (67 * hash) + mnY;
        return hash;
    }
    
    /**
     * Offset a point by a certain x,y
     * 
     * @param x
     *            x offset
     * @param y
     *            y offset
     * @return modified Point
     */
    public Point offset(final int nX, final int nY) {
        mnX += nX;
        mnY += nY;
        return this;
    }
    
    /**
     * Change the (x,y) coordinates of this Point
     * 
     * @param nX
     *            new X coordinate
     * @param nY
     *            new Y coordinate
     * @return the modified Point
     */
    public Point setXY(final int nX, final int nY) {
        mnX = nX;
        mnY = nY;
        return this;
    }
    
    /**
     * Implement toString
     * 
     * @return Object address + (x,y)
     */
    @Override
    public String toString() {
        return super.toString() + "(" + new Integer(mnX).toString() + "," + new Integer(mnY).toString() + ")";
    }
}