Class VFXPath

A class responsible for constructing a path of points used for animation.

Index

Constructors

Accessors

Methods

interpolatedPoint interpolatedPointAtDistance create getPathGenerator

Constructors

constructor

new VFXPath(points: VFXBasePathPoint[]): VFXPath
Construct a VFXPath by providing an array of base point data.
Parameters
- points: VFXBasePathPoint[]
Returns VFXPath

Accessors

pathPoints

get pathPoints(): VFXPathPoint[]
The array of points in the path

Returns VFXPathPoint[]

Methods

interpolatedPoint

interpolatedPoint(x: number, index?: number): VFXPathPoint
Get the interpolated point for a value x on [0, 1]
Parameters
- x: number
  The animation progress on [0, 1]
- index: number = 0
  A known index of the path which was already reached
Returns VFXPathPoint

interpolatedPointAtDistance

interpolatedPointAtDistance(distance: number): VFXPathPoint
Compute an interpolated point along the path at a given distance.
Parameters
- distance: number
  The desired distance along the path
Returns VFXPathPoint
An interpolated point for object position at that distance

`Static`create

create(
    pathName: string,
    points: VFXBasePathPoint[],
    parameters?: object,
): VFXPath
Create a VFXPath instance of a certain named path type defined in CONFIG.Canvas.vfx.paths.
Parameters
- pathName: string
  The named path type to construct
- points: VFXBasePathPoint[]
  Path points to construct
- parameters: object = {}
  Additional parameters used to construct the path
Returns VFXPath
The generated path

`Static`getPathGenerator

getPathGenerator(pathName: string): VFXPathGenerator
Get a configured path generator from CONFIG.Canvas.vfx.paths.
Parameters
- pathName: string
  The named path type
Returns VFXPathGenerator
The path generator function