Class PathCursor

A cursor which tracks a point on a path

Hierarchy

PathCursor

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PathCursor(_path: Path2): PathCursor

- Defined in .temp/docdirectory/doc.d.ts:4120
Initializes the path cursor

Parameters
- _path: Path2
  
  The path to track
Returns PathCursor

Properties

animationsSearch playground for animations

animations: Animation[]

The animation array of the path cursor

valueSearch playground for value

value: number

The value of the path cursor

Methods

getPointSearch playground for getPoint

getPoint(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:4130
Gets the cursor point on the path

Returns Vector3

A point on the path cursor at the cursor location

moveSearch playground for move

move(step: number): PathCursor

- Defined in .temp/docdirectory/doc.d.ts:4149
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

moveAheadSearch playground for moveAhead

moveAhead(step?: number): PathCursor

- Defined in .temp/docdirectory/doc.d.ts:4136
Moves the cursor ahead by the step amount

Parameters
- Optional step: number
  
  The amount to move the cursor forward
Returns PathCursor

This path cursor

moveBackSearch playground for moveBack

moveBack(step?: number): PathCursor

- Defined in .temp/docdirectory/doc.d.ts:4142
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

onchange(f: (cursor: PathCursor) => void): PathCursor

- Defined in .temp/docdirectory/doc.d.ts:4165
Executes a function on change

Parameters
- f: (cursor: PathCursor) => void
  
  A path cursor onchange callback
  - - (cursor: PathCursor): void
    - Parameters
      - cursor: PathCursor
      Returns void
Returns PathCursor

This path cursor