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.path;
031
032import java.util.Iterator;
033
034import org.openimaj.math.geometry.GeometricObject2d;
035import org.openimaj.math.geometry.line.Line2d;
036import org.openimaj.math.geometry.point.Point2d;
037
038/**
039 * A {@link Path2d} represents an arbitrary path between 2 points in a 2D space.
040 *
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 */
043public interface Path2d extends GeometricObject2d {
044        /**
045         * Get the beginning of the path
046         *
047         * @return the beginning
048         */
049        public Point2d begin();
050
051        /**
052         * Get the end of the path
053         *
054         * @return the end
055         */
056        public Point2d end();
057
058        /**
059         * Convert the path to a polyline representation
060         *
061         * @return a polyline representation of the path
062         */
063        public Polyline asPolyline();
064
065        /**
066         * Convert the path to a iterated polyline representation
067         *
068         * @return an iterated polyline representation of the path
069         */
070        public Iterator<Line2d> lineIterator();
071
072        /**
073         * Calculate the length of the path
074         * 
075         * @return the path length
076         */
077        public double calculateLength();
078}