Class Path2
Hierarchy
- Path2
Index
Constructors
Properties
Methods
Constructors
constructor
-
Creates a Path2 object from the starting 2D coordinates x and y.
Parameters
-
x: number
the starting points x value
-
y: number
the starting points y value
Returns Path2
-
Properties
closedSearch playground for closed
If the path start and end point are the same
Methods
add Arc ToSearch playground for addArcTo
-
Adds numberOfSegments segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
Parameters
-
midX: number
middle point x value
-
midY: number
middle point y value
-
endX: number
end point x value
-
endY: number
end point y value
-
Optional numberOfSegments: number
(default: 36)
Returns Path2
the updated Path2.
-
add Line ToSearch playground for addLineTo
-
Adds a new segment until the given coordinates (x, y) to the current Path2.
Parameters
-
x: number
the added points x value
-
y: number
the added points y value
Returns Path2
the updated Path2.
-
closeSearch playground for close
-
Closes the Path2.
Returns Path2
the Path2.
get Point AtLength PositionSearch playground for getPointAtLengthPosition
-
Retreives the point at the distance aways from the starting point
Parameters
-
normalizedLengthPosition: number
the length along the path to retreive the point from
Returns Vector2
a new Vector2 located at a percentage of the Path2 total length on this path.
-
get PointsSearch playground for getPoints
-
Gets the points which construct the path
Returns Vector2[]
the Path2 internal array of points.
lengthSearch playground for length
-
Gets the sum of the distance between each sequential point in the path
Returns number
the Path2 total length (float).
Static Starting AtSearch playground for StartingAt
-
Creates a new path starting from an x and y position
Parameters
-
x: number
starting x value
-
y: number
starting y value
Returns Path2
a new Path2 starting at the coordinates (x, y).
-
Represents a 2D path made up of multiple 2D points