Class PathElement2dfx
- java.lang.Object
-
- org.arakhne.afc.math.geometry.d2.dfx.PathElement2dfx
-
- All Implemented Interfaces:
Serializable
,Cloneable
,PathElement2afp
,PathElement2D
- Direct Known Subclasses:
PathElement2dfx.ArcPathElement2dfx
,PathElement2dfx.ClosePathElement2dfx
,PathElement2dfx.CurvePathElement2dfx
,PathElement2dfx.LinePathElement2dfx
,PathElement2dfx.MovePathElement2dfx
,PathElement2dfx.QuadPathElement2dfx
public abstract class PathElement2dfx extends Object implements PathElement2afp
An element of the path.- Since:
- 13.0
- Version:
- 17.0 2020-01-04 14:41:49
- Author:
- Stéphane GALLAND, Hamza JAFFALI
- See Also:
- Serialized Form
- Maven Group Id:
- org.arakhne.afc.advanced
- Maven Artifact Id:
- mathfx
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
PathElement2dfx.ArcPathElement2dfx
An element of the path that represents aARC_TO
.(package private) static class
PathElement2dfx.ClosePathElement2dfx
An element of the path that represents aCLOSE
.(package private) static class
PathElement2dfx.CurvePathElement2dfx
An element of the path that represents aCURVE_TO
.(package private) static class
PathElement2dfx.LinePathElement2dfx
An element of the path that represents aLINE_TO
.(package private) static class
PathElement2dfx.MovePathElement2dfx
An element of the path that represents aMOVE_TO
.(package private) static class
PathElement2dfx.QuadPathElement2dfx
An element of the path that represents aQUAD_TO
.
-
Field Summary
Fields Modifier and Type Field Description protected javafx.beans.property.ReadOnlyBooleanWrapper
isEmpty
Is Empty property.protected Point2dfx
to
Target point.protected PathElementType
type
Type of the element.
-
Constructor Summary
Constructors Constructor Description PathElement2dfx(PathElementType type, javafx.beans.property.DoubleProperty tox, javafx.beans.property.DoubleProperty toy)
Constructor.PathElement2dfx(PathElementType type, Point2dfx toPoint)
Constructor by setting the destination point.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description javafx.beans.property.DoubleProperty
ctrlX1Property()
Replies the property for the x coordinate of the first control point.javafx.beans.property.DoubleProperty
ctrlX2Property()
Replies the property for the x coordinate of the second control point.javafx.beans.property.DoubleProperty
ctrlY1Property()
Replies the property for the y coordinate of the first control point.javafx.beans.property.DoubleProperty
ctrlY2Property()
Replies the property for the y coordinate of the second control point.abstract boolean
equals(Object obj)
abstract javafx.beans.property.DoubleProperty
fromXProperty()
Replies the property for the x coordinate of the starting point.abstract javafx.beans.property.DoubleProperty
fromYProperty()
Replies the property for the y coordinate of the starting point.double
getCtrlX1()
Replies the x coordinate of the first control point.double
getCtrlX2()
Replies the x coordinate of the second control point.double
getCtrlY1()
Replies the y coordinate of the first control point.double
getCtrlY2()
Replies the y coordinate of the second control point.boolean
getLargeArcFlag()
Replies if the arc-to will sweep clockwise around the ellipse.double
getRadiusX()
Replies the x radius of the arc-to ellipse.double
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.double
getToX()
Replies the x coordinate of the target point.double
getToY()
Replies the y coordinate of the target point.PathElementType
getType()
Replies the type of the element.abstract int
hashCode()
boolean
isEmpty()
Replies if the element is empty, ie. the points are the same.abstract javafx.beans.property.BooleanProperty
isEmptyProperty()
Replies the property that indicates if this patth element is empty.javafx.beans.property.BooleanProperty
largeArcFlagProperty()
Replies the property for the large ellipse arc flag.javafx.beans.property.DoubleProperty
radiusXProperty()
Replies the property for the radius along the x axis.javafx.beans.property.DoubleProperty
radiusYProperty()
Replies the property for the radius along the y axis.javafx.beans.property.DoubleProperty
rotationXProperty()
Replies the property for the rotation of the x axis.javafx.beans.property.BooleanProperty
sweepFlagProperty()
Replies the property for the sweep ellipse arc flag.abstract javafx.beans.property.DoubleProperty[]
toArray()
Copy the coords into an array, except the source point.abstract void
toArray(javafx.beans.property.DoubleProperty[] array)
Copy the coords into the given array, except the source point.String
toString()
javafx.beans.property.DoubleProperty
toXProperty()
Replies the property for the x coordinate of the target point.javafx.beans.property.DoubleProperty
toYProperty()
Replies the property for the y coordinate of the target point.-
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.afp.PathElement2afp
getFromX, getFromY, toArray, toArray
-
Methods inherited from interface org.arakhne.afc.math.geometry.d2.PathElement2D
isDrawable
-
-
-
-
Field Detail
-
type
protected final PathElementType type
Type of the element.
-
to
protected Point2dfx to
Target point.
-
isEmpty
protected javafx.beans.property.ReadOnlyBooleanWrapper isEmpty
Is Empty property.
-
-
Constructor Detail
-
PathElement2dfx
PathElement2dfx(PathElementType type, javafx.beans.property.DoubleProperty tox, javafx.beans.property.DoubleProperty 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.
-
PathElement2dfx
PathElement2dfx(PathElementType type, Point2dfx toPoint)
Constructor by setting the destination point.- Parameters:
type
- is the type of the element.toPoint
- the point to set as the target point.
-
-
Method Detail
-
isEmptyProperty
public abstract javafx.beans.property.BooleanProperty isEmptyProperty()
Replies the property that indicates if this patth element is empty.- Returns:
- the isEmpty property.
-
isEmpty
public boolean isEmpty()
Description copied from interface:PathElement2D
Replies if the element is empty, ie. the points are the same.- Specified by:
isEmpty
in interfacePathElement2D
- Returns:
true
if the points are the same; otherwisefalse
.
-
getToX
@Pure public final double getToX()
Description copied from interface:PathElement2afp
Replies the x coordinate of the target point.- Specified by:
getToX
in interfacePathElement2afp
- Returns:
- the x coordinate.
-
getToY
@Pure public final double getToY()
Description copied from interface:PathElement2afp
Replies the y coordinate of the target point.- Specified by:
getToY
in interfacePathElement2afp
- Returns:
- the y coordinate.
-
fromXProperty
@Pure public abstract javafx.beans.property.DoubleProperty fromXProperty()
Replies the property for the x coordinate of the starting point.- Returns:
- the x coordinate, or
null
if the type isPathElementType.MOVE_TO
.
-
fromYProperty
@Pure public abstract javafx.beans.property.DoubleProperty fromYProperty()
Replies the property for the y coordinate of the starting point.- Returns:
- the y coordinate, or
null
if the type isPathElementType.MOVE_TO
.
-
toXProperty
@Pure public javafx.beans.property.DoubleProperty toXProperty()
Replies the property for the x coordinate of the target point.- Returns:
- the x coordinate.
-
toYProperty
@Pure public javafx.beans.property.DoubleProperty toYProperty()
Replies the property for the y coordinate of the target point.- 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 interfacePathElement2afp
- Specified by:
getType
in interfacePathElement2D
- Returns:
true
if the points are the same; otherwisefalse
.
-
toArray
@Pure public abstract void toArray(javafx.beans.property.DoubleProperty[] array)
Copy the coords into the given array, except the source point.- Parameters:
array
- the output array.
-
toArray
@Pure public abstract javafx.beans.property.DoubleProperty[] toArray()
Copy the coords into an array, except the source point.- Returns:
- the array of the points, except the source point.
-
getCtrlX1
public double getCtrlX1()
Description copied from interface:PathElement2afp
Replies the x coordinate of the first control point.- Specified by:
getCtrlX1
in interfacePathElement2afp
- Returns:
- the x coordinate, or
0
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
, orPathElementType.CLOSE
.
-
getCtrlY1
public double getCtrlY1()
Description copied from interface:PathElement2afp
Replies the y coordinate of the first control point.- Specified by:
getCtrlY1
in interfacePathElement2afp
- Returns:
- the y coordinate, or
0
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
, orPathElementType.CLOSE
.
-
getCtrlX2
public double getCtrlX2()
Description copied from interface:PathElement2afp
Replies the x coordinate of the second control point.- Specified by:
getCtrlX2
in interfacePathElement2afp
- Returns:
- the x coordinate, or
0
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
,PathElementType.QUAD_TO
, orPathElementType.CLOSE
.
-
getCtrlY2
public double getCtrlY2()
Description copied from interface:PathElement2afp
Replies the y coordinate of the second control point.- Specified by:
getCtrlY2
in interfacePathElement2afp
- Returns:
- the y coordinate, or
0
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
,PathElementType.QUAD_TO
, orPathElementType.CLOSE
.
-
getRadiusX
public double getRadiusX()
Description copied from interface:PathElement2afp
Replies the x radius of the arc-to ellipse.- Specified by:
getRadiusX
in interfacePathElement2afp
- Returns:
- the x radius, or
0
if the type is notPathElementType.ARC_TO
.
-
getRadiusY
public double getRadiusY()
Description copied from interface:PathElement2afp
Replies the y radius of the arc-to ellipse.- Specified by:
getRadiusY
in interfacePathElement2afp
- Returns:
- the y radius, or
0
if the type is notPathElementType.ARC_TO
.
-
getRotationX
public double getRotationX()
Description copied from interface:PathElement2afp
Replies the rotation of the x axis of the arc-to ellipse.- Specified by:
getRotationX
in interfacePathElement2afp
- Returns:
- the x axis rotation, or
0
if the type is notPathElementType.ARC_TO
.
-
getSweepFlag
public boolean getSweepFlag()
Description copied from interface:PathElement2afp
Replies if the arc-to will sweep the long way around the ellipse.- Specified by:
getSweepFlag
in interfacePathElement2afp
- Returns:
true
iff the element will sweep clockwise around the ellipse, or0
if the type is notPathElementType.ARC_TO
.
-
getLargeArcFlag
public boolean getLargeArcFlag()
Description copied from interface:PathElement2afp
Replies if the arc-to will sweep clockwise around the ellipse.- Specified by:
getLargeArcFlag
in interfacePathElement2afp
- Returns:
true
iff the element will sweep clockwise around the ellipse, or0
if the type is notPathElementType.ARC_TO
.
-
ctrlX1Property
@Pure public javafx.beans.property.DoubleProperty ctrlX1Property()
Replies the property for the x coordinate of the first control point.- Returns:
- the x coordinate, or
null
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
, orPathElementType.CLOSE
.
-
ctrlY1Property
@Pure public javafx.beans.property.DoubleProperty ctrlY1Property()
Replies the property for the y coordinate of the first control point.- Returns:
- the y coordinate, or
Double.NaN
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
, orPathElementType.CLOSE
.
-
ctrlX2Property
@Pure public javafx.beans.property.DoubleProperty ctrlX2Property()
Replies the property for the x coordinate of the second control point.- Returns:
- the x coordinate, or
null
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
,PathElementType.QUAD_TO
, orPathElementType.CLOSE
.
-
ctrlY2Property
@Pure public javafx.beans.property.DoubleProperty ctrlY2Property()
Replies the property for the y coordinate of the second control point.- Returns:
- the y coordinate, or
null
if the type isPathElementType.MOVE_TO
,PathElementType.LINE_TO
,PathElementType.QUAD_TO
, orPathElementType.CLOSE
.
-
radiusXProperty
@Pure public javafx.beans.property.DoubleProperty radiusXProperty()
Replies the property for the radius along the x axis.- Returns:
- the x radius, or
null
if the type is notPathElementType.ARC_TO
.
-
radiusYProperty
@Pure public javafx.beans.property.DoubleProperty radiusYProperty()
Replies the property for the radius along the y axis.- Returns:
- the y radius, or
null
if the type is notPathElementType.ARC_TO
.
-
rotationXProperty
@Pure public javafx.beans.property.DoubleProperty rotationXProperty()
Replies the property for the rotation of the x axis.- Returns:
- the x-axis rotation, or
null
if the type is notPathElementType.ARC_TO
.
-
largeArcFlagProperty
@Pure public javafx.beans.property.BooleanProperty largeArcFlagProperty()
Replies the property for the large ellipse arc flag.- Returns:
- the flag, or
null
if the type is notPathElementType.ARC_TO
.
-
sweepFlagProperty
@Pure public javafx.beans.property.BooleanProperty sweepFlagProperty()
Replies the property for the sweep ellipse arc flag.- Returns:
- the flag, or
null
if the type is notPathElementType.ARC_TO
.
-
-