001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.math.geometry.point;
031
032import Jama.Matrix;
033
034/**
035 * Interface representing a point in 2d space with x and y coordinates 
036 * @author jon
037 *
038 */
039public interface Point2d extends Coordinate {
040        /**
041         * @return x coordinate of point 
042         */
043        public float getX();
044        
045        /**
046         * Set x coordinate of point 
047         * @param x x-coordinate
048         */
049        public void setX(float x);
050        
051        /**
052         * @return y coordinate of point
053         */
054        public float getY();
055        
056        /**
057         * Set y coordinate of point
058         * @param y y-coordinate
059         */
060        public void setY(float y);
061        
062        /**
063         *      Copy the values of the given point
064         *      into this point.
065         *  @param p The point to copy values from.
066         */
067        public void copyFrom( Point2d p );
068        
069        /**
070         * Clone the point
071         * @return a copy of the point
072         */
073        public Point2d copy();
074
075        /**
076         * Translate the position of the point by the given amounts
077         * @param x x-amount
078         * @param y y-amount
079         */
080        public void translate(float x, float y);
081        
082        /**
083         * Transform the point by the given matrix
084         * @param m
085         * @return a copy
086         */
087        public Point2d transform(Matrix m);
088
089        /**
090         * Take point point from another point such that return = this - a
091         * @param a
092         * @return a new point
093         */
094        public Point2d minus(Point2d a);
095
096        /**
097         * Translate the position of the point by the given amounts
098         * @param v the vector to translate by
099         */
100        void translate(Point2d v);
101}
102