keyframe is undoable, queryable, and editable.
This command operates on a keyset. A keyset is
defined as a group of keys within a specified time range on one or
more animation curves.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
-absolute(-a)
|
|
|
|
Move amounts are absolute.
|
|
-adjustBreakdown(-abd)
|
boolean
|
|
|
When false, moving keys will not preserve breakdown
timing, when true (the default) breakdowns will be adjusted
to preserve their timing relationship.
|
|
-animation(-an)
|
string
|
|
|
Where this command should get the animation to act
on. Valid values are "objects," "keys," and
"keysOrObjects" Default: "keysOrObjects." (See
Description for details.)
|
|
-attribute(-at)
|
string
|
|
|
List of attributes to select
In query mode, this flag needs a value.
|
|
-breakdown(-bd)
|
boolean
|
|
|
Sets the breakdown state for the key. Returns
an integer. Default is false. The breakdown state of a key
cannot be set in the same command as it is moved (i.e., via
the -tc or -fc flags).
|
|
-clipTime(-ct)
|
time time float
|
|
|
Modifies the final time where a key is inserted using an
offset, pivot, and scale.
|
|
-controlPoints(-cp)
|
boolean
|
|
|
This flag explicitly specifies whether or not to include the
control points of a shape (see "-s" flag) in the list of attributes.
Default: false. (Not valid for "pasteKey" cmd.)
In query mode, this flag needs a value.
|
|
-eval(-ev)
|
|
|
|
Returns the value(s) of the animCurves when evaluated
(without regard to input connections)
at the times given by the -t/time or -f/float flags. Cannot
be used in combination with other query flags, and
cannot be used with time ranges (-t "5:10").
When no -t or -f flags appear on the command line, the
evals are queried at the current time. Query returns a float[].
|
|
-float(-f)
|
floatrange
|
|
|
value uniquely representing a non-time-based
key (or key range) on a time-based animCurve. Valid
floatRange include single values (-f 10) or a
string with a lower and upper bound, separated by a
colon (-f "10:20")
In query mode, this flag needs a value.
|
|
-floatChange(-fc)
|
float
|
|
|
How much (with -relative) or where (with -absolute)
to move keys (on non-time-input animation curves)
along the x (float) axis. Returns float[] when queried.
|
|
-hierarchy(-hi)
|
string
|
|
|
Hierarchy expansion options. Valid values are "above,"
"below," "both," and "none." (Not valid for "pasteKey" cmd.)
In query mode, this flag needs a value.
|
|
-includeUpperBound(-iub)
|
boolean
|
|
|
When the -t/time or -f/float flags represent a range
of keys, this flag determines whether the keys at the
upper bound of the range are included in the keyset.
Default value: true. This flag is only valid when
the argument to the -t/time flag is a time range with
a lower and upper bound. (When used with the "pasteKey"
command, this flag refers only to the time range of the
target curve that is replaced, when using options such
as "replace," "fitReplace," or "scaleReplace." This
flag has no effect on the curve pasted from the clipboard.)
|
|
-index(-in)
|
uint
|
|
|
index of a key on an animCurve
In query mode, this flag needs a value.
|
|
-indexValue(-iv)
|
|
|
|
Query-only flag that returns an int for the key's index.
|
|
-keyframeCount(-kc)
|
|
|
|
Returns an int for the number of keys found for the
targets.
|
|
-lastSelected(-lsl)
|
|
|
|
When used in queries, this flag returns requested values
for the last selected key.
|
|
-name(-n)
|
|
|
|
Returns the names of animCurves of specified nodes,
attributes or keys.
|
|
-option(-o)
|
string
|
|
|
Valid values are "move," "insert," "over," and
"segmentOver." When you "move" a key, the key will not cross over
(in time) any keys before or after it. When you "insert" a key,
all keys before or after (depending upon the -timeChange value)
will be moved an equivalent amount. When you "over" a key, the key
is allowed to move to any time (as long as a key is not there already).
When you "segmentOver" a set of keys (this option only has a
noticeable effect when more than one key is being moved) the first
key (in time) and last key define a segment (unless you specify a
time range). That segment is then allowed to move over other keys,
and keys will be moved to make room for the segment.
|
|
-relative(-r)
|
|
|
|
Move amounts are relative to a key's current position.
|
|
-selected(-sl)
|
|
|
|
When used in queries, this flag returns requested values
for any active keys.
|
|
-shape(-s)
|
boolean
|
|
|
Consider attributes of shapes below transforms as well,
except "controlPoints". Default: true. (Not valid for "pasteKey" cmd.)
In query mode, this flag needs a value.
|
|
-tickDrawSpecial(-tds)
|
boolean
|
|
|
Sets the special drawing state for this key when it
is drawn as a tick in the timeline.
|
|
-time(-t)
|
timerange
|
|
|
time uniquely representing a key (or key
range) on a time-based animCurve. Valid timeRanges
include single values (-t 10) or a string
with a lower and upper bound, separated by a colon
(-t "10:20")
In query mode, this flag needs a value.
|
|
-timeChange(-tc)
|
time
|
|
|
How much (with -relative) or where (with -absolute)
to move keys (on time-input animation curves)
along the x (time) axis. Returns float[] when queried.
|
|
-valueChange(-vc)
|
float
|
|
|
How much (with -relative) or where (with -absolute)
to move keys along the y (value) axis. Returns float[]
when queried.
|
|