pc.Curve

A curve is a collection of keys (time/value pairs). The shape of the curve is defined by its type that specifies an interpolation scheme for the keys.

Summary

Properties

length	The number of keys in the curve.
type	The curve interpolation scheme.

Methods

add	Add a new key to the curve.
clone	Returns a clone of the specified curve object.
get	Return a specific key.
sort	Sort keys by time.
value	Returns the interpolated value of the curve at specified time.

Details

Constructor

Curve([data]) 

Creates a new curve.

Parameters

data

Number[]

An array of keys (pairs of numbers with the time first and value second)

Properties

Numberlength 

The number of keys in the curve. [read only]

Numbertype 

The curve interpolation scheme. Can be:

Defaults to pc.CURVE_SMOOTHSTEP;

Methods

add(time, value) 

Add a new key to the curve.

Parameters

time	Number	Time to add new key
value	Number	Value of new key

Returns

Number[] [time, value] pair

clone() 

Returns a clone of the specified curve object.

Returns

pc.Curve A clone of the specified curve

get(index) 

Return a specific key.

Parameters

index

Number

The index of the key to return

Returns

Number[] The key at the specified index

sort() 

Sort keys by time.

value(time) 

Returns the interpolated value of the curve at specified time.

Parameters

time

Number

The time at which to calculate the value

Returns

Number The interpolated value