Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

filterButterworthCtx [-apply] [-cutoffFrequency float] [-endTime time] [-exists] [-history boolean] [-image1 string] [-image2 string] [-image3 string] [-keepKeysOnFrame boolean] [-name string] [-samplingRate float] [-selectedKeys boolean] [-startTime time] contextName

filterButterworthCtx is undoable, queryable, and editable.

Creates/edits a Butterworth filter context. This context can be used to interactively preview/edit the Butterworth filter on a set of animation curves.

Return value

stringContext name

In query mode, return type is based on queried flag.

Related

filterCurve

Flags

apply, cutoffFrequency, endTime, exists, history, image1, image2, image3, keepKeysOnFrame, name, samplingRate, selectedKeys, startTime
Long name (short name) Argument types Properties
-apply(-a) edit
When specified, finalizes the current context state and records the command for the operation. This is equivalent to completing the tool action without exiting the current tool context.
-cutoffFrequency(-cof) float queryedit
Specifies the cutoff frequency setting of the Butterworth filter. Default is 7.0.
-endTime(-e) time queryedit
Specifies the end time portion of the time range for this filter. This time range is used when selectedKeys is false.
-exists(-ex) create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-history(-ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
-image1(-i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
-image2(-i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
-image3(-i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
-keepKeysOnFrame(-kof) boolean queryedit
When true, the Butterworth filter will reposition output keys to whole frames for the specified sampling rate.
-name(-n) string create
If this is a tool command, name the tool appropriately.
-samplingRate(-sr) float queryedit
Specifies the sampling rate setting of the Butterworth filter. Default is 30.0.
-selectedKeys(-sk) boolean queryedit
If true, sets the filter to apply to the selected keys. Otherwise, the filter applies to the specified time range. Default is on.
-startTime(-s) time queryedit
Specifies the start time portion of the time range for this filter. This time range is used when selectedKeys is false.

Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// Create a context
string $ctx = `filterButterworthCtx`;

// Activate the tool context
setToolTo $ctx;

// Adjust the Butterworth cutoff frequency to selected keys.
filterButterworthCtx -e -sk 1 -cof 3.0 $ctx;

// Apply the current settings to the selected curves.
filterButterworthCtx -e -apply $ctx;