Module org.jhotdraw8.geom

Package org.jhotdraw8.geom.shape

Class SimplePathMetrics

java.lang.Object

org.jhotdraw8.geom.AbstractShape

org.jhotdraw8.geom.shape.SimplePathMetrics

All Implemented Interfaces:

Shape, PathMetrics

public class SimplePathMetrics
extends AbstractShape
implements PathMetrics

The PathMetrics class allows access to the metrics needed to compute points along a path and to create sub-paths of a path.

Requirements for the path:

• The path must start with a PathIterator.SEG_MOVETO
• A PathIterator.SEG_MOVETO must be followed by a PathIterator.SEG_LINETO, PathIterator.SEG_QUADTO, PathIterator.SEG_CUBICTO.
• A PathIterator.SEG_CLOSE must be the last element, or it must be followed by a PathIterator.SEG_MOVETO.
• The length of a PathIterator.SEG_LINETO, PathIterator.SEG_QUADTO, PathIterator.SEG_CUBICTO must be greater than 0.
• The x, y coordinates of the PathIterator.SEG_MOVETO at the beginning of a closed path must equal to the x, y coordinates of the last segment of the closed path.

Constructor Summary

Constructors

Constructor	Description
SimplePathMetrics(@NonNull Shape shape)
SimplePathMetrics(@NonNull PathIterator pathIterator)
SimplePathMetrics(@NonNull PathIterator pathIterator, double epsilon)

Method Summary

Modifier and Type	Method	Description
double	arcLength()	Gets the length of the path.
boolean	contains(double x, double y)
boolean	contains(double x, double y, double w, double h)	This implementation checks if the bounding box of this shape contains the specified rectangle.
boolean	contains(@NonNull Rectangle2D r)	See contains(double, double, double, double).
@NonNull PointAndDerivative	evalAtArcLength(double s)	Evaluates the path at the specified arc length
Rectangle2D	getBounds2D()
PathIterator	getPathIterator(@Nullable AffineTransform tx)	Returns a path iterator of the entire path.
@NonNull PathIterator	getSubPathIteratorAtArcLength(double s0, double s1, @Nullable AffineTransform tx)	Gets an iterator over a segment of the path from arc length s0 to arc length s1.
boolean	isEmpty()	Returns true if this path metrics is empty.
@NonNull PathMetrics	reverse()	Gets path metrics for the reversed path.
String	toString()

Methods inherited from class org.jhotdraw8.geom.AbstractShape

contains, getBounds, getPathIterator, intersects, intersects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jhotdraw8.geom.shape.PathMetrics

eval, getSubPathIterator

Methods inherited from interface java.awt.Shape

contains, getBounds, getPathIterator, intersects, intersects

Constructor Details

SimplePathMetrics

public SimplePathMetrics(@NonNull Shape shape)

SimplePathMetrics

public SimplePathMetrics(@NonNull PathIterator pathIterator)

SimplePathMetrics

public SimplePathMetrics(@NonNull PathIterator pathIterator,
 double epsilon)

Method Details

evalAtArcLength

public @NonNull PointAndDerivative evalAtArcLength(double s)

Evaluates the path at the specified arc length

Specified by:

evalAtArcLength in interface PathMetrics

Parameters:

s - the arc length, the value will be clamped to [0,arcLength()]

Returns:

point and tangent at s

arcLength

public double arcLength()

Gets the length of the path.

Specified by:

arcLength in interface PathMetrics

Returns:

the length of the path in [0,Double.MAX_VALUE].

reverse

public @NonNull PathMetrics reverse()

Description copied from interface: PathMetrics

Gets path metrics for the reversed path.

Specified by:

reverse in interface PathMetrics

Returns:

reverse path metrics

isEmpty

public boolean isEmpty()

Description copied from interface: PathMetrics

Returns true if this path metrics is empty.

Specified by:

isEmpty in interface PathMetrics

Returns:

true if empty

getBounds2D

public Rectangle2D getBounds2D()

Specified by:

getBounds2D in interface Shape

Overrides:

getBounds2D in class AbstractShape

contains

public boolean contains(double x,
 double y)

Specified by:

contains in interface Shape

Overrides:

contains in class AbstractShape

contains

public boolean contains(double x,
 double y,
 double w,
 double h)

This implementation checks if the bounding box of this shape contains the specified rectangle.

Specified by:

contains in interface Shape

Overrides:

contains in class AbstractShape

Parameters:

x - the X coordinate of the upper-left corner of the specified rectangular area

y - the Y coordinate of the upper-left corner of the specified rectangular area

w - the width of the specified rectangular area

h - the height of the specified rectangular area

Returns:

true if the interior of the bounding box of this shape contains the interior of the specified rectangle.

contains

public boolean contains(@NonNull Rectangle2D r)

See contains(double, double, double, double).

Specified by:

contains in interface Shape

Overrides:

contains in class AbstractShape

Parameters:

r - the specified Rectangle2D

Returns:

true if this shape contains r

getSubPathIteratorAtArcLength

public @NonNull PathIterator getSubPathIteratorAtArcLength(double s0,
 double s1,
 @Nullable AffineTransform tx)

Gets an iterator over a segment of the path from arc length s0 to arc length s1.

Specified by:

getSubPathIteratorAtArcLength in interface PathMetrics

Parameters:

s0 - the arc length at which the sub-path starts, the value will be clamped to [0,arcLength()].

s1 - the arc length at which the sub-path ends, the value will be clamped to [s0,arcLength()].

tx - an optional transformation for the path iterator

Returns:

the path iterator

getPathIterator

public PathIterator getPathIterator(@Nullable AffineTransform tx)

Returns a path iterator of the entire path.

Specified by:

getPathIterator in interface PathMetrics

Specified by:

getPathIterator in interface Shape

Parameters:

tx - an optional transformation for the path iterator

Returns:

the path iterator

toString

public String toString()

Overrides:

toString in class Object