Go to: Synopsis. Return value. Related. Flags. Python examples.
filterButterworthCtx(
contextName
, [apply=boolean], [cutoffFrequency=float], [endTime=time], [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [keepKeysOnFrame=boolean], [name=string], [samplingRate=float], [selectedKeys=boolean], [startTime=time])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
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.
In query mode, return type is based on queried flag.
filterCurve
apply, cutoffFrequency, endTime, exists, history, image1, image2, image3, keepKeysOnFrame, name, samplingRate, selectedKeys, startTime
Long name (short name) |
Argument types |
Properties |
|
apply(a)
|
boolean
|
|
|
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
|

|
|
Specifies the cutoff frequency setting of the Butterworth filter.
Default is 7.0.
|
|
endTime(e)
|
time
|

|
|
Specifies the end time portion of the time range for this filter.
This time range is used when selectedKeys is false.
|
|
exists(ex)
|
boolean
|
|
|
Returns true or false depending upon whether the
specified object exists. Other flags are ignored.
|
|
history(ch)
|
boolean
|
|
|
If this is a tool command, turn the construction history on
for the tool in question.
|
|
image1(i1)
|
string
|
 
|
|
First of three possible icons representing the tool
associated with the context.
|
|
image2(i2)
|
string
|
 
|
|
Second of three possible icons representing the tool
associated with the context.
|
|
image3(i3)
|
string
|
 
|
|
Third of three possible icons representing the tool
associated with the context.
|
|
keepKeysOnFrame(kof)
|
boolean
|

|
|
When true, the Butterworth filter will reposition output keys to
whole frames for the specified sampling rate.
|
|
name(n)
|
string
|
|
|
If this is a tool command, name the tool appropriately.
|
|
samplingRate(sr)
|
float
|

|
|
Specifies the sampling rate setting of the Butterworth filter.
Default is 30.0.
|
|
selectedKeys(sk)
|
boolean
|

|
|
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
|

|
|
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 have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
import maya.cmds as cmds
# Create a context
ctx = cmds.filterButterworthCtx()
# Activate the tool context
cmds.setToolTo( ctx )
# Adjust the Butterworth cutoff frequency to selected keys.
cmds.filterButterworthCtx( ctx, e=True, sk=True, cof=3.0 )
# Apply the current settings to the selected curves.
cmds.filterButterworthCtx( ctx, e=True, apply=True )