001/*
002 * $Id: PolylineShapeIterator.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, Paulo Soares, 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.internal;
045
046import java.awt.geom.AffineTransform;
047import java.awt.geom.PathIterator;
048import java.util.NoSuchElementException;
049import com.itextpdf.text.error_messages.MessageLocalization;
050/**
051 * PathIterator for PolylineShape.
052 * This class was originally written by wil - amristar.com.au
053 * and integrated into iText by Bruno.
054 */
055public class PolylineShapeIterator implements PathIterator {
056        /** The polyline over which we are going to iterate. */
057        protected PolylineShape poly;
058        /** an affine transformation to be performed on the polyline. */
059        protected AffineTransform affine;
060        /** the index of the current segment in the iterator. */
061        protected int index;
062        
063        /** Creates a PolylineShapeIterator. */
064        PolylineShapeIterator(PolylineShape l, AffineTransform at) {
065                this.poly = l;
066                this.affine = at;
067        }
068        
069        /**
070         * Returns the coordinates and type of the current path segment in
071         * the iteration. The return value is the path segment type:
072         * SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE.
073         * A double array of length 6 must be passed in and may be used to
074         * store the coordinates of the point(s).
075         * Each point is stored as a pair of double x,y coordinates.
076         * SEG_MOVETO and SEG_LINETO types will return one point,
077         * SEG_QUADTO will return two points,
078         * SEG_CUBICTO will return 3 points
079         * and SEG_CLOSE will not return any points.
080         * @see #SEG_MOVETO
081         * @see #SEG_LINETO
082         * @see #SEG_QUADTO
083         * @see #SEG_CUBICTO
084         * @see #SEG_CLOSE
085         * @see java.awt.geom.PathIterator#currentSegment(double[])
086         */
087        public int currentSegment(double[] coords) {
088                if (isDone()) {
089                        throw new NoSuchElementException(MessageLocalization.getComposedMessage("line.iterator.out.of.bounds"));
090                }
091                int type = (index==0)?SEG_MOVETO:SEG_LINETO;
092                coords[0] = poly.x[index];
093                coords[1] = poly.y[index];
094                if (affine != null) {
095                        affine.transform(coords, 0, coords, 0, 1);
096                }
097                return type;
098        }
099        
100        /**
101         * Returns the coordinates and type of the current path segment in
102         * the iteration. The return value is the path segment type:
103         * SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE.
104         * A double array of length 6 must be passed in and may be used to
105         * store the coordinates of the point(s).
106         * Each point is stored as a pair of double x,y coordinates.
107         * SEG_MOVETO and SEG_LINETO types will return one point,
108         * SEG_QUADTO will return two points,
109         * SEG_CUBICTO will return 3 points
110         * and SEG_CLOSE will not return any points.
111         * @see #SEG_MOVETO
112         * @see #SEG_LINETO
113         * @see #SEG_QUADTO
114         * @see #SEG_CUBICTO
115         * @see #SEG_CLOSE
116         * @see java.awt.geom.PathIterator#currentSegment(float[])
117         */
118        public int currentSegment(float[] coords) {
119                if (isDone()) {
120                        throw new NoSuchElementException(MessageLocalization.getComposedMessage("line.iterator.out.of.bounds"));
121                }
122                int type = (index==0)?SEG_MOVETO:SEG_LINETO;
123                coords[0] = poly.x[index];
124                coords[1] = poly.y[index];
125                if (affine != null) {
126                        affine.transform(coords, 0, coords, 0, 1);
127                }
128                return type;
129        }
130
131        /**
132         * Return the winding rule for determining the insideness of the
133         * path.
134         * @see #WIND_EVEN_ODD
135         * @see #WIND_NON_ZERO
136         * @see java.awt.geom.PathIterator#getWindingRule()
137         */
138        public int getWindingRule() {
139                return WIND_NON_ZERO;
140        }
141
142        /**
143         * Tests if there are more points to read.
144         * @return true if there are more points to read
145         * @see java.awt.geom.PathIterator#isDone()
146         */
147        public boolean isDone() {
148                return (index >= poly.np);
149        }
150
151        /**
152         * Moves the iterator to the next segment of the path forwards
153         * along the primary direction of traversal as long as there are
154         * more points in that direction.
155         * @see java.awt.geom.PathIterator#next()
156         */
157        public void next() {
158                index++;
159        }
160
161}