LinearSpline - Cesium Documentation

LinearSpline

new LinearSpline

A spline that uses piecewise linear interpolation to create a curve.

Parameters:

Name	Type	Description
`options.times`	Array	The array of control point times.
`options.points`	Array	The array of control points.

Throws:

DeveloperError : points is required.
DeveloperError : points.length must be greater than or equal to 2.
DeveloperError : times is required.
DeveloperError : times.length must be equal to points.length.

Example

var spline = new LinearSpline({
    times : [ 0.0, 1.5, 3.0, 4.5, 6.0 ],
    points : [
        new Cartesian3(1235398.0, -4810983.0, 4146266.0),
        new Cartesian3(1372574.0, -5345182.0, 4606657.0),
        new Cartesian3(-757983.0, -5542796.0, 4514323.0),
        new Cartesian3(-2821260.0, -5248423.0, 4021290.0),
        new Cartesian3(-2539788.0, -4724797.0, 3620093.0)
    ]
});

Source:

/Source/Core/LinearSpline.js

Members

<readonly> points :Array

An array of Cartesian3 control points.

<readonly> times :Array

An array of times for the control points.

Methods

evaluate

Evaluates the curve at a given time.

Parameters:

Name	Type	Argument	Description
`time`	Number		The time at which to evaluate the curve.
`result`	Cartesian3	<optional>	The object onto which to store the result.

Throws:

DeveloperError : time is required.
DeveloperError : time must be in the range [t₀, t_n], where t₀ is the first element in the array times and t_n is the last element in the array times.

Returns:

Cartesian3 The modified result parameter or a new instance of the point on the curve at the given time.