ActivateFCurveOnKeyable

Introduced

v5.0

Description

Activates or deactivates an entire curve or just a region of the curve.

ActivateFCurveOnKeyable is the command equivalent of the same functionality available in the DopeSheet. It should be used when trying to emulate the DopeSheet behavior.

Note: This command is very similiar to ActivateFCurve with the only difference being the input objects and the list of parameters on which the FCurve Activation/Deactivation is done.

Scripting Syntax

ActivateFCurveOnKeyable( [InputObjs], Activate, [StartFrame], [EndFrame] );

Parameters

Parameter Type Description
InputObjs String Object name (anything selectable)

Default Value: Currently selected objects

Activate Boolean True to activate the entire curve or the input range.

Default Value: True

StartFrame Double Start frame of the region of the fcurve(s) you want to operate.

Leave both Start and End blank for entire curve.

Possible Values:

Description:

-Inf < 0 > +Inf Value range -Inf, +Inf
EndFrame Double End frame of the region of the fcurve(s) you want to operate.

Leave both Start and End blank for entire curve.

Possible Values:

Description:

-Inf < 0 > +Inf Value range -Inf, +Inf

Examples

VBScript Example

' First get a primitive and animate its translation

NewScene , False

CreatePrim "Cylinder", "MeshSurface"

Translate , -7.01063515498729, 5.25147709343595, -0.525147709343595, siRelative, siView, siObj, siXYZ

SaveKeyOnKeyable "cylinder", 1

SetValue "PlayControl.Key", 25

SetValue "PlayControl.Current", 25

Translate , 14.8089821251417, -10.34619367662, 1.034619367662, siRelative, siView, siObj, siXYZ

SaveKeyOnKeyable "cylinder", 25

SetValue "PlayControl.Key", 50

SetValue "PlayControl.Current", 50

Translate , -15.3603803957587, -0.391901275629446, 3.91901275629446E-02, siRelative, siView, siObj, siXYZ

SaveKeyOnKeyable "cylinder", 50

SetValue "PlayControl.Key", 75

SetValue "PlayControl.Current", 75

Translate , 14.5726685805916, 10.9732357176274, -1.09732357176274, siRelative, siView, siObj, siXYZ

SaveKeyOnKeyable "cylinder", 75

SetValue "PlayControl.Key", 1

SetValue "PlayControl.Current", 1

SetValue "PlayControl.Key", 100

SaveKeyOnKeyable "cylinder", 100

' Note: to see these deactivations open the DopeSheet on the cylinder

' Deactivate all the keyable FCurves under the cylinder object

ActivateFCurveOnKeyable "cylinder", False

' Reactivate all the keyable FCurves under the cylinder object

ActivateFCurveOnKeyable "cylinder", True

See Also

FCurve ActivateFCurve ActivateFCurveOnMarkedKeyable