Module org.arakhne.afc.core.mathgeom

Package org.arakhne.afc.math.geometry.d2.d

Class Path2d

java.lang.Object

org.arakhne.afc.math.geometry.d2.d.AbstractShape2d<Path2d>

org.arakhne.afc.math.geometry.d2.d.Path2d

All Implemented Interfaces:

Serializable, Cloneable, Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>, Shape2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>, Shape2d<Path2d>, Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>, Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>, JsonableObject

public class Path2d
extends AbstractShape2d<Path2d>
implements Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Path with 2 double precision floating-point numbers.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND, Hamza JAFFALI, Fevzi OZGUL

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Nested Class Summary

Nested classes/interfaces inherited from interface org.arakhne.afc.math.geometry.d2.afp.Path2afp

Path2afp.AbstractPathPathIterator<T extends PathElement2afp>, Path2afp.FlatteningPathIterator<T extends PathElement2afp>, Path2afp.PathPathIterator<T extends PathElement2afp>, Path2afp.TransformedPathPathIterator<T extends PathElement2afp>

Nested classes/interfaces inherited from interface org.arakhne.afc.math.geometry.d2.Path2D

Path2D.ArcType

Field Summary

Fields inherited from interface org.arakhne.afc.math.geometry.d2.afp.Path2afp

DEFAULT_FLATTENING_LIMIT, DEFAULT_WINDING_RULE, GROW_SIZE

Constructor Summary

Constructors

Constructor	Description
Path2d()	Construct an empty path.
Path2d(Iterator<PathElement2d> iterator)	Construct a path by copying the given elements.
Path2d(Path2afp<?,?,?,?,?,?> path)	Constructor by copy.
Path2d(PathWindingRule windingRule)	Create an empty path with the given path winding rule.
Path2d(PathWindingRule windingRule, Iterator<PathElement2d> iterator)	Create an empty path with the given path winding rule, and by copying the given elements.

Method Summary

Modifier and Type	Method	Description
void	clear()	Reset this shape to be equivalent to an just-created instance of this shape type.
Path2d	clone()	Clone this shape.
void	closePath()	Closes the current subpath by drawing a straight line back to the coordinates of the last moveTo.
boolean	containsControlPoint(Point2D<?,?> pt)	Replies if the given points exists in the coordinates of this path.
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.
double	getCoordAt(int index)	Replies the coordinate at the given index.
double	getCurrentX()	Replies the x coordinate of the last point in the path.
double	getCurrentY()	Replies the y coordinate of the last point in the path.
double	getLength()	Replies the total length of the path.
int	getPathElementCount()	Replies the number of path elements in this path.
PathElementType	getPathElementTypeAt(int index)	Replies the type of the path element at the given position in this path.
Point2d	getPointAt(int index)	Replies the point at the given index.
PathWindingRule	getWindingRule()	Replies the winding rule for the path.
int	hashCode()
boolean	isCurved()	Replies the path contains a curve..
boolean	isEmpty()	Replies if this shape is empty.
boolean	isMultiParts()	Replies the path has multiple parts, i.e. multiple MOVE_TO are inside.
boolean	isPolygon()	Replies the path is composed only by one MOVE_TO, a sequence of LINE_TO or QUAD_TO or CURVE_TO, or ARC_TO, and a single CLOSE primitives.
boolean	isPolyline()	Replies the path is composed only by one MOVE_TO, and a sequence of LINE_TO primitives.
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.
void	moveTo(double x, double y)	Adds a point to the path by moving to the specified coordinates specified in double precision.
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.
boolean	remove(double x, double y)	Remove the point with the given coordinates.
void	removeLast()	Remove the last action.
void	set(Path2d path)	Set this shape with the attributes of the given shape.
void	setLastPoint(double x, double y)	Change the coordinates of the last inserted point.
void	setWindingRule(PathWindingRule rule)	Set the winding rule for the path.
int	size()	Replies the number of points in the path.
Rectangle2d	toBoundingBox()	Replies the bounding box of this shape.
void	toBoundingBox(Rectangle2d box)	Replies the bounds of the shape.
Rectangle2d	toBoundingBoxWithCtrlPoints()	Replies the bounding box of all the points added in this path.
void	toBoundingBoxWithCtrlPoints(Rectangle2d box)	Compute the bounding box of all the points added in this path.
double[]	toDoubleArray(Transform2D transform)	Replies the coordinates of this path in an array of double precision floating-point numbers.
float[]	toFloatArray(Transform2D transform)	Replies the coordinates of this path in an array of single precision floating-point numbers.
int[]	toIntArray(Transform2D transform)	Replies the coordinates of this path in an array of integer numbers.
Point2d[]	toPointArray(Transform2D transform)	Replies the points of this path in an array.
void	transform(Transform2D transform)	Transform the current path.
void	translate(double dx, double dy)	Translate the shape.

Methods inherited from class org.arakhne.afc.math.geometry.d2.d.AbstractShape2d

addShapeGeometryChangeListener, equals, fireGeometryChange, getGeomFactory, removeShapeGeometryChangeListener, toJson, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.arakhne.afc.vmutil.json.JsonableObject

toJson

Methods inherited from interface org.arakhne.afc.math.geometry.d2.afp.Path2afp

add, arcTo, arcTo, arcTo, arcTo, arcTo, contains, contains, curveTo, equalsToShape, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getClosestPointTo, getCurrentPoint, getDistanceL1, getDistanceLinf, getDistanceSquared, getFarthestPointTo, getFlatteningPathIterator, getLengthSquared, getPathIterator, getPathIterator, getPathIterator, intersects, intersects, intersects, intersects, intersects, intersects, intersects, intersects, intersects, intersects, intersects, lineTo, moveTo, moveToIfFar, moveToIfFar, quadTo, set, setLastPoint, toCollection

Methods inherited from interface org.arakhne.afc.math.geometry.d2.Path2D

arcTo, toDoubleArray, toFloatArray, toIntArray, toPointArray

Methods inherited from interface org.arakhne.afc.math.geometry.d2.afp.Shape2afp

contains, contains, createTransformedShape, getClosestPointTo, getClosestPointTo, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getDistanceSquared, getGeomFactory, intersects, translate

Methods inherited from interface org.arakhne.afc.math.geometry.d2.Shape2D

equalsToPathIterator, getDistance, getDistance, getPathIterator, operator_add, operator_and, operator_and, operator_minus, operator_multiply, operator_plus, operator_remove, operator_upTo

Constructor Detail

Path2d

public Path2d()

Construct an empty path.

Path2d

public Path2d(Iterator<PathElement2d> iterator)

Construct a path by copying the given elements.

Parameters:

iterator - the iterator that provides the elements to copy.

Path2d

public Path2d(PathWindingRule windingRule)

Create an empty path with the given path winding rule.

Parameters:

windingRule - the path winding rule.

Path2d

public Path2d(PathWindingRule windingRule,
              Iterator<PathElement2d> iterator)

Create an empty path with the given path winding rule, and by copying the given elements.

Parameters:

windingRule - the path winding rule.

iterator - the iterator that provides the elements to copy.

Path2d

public Path2d(Path2afp<?,?,?,?,?,?> path)

Constructor by copy.

Parameters:

path - the path to copy.

Method Detail

containsControlPoint

@Pure
public boolean containsControlPoint(Point2D<?,?> pt)

Description copied from interface: Path2D

Replies if the given points exists in the coordinates of this path.

Specified by:

containsControlPoint in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

pt - the point.

Returns:

true if the point is a control point of the path.

clear

public void clear()

Description copied from interface: Shape2D

Reset this shape to be equivalent to an just-created instance of this shape type.

Specified by:

clear in interface Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

clone

@Pure
public Path2d clone()

Description copied from interface: Shape2D

Clone this shape.

Specified by:

clone in interface Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Overrides:

clone in class AbstractShape2d<Path2d>

Returns:

the clone.

hashCode

@Pure
public int hashCode()

Specified by:

hashCode in class AbstractShape2d<Path2d>

translate

public void translate(double dx,
                      double dy)

Description copied from interface: Shape2afp

Translate the shape.

Specified by:

translate in interface Shape2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

dx - x translation.

dy - y translation.

transform

public void transform(Transform2D transform)

Description copied from interface: Path2afp

Transform the current path. This function changes the current path.

Specified by:

transform in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

transform - is the affine transformation to apply.

See Also:

Shape2afp.createTransformedShape(org.arakhne.afc.math.geometry.d2.Transform2D)

isEmpty

public boolean isEmpty()

Description copied from interface: Shape2D

Replies if this shape is empty. The semantic associated to the state "empty" depends on the implemented shape. See the subclasses for details.

Specified by:

isEmpty in interface Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

true if the shape is empty; false otherwise.

toBoundingBox

public Rectangle2d toBoundingBox()

Description copied from interface: Shape2D

Replies the bounding box of this shape.

Specified by:

toBoundingBox in interface Shape2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Specified by:

toBoundingBox in interface Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

the bounding box of this shape.

toBoundingBox

public void toBoundingBox(Rectangle2d box)

Description copied from interface: Shape2D

Replies the bounds of the shape.

Specified by:

toBoundingBox in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Specified by:

toBoundingBox in interface Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

box - is set with the bounds of the shape.

getWindingRule

public PathWindingRule getWindingRule()

Description copied from interface: Path2D

Replies the winding rule for the path.

Specified by:

getWindingRule in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

the winding rule for the path.

isPolyline

public boolean isPolyline()

Description copied from interface: Path2D

Replies the path is composed only by one MOVE_TO, and a sequence of LINE_TO primitives.

Specified by:

isPolyline in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

true if the path does not contain curve primitives, false otherwise.

isCurved

public boolean isCurved()

Description copied from interface: Path2D

Replies the path contains a curve..

Specified by:

isCurved in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

true if the path does not contain curve primitives, false otherwise.

isMultiParts

public boolean isMultiParts()

Description copied from interface: Path2D

Replies the path has multiple parts, i.e. multiple MOVE_TO are inside. primitives.

Specified by:

isMultiParts in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

true if the path has multiple move-to primitive, false otherwise.

isPolygon

public boolean isPolygon()

Description copied from interface: Path2D

Replies the path is composed only by one MOVE_TO, a sequence of LINE_TO or QUAD_TO or CURVE_TO, or ARC_TO, and a single CLOSE primitives.

Specified by:

isPolygon in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

true if the path does not contain curve primitives, false otherwise.

closePath

public void closePath()

Description copied from interface: Path2D

Closes the current subpath by drawing a straight line back to the coordinates of the last moveTo. If the path is already closed or if the previous coordinates are for a moveTo then this method has no effect.

Specified by:

closePath in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

toBoundingBoxWithCtrlPoints

@Pure
public Rectangle2d toBoundingBoxWithCtrlPoints()

Description copied from interface: Path2D

Replies the bounding box of all the points added in this path.

The replied bounding box includes the (invisible) control points.

Specified by:

toBoundingBoxWithCtrlPoints in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

the bounding box with the control points.

See Also:

Shape2D.toBoundingBox()

toBoundingBoxWithCtrlPoints

@Pure
public void toBoundingBoxWithCtrlPoints(Rectangle2d box)

Description copied from interface: Path2D

Compute the bounding box of all the points added in this path.

The replied bounding box includes the (invisible) control points.

Specified by:

toBoundingBoxWithCtrlPoints in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

box - is the rectangle to set with the bounds.

See Also:

Shape2D.toBoundingBox()

toIntArray

@Pure
public int[] toIntArray(Transform2D transform)

Description copied from interface: Path2D

Replies the coordinates of this path in an array of integer numbers.

Specified by:

toIntArray in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

transform - is the transformation to apply to all the coordinates.

Returns:

the coordinates.

toFloatArray

@Pure
public float[] toFloatArray(Transform2D transform)

Description copied from interface: Path2D

Replies the coordinates of this path in an array of single precision floating-point numbers.

Specified by:

toFloatArray in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

transform - is the transformation to apply to all the coordinates.

Returns:

the coordinates.

toDoubleArray

@Pure
public double[] toDoubleArray(Transform2D transform)

Description copied from interface: Path2D

Replies the coordinates of this path in an array of double precision floating-point numbers.

Specified by:

toDoubleArray in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

transform - is the transformation to apply to all the coordinates.

Returns:

the coordinates.

toPointArray

@Pure
public Point2d[] toPointArray(Transform2D transform)

Description copied from interface: Path2D

Replies the points of this path in an array.

Specified by:

toPointArray in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

transform - is the transformation to apply to all the points.

Returns:

the points.

getPointAt

@Pure
public Point2d getPointAt(int index)

Description copied from interface: Path2D

Replies the point at the given index. The index is in [0;Path2D.size()).

Specified by:

getPointAt in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

index - the index.

Returns:

the point at the given index.

getCurrentX

@Pure
public double getCurrentX()

Description copied from interface: Path2afp

Replies the x coordinate of the last point in the path.

Specified by:

getCurrentX in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Returns:

the x coordinate of the last point in the path.

getCurrentY

@Pure
public double getCurrentY()

Description copied from interface: Path2afp

Replies the y coordinate of the last point in the path.

Specified by:

getCurrentY in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Returns:

the y coordinate of the last point in the path.

size

@Pure
public int size()

Description copied from interface: Path2D

Replies the number of points in the path.

Specified by:

size in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

the number of points in the path.

removeLast

public void removeLast()

Description copied from interface: Path2D

Remove the last action.

Specified by:

removeLast in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

moveTo

public void moveTo(double x,
                   double y)

Description copied from interface: Path2afp

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

Specified by:

moveTo in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

lineTo

public void lineTo(double x,
                   double y)

Description copied from interface: Path2afp

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 in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

x - the specified X coordinate

y - the specified Y coordinate

quadTo

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

Description copied from interface: Path2afp

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 in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

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

curveTo

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

Description copied from interface: Path2afp

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 in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

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

getCoordAt

@Pure
public double getCoordAt(int index)

Description copied from interface: Path2afp

Replies the coordinate at the given index. The index is in [0;Path2D.size()*2).

Specified by:

getCoordAt in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

index - the index.

Returns:

the coordinate at the given index.

setLastPoint

public void setLastPoint(double x,
                         double y)

Description copied from interface: Path2afp

Change the coordinates of the last inserted point.

Specified by:

setLastPoint in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

x - the new x coordinate of the last point.

y - the new y coordinate of the last point.

setWindingRule

public void setWindingRule(PathWindingRule rule)

Description copied from interface: Path2D

Set the winding rule for the path.

Specified by:

setWindingRule in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

rule - is the winding rule for the path.

remove

public boolean remove(double x,
                      double y)

Description copied from interface: Path2afp

Remove the point with the given coordinates.

If the given coordinates do not match exactly a point in the path, nothing is removed.

Specified by:

remove in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Parameters:

x - the x coordinate of the ponit to remove.

y - the y coordinate of the ponit to remove.

Returns:

true if the point was removed; false otherwise.

set

public void set(Path2d path)

Description copied from interface: Shape2D

Set this shape with the attributes of the given shape.

Specified by:

set in interface Shape2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

path - the shape to copy.

getPathElementCount

@Pure
public int getPathElementCount()

Description copied from interface: Path2D

Replies the number of path elements in this path.

Specified by:

getPathElementCount in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

the number of path elements.

See Also:

Path2D.getPathElementTypeAt(int)

getPathElementTypeAt

@Pure
public PathElementType getPathElementTypeAt(int index)

Description copied from interface: Path2D

Replies the type of the path element at the given position in this path.

Specified by:

getPathElementTypeAt in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Parameters:

index - the index of the path element.

Returns:

the type of the path element.

See Also:

Path2D.getPathElementCount()

getLength

@Pure
public double getLength()

Description copied from interface: Path2D

Replies the total length of the path.

Specified by:

getLength in interface Path2afp<Shape2d<?>,Path2d,PathElement2d,Point2d,Vector2d,Rectangle2d>

Specified by:

getLength in interface Path2D<Shape2d<?>,Path2d,PathIterator2afp<PathElement2d>,Point2d,Vector2d,Rectangle2d>

Returns:

the length of the path.