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. This
036 * interface allows single precision floating point ordinates, however, the
037 * actual backing type can be of any precision, and actual values can be
038 * accessed through the {@link Coordinate} interface.
039 *
040 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
041 *
042 */
043public interface Point2d extends Coordinate {
044        /**
045         * @return x coordinate of point
046         */
047        public float getX();
048
049        /**
050         * Set x coordinate of point
051         *
052         * @param x
053         *            x-coordinate
054         */
055        public void setX(float x);
056
057        /**
058         * @return y coordinate of point
059         */
060        public float getY();
061
062        /**
063         * Set y coordinate of point
064         *
065         * @param y
066         *            y-coordinate
067         */
068        public void setY(float y);
069
070        /**
071         * Copy the values of the given point into this point.
072         *
073         * @param p
074         *            The point to copy values from.
075         */
076        public void copyFrom(Point2d p);
077
078        /**
079         * Clone the point
080         *
081         * @return a copy of the point
082         */
083        public Point2d copy();
084
085        /**
086         * Translate the position of the point by the given amounts
087         *
088         * @param x
089         *            x-amount
090         * @param y
091         *            y-amount
092         */
093        public void translate(float x, float y);
094
095        /**
096         * Transform the point by the given matrix
097         *
098         * @param m
099         * @return a copy
100         */
101        public Point2d transform(Matrix m);
102
103        /**
104         * Take point point from another point such that return = this - a
105         *
106         * @param a
107         * @return a new point
108         */
109        public Point2d minus(Point2d a);
110
111        /**
112         * Translate the position of the point by the given amounts
113         *
114         * @param v
115         *            the vector to translate by
116         */
117        void translate(Point2d v);
118}