Path2D.Float (Java Platform SE 6) (original) (raw)

java.awt.geom

Class Path2D.Float

java.lang.Object java.awt.geom.Path2D java.awt.geom.Path2D.Float

All Implemented Interfaces:

Shape, Serializable, Cloneable

Direct Known Subclasses:

GeneralPath

Enclosing class:

Path2D

public static class Path2D.Float

extends Path2D

implements Serializable

The Float class defines a geometric path with coordinates stored in single precision floating point.

Since:

1.6

See Also:

Serialized Form

Path2D.Float

public Path2D.Float()

Constructs a new empty single precision Path2D object with a default winding rule of Path2D.WIND_NON_ZERO.

Since:

1.6

Path2D.Float

public Path2D.Float(int rule)

Constructs a new empty single precision Path2D object with the specified winding rule to control operations that require the interior of the path to be defined.

Parameters:

rule - the winding rule

Since:

1.6

See Also:

Path2D.WIND_EVEN_ODD, Path2D.WIND_NON_ZERO

Path2D.Float

public Path2D.Float(int rule, int initialCapacity)

Constructs a new empty single precision Path2D object with the specified winding rule and the specified initial capacity to store path segments. This number is an initial guess as to how many path segments will be added to the path, but the storage is expanded as needed to store whatever path segments are added.

Parameters:

rule - the winding rule

initialCapacity - the estimate for the number of path segments in the path

Since:

1.6

See Also:

Path2D.WIND_EVEN_ODD, Path2D.WIND_NON_ZERO

Path2D.Float

public Path2D.Float(Shape s)

Constructs a new single precision Path2D object from an arbitrary Shape object. All of the initial geometry and the winding rule for this path are taken from the specified Shape object.

Parameters:

s - the specified Shape object

Since:

1.6

Path2D.Float

public Path2D.Float(Shape s, AffineTransform at)

Constructs a new single precision Path2D object from an arbitrary Shape object, transformed by anAffineTransform object. All of the initial geometry and the winding rule for this path are taken from the specified Shape object and transformed by the specified AffineTransform object.

Parameters:

s - the specified Shape object

at - the specified AffineTransform object

Since:

1.6

moveTo

public final void moveTo(double x, double y)

Adds a point to the path by moving to the specified coordinates specified in double precision.

Specified by:

[moveTo](../../../java/awt/geom/Path2D.html#moveTo%28double, double%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

Since:

1.6

moveTo

public final void moveTo(float x, float y)

Adds a point to the path by moving to the specified coordinates specified in float precision.

This method provides a single precision variant of the double precision moveTo() method on the base Path2D class.

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

Since:

1.6

See Also:

[Path2D.moveTo(double, double)](../../../java/awt/geom/Path2D.html#moveTo%28double, double%29)

lineTo

public final void lineTo(double x, double y)

Adds a point to the path by drawing a straight line from the current coordinates to the new specified coordinates specified in double precision.

Specified by:

[lineTo](../../../java/awt/geom/Path2D.html#lineTo%28double, double%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

Since:

1.6

lineTo

public final void lineTo(float x, float y)

Adds a point to the path by drawing a straight line from the current coordinates to the new specified coordinates specified in float precision.

This method provides a single precision variant of the double precision lineTo() method on the base Path2D class.

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

Since:

1.6

See Also:

[Path2D.lineTo(double, double)](../../../java/awt/geom/Path2D.html#lineTo%28double, double%29)

quadTo

public final void quadTo(double x1, double y1, double x2, double y2)

Adds a curved segment, defined by two new points, to the path by drawing a Quadratic curve that intersects both the current coordinates and the specified coordinates (x2,y2), using the specified point (x1,y1) as a quadratic parametric control point. All coordinates are specified in double precision.

Specified by:

[quadTo](../../../java/awt/geom/Path2D.html#quadTo%28double, double, double, double%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Parameters:

x1 - the X coordinate of the quadratic control point

y1 - the Y coordinate of the quadratic control point

x2 - the X coordinate of the final end point

y2 - the Y coordinate of the final end point

Since:

1.6

quadTo

public final void quadTo(float x1, float y1, float x2, float y2)

Adds a curved segment, defined by two new points, to the path by drawing a Quadratic curve that intersects both the current coordinates and the specified coordinates (x2,y2), using the specified point (x1,y1) as a quadratic parametric control point. All coordinates are specified in float precision.

This method provides a single precision variant of the double precision quadTo() method on the base Path2D class.

Parameters:

x1 - the X coordinate of the quadratic control point

y1 - the Y coordinate of the quadratic control point

x2 - the X coordinate of the final end point

y2 - the Y coordinate of the final end point

Since:

1.6

See Also:

[Path2D.quadTo(double, double, double, double)](../../../java/awt/geom/Path2D.html#quadTo%28double, double, double, double%29)

curveTo

public final void curveTo(double x1, double y1, double x2, double y2, double x3, double y3)

Adds a curved segment, defined by three new points, to the path by drawing a Bézier curve that intersects both the current coordinates and the specified coordinates (x3,y3), using the specified points (x1,y1) and (x2,y2) as Bézier control points. All coordinates are specified in double precision.

Specified by:

[curveTo](../../../java/awt/geom/Path2D.html#curveTo%28double, double, double, double, double, double%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Parameters:

x1 - the X coordinate of the first Bézier control point

y1 - the Y coordinate of the first Bézier control point

x2 - the X coordinate of the second Bézier control point

y2 - the Y coordinate of the second Bézier control point

x3 - the X coordinate of the final end point

y3 - the Y coordinate of the final end point

Since:

1.6

curveTo

public final void curveTo(float x1, float y1, float x2, float y2, float x3, float y3)

Adds a curved segment, defined by three new points, to the path by drawing a Bézier curve that intersects both the current coordinates and the specified coordinates (x3,y3), using the specified points (x1,y1) and (x2,y2) as Bézier control points. All coordinates are specified in float precision.

This method provides a single precision variant of the double precision curveTo() method on the base Path2D class.

Parameters:

x1 - the X coordinate of the first Bézier control point

y1 - the Y coordinate of the first Bézier control point

x2 - the X coordinate of the second Bézier control point

y2 - the Y coordinate of the second Bézier control point

x3 - the X coordinate of the final end point

y3 - the Y coordinate of the final end point

Since:

1.6

See Also:

[Path2D.curveTo(double, double, double, double, double, double)](../../../java/awt/geom/Path2D.html#curveTo%28double, double, double, double, double, double%29)

append

public final void append(PathIterator pi, boolean connect)

Appends the geometry of the specifiedPathIterator object to the path, possibly connecting the new geometry to the existing path segments with a line segment. If the connect parameter is true and the path is not empty then any initial moveTo in the geometry of the appended Shape is turned into alineTo segment. If the destination coordinates of such a connecting lineTo segment match the ending coordinates of a currently open subpath then the segment is omitted as superfluous. The winding rule of the specified Shape is ignored and the appended geometry is governed by the winding rule specified for this path.

Specified by:

[append](../../../java/awt/geom/Path2D.html#append%28java.awt.geom.PathIterator, boolean%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Parameters:

pi - the PathIterator whose geometry is appended to this path

connect - a boolean to control whether or not to turn an initialmoveTo segment into a lineTo segment to connect the new geometry to the existing path

Since:

1.6

transform

public final void transform(AffineTransform at)

Transforms the geometry of this path using the specified AffineTransform. The geometry is transformed in place, which permanently changes the boundary defined by this object.

Specified by:

[transform](../../../java/awt/geom/Path2D.html#transform%28java.awt.geom.AffineTransform%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Parameters:

at - the AffineTransform used to transform the area

Since:

1.6

getBounds2D

public final Rectangle2D getBounds2D()

Returns a high precision and more accurate bounding box of the Shape than the getBounds method. Note that there is no guarantee that the returned Rectangle2D is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle2D. The bounding box returned by this method is usually tighter than that returned by the getBounds method and never fails due to overflow problems since the return value can be an instance of the Rectangle2D that uses double precision values to store the dimensions.

Specified by:

[getBounds2D](../../../java/awt/Shape.html#getBounds2D%28%29) in interface [Shape](../../../java/awt/Shape.html "interface in java.awt")

Returns:

an instance of Rectangle2D that is a high-precision bounding box of the Shape.

Since:

1.6

See Also:

Shape.getBounds()

getPathIterator

public PathIterator getPathIterator(AffineTransform at)

Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline. If an optional AffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

Each call to this method returns a fresh PathIterator object that traverses the geometry of the Shape object independently from any other PathIterator objects in use at the same time.

It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

The iterator for this class is not multi-threaded safe, which means that the Path2D class does not guarantee that modifications to the geometry of thisPath2D object do not affect any iterations of that geometry that are already in process.

Specified by:

[getPathIterator](../../../java/awt/Shape.html#getPathIterator%28java.awt.geom.AffineTransform%29) in interface [Shape](../../../java/awt/Shape.html "interface in java.awt")

Parameters:

at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired

Returns:

a new PathIterator object, which independently traverses the geometry of the Shape.

Since:

1.6

clone

public final Object clone()

Creates a new object of the same class as this object.

Specified by:

[clone](../../../java/awt/geom/Path2D.html#clone%28%29) in class [Path2D](../../../java/awt/geom/Path2D.html "class in java.awt.geom")

Returns:

a clone of this instance.

Throws:

[OutOfMemoryError](../../../java/lang/OutOfMemoryError.html "class in java.lang") - if there is not enough memory.

Since:

1.6

See Also:

Cloneable

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.