GetFCurveInfo

Description

Gets function curve information for a parameter.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

GetFCurveInfo( InputObj, [CurveKind], [ValueWhenNoKey], NbKeys, [ExtrapolationKind], [DefaultSegKind], [LowClamp], [HighClamp] )

Parameters

Parameter

Type

Description

InputObj

String

FCurve animation source.

CurveKind [out]

Integer

Returns the type of function curve.

Possible Values:

0: UNKNOWN

10: BOOLEAN

15: INTEGER

20: STANDARD

30: RAWDATA

ValueWhenNoKey [out]

Double

Returns the value of the function curve when it has no keys.

NbKeys [out]

Integer

Returns the number of keys.

ExtrapolationKind [out]

Integer

Returns the extrapolation type of the function curve.

Possible Values:

1: CONSTANT

2: LINEAR

3: PERIODIC

DefaultSegKind [out]

Integer

Returns the default segment kind. Applies to standard function curves.

Possible Values:

0: DEFAULT

1: CONSTANT

2: LINEAR

3: CUBIC

LowClamp [out]

Double

Returns the lower-clamping value.

HighClamp [out]

Double

Returns the higher-clamping value.

See Also

FCurve

GetSource

GetKeyInfo

Examples

• See GetFCurveInfo.1.vbs

• See GetFCurveInfo.2.js



Autodesk Softimage 2011