Class PathCursor
Hierarchy
- PathCursor
Index
Constructors
Properties
Methods
Constructors
constructor
-
Initializes the path cursor
Parameters
-
path: Path2
The path to track
Returns PathCursor
-
Properties
animationsSearch playground for animations
The animation array of the path cursor
valueSearch playground for value
The value of the path cursor
Methods
get PointSearch playground for getPoint
-
Gets the cursor point on the path
Returns Vector3
A point on the path cursor at the cursor location
moveSearch playground for move
-
Moves the cursor by the step amount If the step amount is greater than one, an exception is thrown
Parameters
-
step: number
The amount to move the cursor
Returns PathCursor
This path cursor
-
move AheadSearch playground for moveAhead
-
Moves the cursor ahead by the step amount
Parameters
-
Optional step: number
The amount to move the cursor forward
Returns PathCursor
This path cursor
-
move BackSearch playground for moveBack
-
Moves the cursor behind by the step amount
Parameters
-
Optional step: number
The amount to move the cursor back
Returns PathCursor
This path cursor
-
onchangeSearch playground for onchange
-
Executes a function on change
Parameters
-
f: (cursor: PathCursor) => void
A path cursor onchange callback
-
-
Parameters
-
cursor: PathCursor
Returns void
-
-
-
Returns PathCursor
This path cursor
-
A cursor which tracks a point on a path