Open Source Repository

Home /itextpdf/itextpdf-5.1.2 | Repository Home


com/itextpdf/text/pdf/parser/LineSegment.java
/*
 * $Id: LineSegment.java 4784 2011-03-15 08:33:00Z blowagie $
 *
 * This file is part of the iText (R) project.
 * Copyright (c) 1998-2011 1T3XT BVBA
 * Authors: Bruno Lowagie, Kevin Day, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License for more details.
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * a covered work must retain the producer line in every PDF that is created
 * or manipulated using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: [email protected]
 */
package com.itextpdf.text.pdf.parser;

import java.awt.geom.Rectangle2D;

/**
 * Represents a line segment in a particular coordinate system.  This class is immutable.
 @since 5.0.2
 */
public class LineSegment {

  /** Start vector of the segment. */
  private final Vector startPoint;
  /** End vector of the segment. */
  private final Vector endPoint;
  
  /**
   * Creates a new line segment.
   @param startPoint the start point of a line segment.
   @param endPoint the end point of a line segment.
   */
  public LineSegment(Vector startPoint, Vector endPoint) {
    this.startPoint = startPoint;
    this.endPoint = endPoint;
  }

  /**
   @return the start point
   */
  public Vector getStartPoint() {
    return startPoint;
  }

  /**
   @return the end point
   */
  public Vector getEndPoint() {
    return endPoint;
  }
  
  /**
   @return the length of this line segment
   @since 5.0.2
   */
  public float getLength(){
      return endPoint.subtract(startPoint).length();
  }
  
  /**
   * Computes the bounding rectangle for this line segment.  The rectangle has a rotation 0 degrees
   * with respect to the coordinate system that the line system is in.  For example, if a line segment
   * is 5 unit long and sits at a 37 degree angle from horizontal, the bounding rectangle will have
   * origin of the lower left hand end point of the segment, with width = 4 and height = 3. 
   @return the bounding rectangle
   @since 5.0.2
   */
  public Rectangle2D.Float getBoundingRectange(){
      float x1 = getStartPoint().get(Vector.I1);
      float y1 = getStartPoint().get(Vector.I2);
      float x2 = getEndPoint().get(Vector.I1);
      float y2 = getEndPoint().get(Vector.I2);
      return new Rectangle2D.Float(Math.min(x1, x2), Math.min(y1, y2), Math.abs(x2-x1), Math.abs(y2-y1));
  }

  
  /**
   * Transforms the segment by the specified matrix
   @param m the matrix for the transformation
   @return the transformed segment
   */
  public LineSegment transformBy(Matrix m){
      Vector newStart = startPoint.cross(m);
      Vector newEnd = endPoint.cross(m);
      return new LineSegment(newStart, newEnd);
  }
}