001/*
002 * $Id: LineSegment.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Kevin Day, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf.parser;
045
046import java.awt.geom.Rectangle2D;
047
048/**
049 * Represents a line segment in a particular coordinate system.  This class is immutable.
050 * @since 5.0.2
051 */
052public class LineSegment {
053
054        /** Start vector of the segment. */
055        private final Vector startPoint;
056        /** End vector of the segment. */
057        private final Vector endPoint;
058        
059        /**
060         * Creates a new line segment.
061         * @param startPoint the start point of a line segment.
062         * @param endPoint the end point of a line segment.
063         */
064        public LineSegment(Vector startPoint, Vector endPoint) {
065                this.startPoint = startPoint;
066                this.endPoint = endPoint;
067        }
068
069        /**
070         * @return the start point
071         */
072        public Vector getStartPoint() {
073                return startPoint;
074        }
075
076        /**
077         * @return the end point
078         */
079        public Vector getEndPoint() {
080                return endPoint;
081        }
082        
083        /**
084         * @return the length of this line segment
085         * @since 5.0.2
086         */
087        public float getLength(){
088            return endPoint.subtract(startPoint).length();
089        }
090        
091        /**
092         * Computes the bounding rectangle for this line segment.  The rectangle has a rotation 0 degrees
093         * with respect to the coordinate system that the line system is in.  For example, if a line segment
094         * is 5 unit long and sits at a 37 degree angle from horizontal, the bounding rectangle will have
095         * origin of the lower left hand end point of the segment, with width = 4 and height = 3. 
096         * @return the bounding rectangle
097         * @since 5.0.2
098         */
099        public Rectangle2D.Float getBoundingRectange(){
100            float x1 = getStartPoint().get(Vector.I1);
101            float y1 = getStartPoint().get(Vector.I2);
102            float x2 = getEndPoint().get(Vector.I1);
103            float y2 = getEndPoint().get(Vector.I2);
104            return new Rectangle2D.Float(Math.min(x1, x2), Math.min(y1, y2), Math.abs(x2-x1), Math.abs(y2-y1));
105        }
106
107        
108        /**
109         * Transforms the segment by the specified matrix
110         * @param m the matrix for the transformation
111         * @return the transformed segment
112         */
113        public LineSegment transformBy(Matrix m){
114            Vector newStart = startPoint.cross(m);
115            Vector newEnd = endPoint.cross(m);
116            return new LineSegment(newStart, newEnd);
117        }
118}