FCurve.GetKeysBetween

Introduced

v6.0

Description

Returns a collection of FCurveKey objects representing keys on the function curve between the StartFrame and EndFrame.

Scripting Syntax

oReturn = FCurve.GetKeysBetween( [StartFrame], [EndFrame] );

Return Value

FCurveKeyCollection

Parameters

Parameter Type Description
StartFrame Variant The start time of the range. Must be less than the EndFrame value.

Default Value: The first key frame on the fcurve.

EndFrame Variant The end time of the range.

Default Value: The last key frame on the fcurve.

Examples

JScript Example

// 
// This example illustrates how to get the keys on an fcurve
// in a specific time range
// Create a new scene
NewScene(null, false);
// Create a null
oNull = Application.GetPrim("Null");
// Get the posx parameter of the null
oPosX = oNull.posx
// Create array of time-value pairs
aKeys = new Array( 0.00, 5.00,
                                1.00, 6.00,
                                2.00, 7.00,
                                3.00, 8.00,
                                4.00, 9.00,
                                5.00, 10.00 );
// Create an empty FCurve
oFCurve = oPosX.AddFCurve2( null, siStandardFCurve );
// Set the fcurve keys
oFCurve.SetKeys( aKeys );
var keys = oFCurve.GetKeysBetween(2.0, 4.0);
for (var i = 0; i < keys.Count; i++) 
{
        Application.LogMessage( 'Time: ' + keys(i).Time + ', Value: ' + keys(i).Value, siInfo );
}
// Produces the following output:
//
//INFO : Time: 2, Value: 7
//INFO : Time: 3, Value: 8
//INFO : Time: 4, Value: 9

See Also

FCurve.GetKey FCurve.Keys FCurve.GetNumKeys