FlatteningPathIterator (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.awt.geom.FlatteningPathIterator

• All Implemented Interfaces:
  PathIterator

public class FlatteningPathIterator
extends Object
implements PathIterator
The FlatteningPathIterator class returns a flattened view of another PathIterator object. Other Shape classes can use this class to provide flattening behavior for their paths without having to perform the interpolation calculations themselves.

• • Field Summary

     * ### Fields inherited from interface java.awt.geom.[PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom")  
     `[SEG_CLOSE](../../../java/awt/geom/PathIterator.html#SEG%5FCLOSE), [SEG_CUBICTO](../../../java/awt/geom/PathIterator.html#SEG%5FCUBICTO), [SEG_LINETO](../../../java/awt/geom/PathIterator.html#SEG%5FLINETO), [SEG_MOVETO](../../../java/awt/geom/PathIterator.html#SEG%5FMOVETO), [SEG_QUADTO](../../../java/awt/geom/PathIterator.html#SEG%5FQUADTO), [WIND_EVEN_ODD](../../../java/awt/geom/PathIterator.html#WIND%5FEVEN%5FODD), [WIND_NON_ZERO](../../../java/awt/geom/PathIterator.html#WIND%5FNON%5FZERO)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  FlatteningPathIterator(PathIterator src, double flatness)	Constructs a new FlatteningPathIterator object that flattens a path as it iterates over it.
  FlatteningPathIterator(PathIterator src, double flatness, int limit)	Constructs a new FlatteningPathIterator object that flattens a path as it iterates over it.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  int	currentSegment(double[] coords)	Returns the coordinates and type of the current path segment in the iteration.
  int	currentSegment(float[] coords)	Returns the coordinates and type of the current path segment in the iteration.
  double	getFlatness()	Returns the flatness of this iterator.
  int	getRecursionLimit()	Returns the recursion limit of this iterator.
  int	getWindingRule()	Returns the winding rule for determining the interior of the path.
  boolean	isDone()	Tests if the iteration is complete.
  void	next()	Moves the iterator to the next segment of the path forwards along the primary direction of traversal as long as there are more points in that direction.

     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### FlatteningPathIterator  
     public FlatteningPathIterator([PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom") src,  
                                   double flatness)  
     Constructs a new `FlatteningPathIterator` object that flattens a path as it iterates over it. The iterator does not subdivide any curve read from the source iterator to more than 10 levels of subdivision which yields a maximum of 1024 line segments per curve.  
     Parameters:  
     `src` \- the original unflattened path being iterated over  
     `flatness` \- the maximum allowable distance between the control points and the flattened curve  
     * #### FlatteningPathIterator  
     public FlatteningPathIterator([PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom") src,  
                                   double flatness,  
                                   int limit)  
     Constructs a new `FlatteningPathIterator` object that flattens a path as it iterates over it. The `limit` parameter allows you to control the maximum number of recursive subdivisions that the iterator can make before it assumes that the curve is flat enough without measuring against the `flatness` parameter. The flattened iteration therefore never generates more than a maximum of `(2^limit)` line segments per curve.  
     Parameters:  
     `src` \- the original unflattened path being iterated over  
     `flatness` \- the maximum allowable distance between the control points and the flattened curve  
     `limit` \- the maximum number of recursive subdivisions allowed for any curved segment  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if`flatness` or `limit` is less than zero  

  • Method Detail

    * #### getFlatness  
    public double getFlatness()  
    Returns the flatness of this iterator.  
    Returns:  
    the flatness of this `FlatteningPathIterator`.  
    * #### getRecursionLimit  
    public int getRecursionLimit()  
    Returns the recursion limit of this iterator.  
    Returns:  
    the recursion limit of this`FlatteningPathIterator`.  
    * #### getWindingRule  
    public int getWindingRule()  
    Returns the winding rule for determining the interior of the path.  
    Specified by:  
    `[getWindingRule](../../../java/awt/geom/PathIterator.html#getWindingRule--)` in interface `[PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom")`  
    Returns:  
    the winding rule of the original unflattened path being iterated over.  
    See Also:  
    [PathIterator.WIND\_EVEN\_ODD](../../../java/awt/geom/PathIterator.html#WIND%5FEVEN%5FODD), [PathIterator.WIND\_NON\_ZERO](../../../java/awt/geom/PathIterator.html#WIND%5FNON%5FZERO)  
    * #### isDone  
    public boolean isDone()  
    Tests if the iteration is complete.  
    Specified by:  
    `[isDone](../../../java/awt/geom/PathIterator.html#isDone--)` in interface `[PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom")`  
    Returns:  
    `true` if all the segments have been read; `false` otherwise.  
    * #### next  
    public void next()  
    Moves the iterator to the next segment of the path forwards along the primary direction of traversal as long as there are more points in that direction.  
    Specified by:  
    `[next](../../../java/awt/geom/PathIterator.html#next--)` in interface `[PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom")`  
    * #### currentSegment  
    public int currentSegment(float[] coords)  
    Returns the coordinates and type of the current path segment in the iteration. The return value is the path segment type: SEG\_MOVETO, SEG\_LINETO, or SEG\_CLOSE. A float array of length 6 must be passed in and can be used to store the coordinates of the point(s). Each point is stored as a pair of float x,y coordinates. SEG\_MOVETO and SEG\_LINETO types return one point, and SEG\_CLOSE does not return any points.  
    Specified by:  
    `[currentSegment](../../../java/awt/geom/PathIterator.html#currentSegment-float:A-)` in interface `[PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom")`  
    Parameters:  
    `coords` \- an array that holds the data returned from this method  
    Returns:  
    the path segment type of the current path segment.  
    Throws:  
    `[NoSuchElementException](../../../java/util/NoSuchElementException.html "class in java.util")` \- if there are no more elements in the flattening path to be returned.  
    See Also:  
    [PathIterator.SEG\_MOVETO](../../../java/awt/geom/PathIterator.html#SEG%5FMOVETO), [PathIterator.SEG\_LINETO](../../../java/awt/geom/PathIterator.html#SEG%5FLINETO), [PathIterator.SEG\_CLOSE](../../../java/awt/geom/PathIterator.html#SEG%5FCLOSE)  
    * #### currentSegment  
    public int currentSegment(double[] coords)  
    Returns the coordinates and type of the current path segment in the iteration. The return value is the path segment type: SEG\_MOVETO, SEG\_LINETO, or SEG\_CLOSE. A double array of length 6 must be passed in and can be used to store the coordinates of the point(s). Each point is stored as a pair of double x,y coordinates. SEG\_MOVETO and SEG\_LINETO types return one point, and SEG\_CLOSE does not return any points.  
    Specified by:  
    `[currentSegment](../../../java/awt/geom/PathIterator.html#currentSegment-double:A-)` in interface `[PathIterator](../../../java/awt/geom/PathIterator.html "interface in java.awt.geom")`  
    Parameters:  
    `coords` \- an array that holds the data returned from this method  
    Returns:  
    the path segment type of the current path segment.  
    Throws:  
    `[NoSuchElementException](../../../java/util/NoSuchElementException.html "class in java.util")` \- if there are no more elements in the flattening path to be returned.  
    See Also:  
    [PathIterator.SEG\_MOVETO](../../../java/awt/geom/PathIterator.html#SEG%5FMOVETO), [PathIterator.SEG\_LINETO](../../../java/awt/geom/PathIterator.html#SEG%5FLINETO), [PathIterator.SEG\_CLOSE](../../../java/awt/geom/PathIterator.html#SEG%5FCLOSE)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.