Module org.arakhne.afc.core.mathgeom

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

Class PathElement2i

java.lang.Object

org.arakhne.afc.math.geometry.d2.i.PathElement2i

All Implemented Interfaces:

Serializable, Cloneable, PathElement2ai, PathElement2D

Direct Known Subclasses:

PathElement2i.ArcPathElement2i, PathElement2i.ClosePathElement2i, PathElement2i.CurvePathElement2i, PathElement2i.LinePathElement2i, PathElement2i.MovePathElement2i, PathElement2i.QuadPathElement2i

public abstract class PathElement2i
extends Object
implements PathElement2ai

An element of the path with 2 integer numbers.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	PathElement2i.ArcPathElement2i	An element of the path that represents a Arc_TO.
(package private) static class	PathElement2i.ClosePathElement2i	An element of the path that represents a CLOSE.
(package private) static class	PathElement2i.CurvePathElement2i	An element of the path that represents a CURVE_TO.
(package private) static class	PathElement2i.LinePathElement2i	An element of the path that represents a LINE_TO.
(package private) static class	PathElement2i.MovePathElement2i	An element of the path that represents a MOVE_TO.
(package private) static class	PathElement2i.QuadPathElement2i	An element of the path that represents a QUAD_TO.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	toX	Target point.
protected int	toY	Target point.
protected PathElementType	type	Type of the element.

Constructor Summary

Constructors

Constructor	Description
PathElement2i(PathElementType type, int tox, int toy)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract boolean	equals(Object obj)
int	getCtrlX1()	Replies the x coordinate of the first control point.
int	getCtrlX2()	Replies the x coordinate of the second control point.
int	getCtrlY1()	Replies the y coordinate of the first control point.
int	getCtrlY2()	Replies the y coordinate of the second control point.
boolean	getLargeArcFlag()	Replies if the arc-to will sweep clockwise around the ellipse.
int	getRadiusX()	Replies the x radius of the arc-to ellipse.
int	getRadiusY()	Replies the y radius of the arc-to ellipse.
double	getRotationX()	Replies the rotation of the x axis of the arc-to ellipse.
boolean	getSweepFlag()	Replies if the arc-to will sweep the long way around the ellipse.
int	getToX()	Replies the x coordinate of the target point.
int	getToY()	Replies the y coordinate of the target point.
PathElementType	getType()	Replies the type of the element.
abstract int	hashCode()
abstract int[]	toArray()	Copy the coords into an array, except the source point.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.arakhne.afc.math.geometry.d2.ai.PathElement2ai

getFromX, getFromY, toArray, toArray

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

isDrawable, isEmpty

Field Detail

type

protected final PathElementType type

Type of the element.

toX

protected final int toX

Target point.

toY

protected final int toY

Target point.

Constructor Detail

PathElement2i

PathElement2i(PathElementType type,
              int tox,
              int toy)

Constructor.

Parameters:

type - is the type of the element.

tox - the x coordinate of the target point.

toy - the x coordinate of the target point.

Method Detail

toString

@Pure
public String toString()

Overrides:

toString in class Object

equals

@Pure
public abstract boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

@Pure
public abstract int hashCode()

Overrides:

hashCode in class Object

getToX

@Pure
public final int getToX()

Description copied from interface: PathElement2ai

Replies the x coordinate of the target point.

Specified by:

getToX in interface PathElement2ai

Returns:

the x coordinate.

getToY

@Pure
public final int getToY()

Description copied from interface: PathElement2ai

Replies the y coordinate of the target point.

Specified by:

getToY in interface PathElement2ai

Returns:

the y coordinate.

getType

@Pure
public final PathElementType getType()

Description copied from interface: PathElement2D

Replies the type of the element.

Specified by:

getType in interface PathElement2ai

Specified by:

getType in interface PathElement2D

Returns:

true if the points are the same; otherwise false.

toArray

@Pure
public abstract int[] toArray()

Copy the coords into an array, except the source point.

Returns:

the array of the points, except the source point.

getCtrlX1

public int getCtrlX1()

Description copied from interface: PathElement2ai

Replies the x coordinate of the first control point.

Specified by:

getCtrlX1 in interface PathElement2ai

Returns:

the x coordinate, or Double.NaN if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, or PathElementType.CLOSE.

getCtrlY1

public int getCtrlY1()

Description copied from interface: PathElement2ai

Replies the y coordinate of the first control point.

Specified by:

getCtrlY1 in interface PathElement2ai

Returns:

the y coordinate, or Double.NaN if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, or PathElementType.CLOSE.

getCtrlX2

public int getCtrlX2()

Description copied from interface: PathElement2ai

Replies the x coordinate of the second control point.

Specified by:

getCtrlX2 in interface PathElement2ai

Returns:

the x coordinate, or Double.NaN if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, PathElementType.QUAD_TO, or PathElementType.CLOSE.

getCtrlY2

public int getCtrlY2()

Description copied from interface: PathElement2ai

Replies the y coordinate of the second control point.

Specified by:

getCtrlY2 in interface PathElement2ai

Returns:

the y coordinate, or Double.NaN if the type is PathElementType.MOVE_TO, PathElementType.LINE_TO, PathElementType.QUAD_TO, or PathElementType.CLOSE.

getRadiusX

public int getRadiusX()

Description copied from interface: PathElement2ai

Replies the x radius of the arc-to ellipse.

Specified by:

getRadiusX in interface PathElement2ai

Returns:

the x radius, or 0 if the type is not PathElementType.ARC_TO.

getRadiusY

public int getRadiusY()

Description copied from interface: PathElement2ai

Replies the y radius of the arc-to ellipse.

Specified by:

getRadiusY in interface PathElement2ai

Returns:

the y radius, or 0 if the type is not PathElementType.ARC_TO.

getRotationX

public double getRotationX()

Description copied from interface: PathElement2ai

Replies the rotation of the x axis of the arc-to ellipse.

Specified by:

getRotationX in interface PathElement2ai

Returns:

the x axis rotation, or 0 if the type is not PathElementType.ARC_TO.

getSweepFlag

public boolean getSweepFlag()

Description copied from interface: PathElement2ai

Replies if the arc-to will sweep the long way around the ellipse.

Specified by:

getSweepFlag in interface PathElement2ai

Returns:

true iff the element will sweep clockwise around the ellipse, or 0 if the type is not PathElementType.ARC_TO.

getLargeArcFlag

public boolean getLargeArcFlag()

Description copied from interface: PathElement2ai

Replies if the arc-to will sweep clockwise around the ellipse.

Specified by:

getLargeArcFlag in interface PathElement2ai

Returns:

true iff the element will sweep clockwise around the ellipse, or 0 if the type is not PathElementType.ARC_TO.