DeleteKeys

Introduced

v6.0

Categories

animation

Description

Deletes FCurveKeys for the specified timerange (from StartFrame to EndFrame) from one or more FCurves. This is similar to the CutKeys command, except that the deleted keys are not copied to the buffer and thus are not available to the PasteKeys command.

Tip: You specify each fcurve to modify by identifying the parameter it drives in the InputObjs argument.

DeleteKeys is the command equivalent of deleting keys in the dopesheet and should be used when trying to emulate dopesheet behaviour.

Scripting Syntax

DeleteKeys( [InputObjs], [StartFrame], [EndFrame], [Ripple], [SelectedKeysOnly], [Type] );

Parameters

Parameter Type Description
InputObjs String List of animatable parameters (for example "cone*/kine.local.pos"). This parameter uses the Type parameter to interpret which parameters to use in this way:

- If Type == siInputParameters then InputObjs is used exactly as input (either from the specified list or the animatable parameters on the selected objects).

- If Type == siAnimatedParameters then InputObjs is expected to be a list of objects on which each animatable parameter will be affected.

- If Type == siAllAnimatedParameters then the value of InputObjs is ignored and instead the command uses all animated parameters on all objects in the entire scene.

Default Value: If no value is specified for this parameter, the Object List will use the selected objects or parameters respecting the scope indicated by the Type argument.

StartFrame Double Lower bound of the frame interval

Default Value: 1

EndFrame Double Upper bound of the frame interval

Default Value: 100

Ripple Boolean Flag to ripple the keys

Default Value: False

SelectedKeysOnly Boolean True to delete only the selected keys within the timerange (from StartFrame to EndFrame). To create or modify a key selection, use the SelectKeysInTimespan command.

By default (false), this command operates on all keys within the timerange.

Default Value: False

Possible Values:

Description:

0 False
1 True
Type siParameterScope Parameter scope of the operation

Default Value: siInputParameters

See Also

SelectKeysInTimespan DeselectAllKeys CopyKeys CutKeys PasteKeys