keyframe

ジャンプ先: 概要. 戻り値. 関連. フラグ. Python 例.

概要

keyframe( [objects] , [absolute=boolean], [adjustBreakdown=boolean], [animation=string], [attribute=string], [breakdown=boolean], [controlPoints=boolean], [eval=boolean], [float=floatrange], [floatChange=float], [hierarchy=string], [includeUpperBound=boolean], [index=uint], [indexValue=boolean], [keyframeCount=boolean], [lastSelected=boolean], [name=boolean], [option=string], [relative=boolean], [selected=boolean], [shape=boolean], [tickDrawSpecial=boolean], [time=timerange], [timeChange=time], [valueChange=float])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。

keyframe は、取り消し可能、照会可能、および 編集可能 です。

キーセットを構成するアニメーション カーブは、「-animation」フラグの値に依存します。

• keysOrObjects:
  1. コマンド ラインにターゲット オブジェクトまたは -attribute フラグが表示されていない場合は任意のアクティブ キー
  2. アクティブ キーが存在しない場合は、コマンド ラインの targetList として指定されているオブジェクトのキーフレーム可能なすべてのアトリビュートに接続されたすべてのアニメーション カーブ
• keys:アクティブなキーまたは接線のみに作用します。アクティブなキーまたは接線がない場合は、何も行いません。
• objects:指定したオブジェクトのみに作用します。オブジェクトが指定されていない場合は、何も行いません。

-animation フラグを使用して、「translateX」など attributeName という形式の引数を取る、多目的な -attribute フラグによって固有に識別されるカーブをオーバーライドすることができます。

アニメーション カーブ上の各キーは、カーブの時間値またはインデックスによって識別されます。時間とインデックスは、単独にあるいはリストの一部または範囲として指定することができます。

• -time 10pal は、フレーム 10 のキーを意味します(PAL 形式)。
• -time 1.0sec -time 15ntsc -time 20 は、時間 1.0 秒、フレーム 15 (NTSC 形式)、時間 20 (現在定義されているグローバル時間単位)のキーを意味します。
• -time "10:20" は、10～20 の範囲(現在の時間単位、両方の値を含む)のすべてのキーを意味します。

• -time "10:" は、時間 10 (現在の時間単位)より後にあるすべてのキーを意味します。
• -time ":10" は、時間 10 (現在の時間単位)以前のすべてのキーを意味します。
• -time ":" は、すべてのキーを指定するための短い形式です。

• -index 0 は、各アニメーション カーブの最初のキーを意味します(インデックスは 0 ベースです)。
• -index 2 -index 5 -index 7 は、3 番目、6 番目、8 番目のキーを意味します。
• -index "1:5" は、各アニメーショ ン カーブの 2 番目、3 番目、4 番目、5 番目、6 番目のキーを意味します。

戻り値

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

関連

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
attribute(at)	string
選択するアトリビュートのリストです。 照会モードでは、このフラグに値が必要になります。
hierarchy(hi)	string
階層展開オプションです。有効な値は、「above」、「below」、「both」、「none」です。(「pasteKey」コマンドでは無効)。 照会モードでは、このフラグに値が必要になります。
shape(s)	boolean
トランスフォームの下にあるシェイプのアトリビュート(「controlPoints」以外)も考慮します。既定: true (「pasteKey」コマンドでは無効)。 照会モードでは、このフラグに値が必要になります。
controlPoints(cp)	boolean
このフラグは、アトリビュートのリストにシェイプの制御点を含めるかどうかを明示的に指定します(「-s」フラグを参照)。既定: false (「pasteKey」コマンドでは無効)。 照会モードでは、このフラグに値が必要になります。
index(index)	uint
アニメーション カーブ上のキーのインデックス 照会モードでは、このフラグに値が必要になります。
time(t)	timerange
時間ベースのアニメーション カーブ上のキー(またはキー レンジ)を固有に表す時間です。有効な timeRange は、単一の値(-t 10)、または上下限をコロンで区切った文字列(-t "10:20")です。 照会モードでは、このフラグに値が必要になります。
float(f)	floatrange
時間ベースの animCurve上の時間ベースでないキー(またはキー レンジ)を固有に表す値です。有効な floatRange は、単一の値(-f 10)、または上下限をコロンで区切った文字列(-f "10:20")です。 照会モードでは、このフラグに値が必要になります。
includeUpperBound(iub)	boolean
-t/time または -f/float フラグがキーの範囲を表す場合に、範囲の上限のキーをキーセットに含めるかどうかを定義します。既定値: true。このフラグは、-t/time フラグの引数が上下限が指定したタイム レンジである場合に限り有効です（「pasteKey」コマンドでこのフラグを使用するときに「replace」、「fitReplace」、「scaleReplace」などのオプションを指定すると、このフラグは、置き換えられるターゲット カーブの時間範囲のみを参照します。このフラグは、クリップボードからペーストされたカーブには影響しません）。
animation(an)	string
このコマンドが、自身が影響を与えるアニメーションを取得する場所です。有効な値は「objects」、「keys」、「keysOrObjects」で、既定は「keysOrObjects」です(詳細については、説明を参照してください)。
absolute(a)	boolean
移動量は絶対値です。
relative(r)	boolean
移動量は、キーの現行位置を基準にして相対値です。
timeChange(tc)	time
x (時間)軸に沿ったキーの(時間入力アニメーション カーブ上での)移動量(-relative で)または移動場所(-absolute で)を指定します。照会すると float[] を返します。
floatChange(fc)	float
x (float)軸に沿ったキーの(非時間入力アニメーション カーブ上での)移動量(-relative で)または移動場所(-absolute で)を指定します。照会すると float[] を返します。
indexValue(iv)	boolean
キーのインデックスに対して整数を返す照会専用のフラグです。
valueChange(vc)	float
y (値)軸に沿ったキーの移動量(-relative で)または移動場所(-absolute で)を指定します。照会すると float[] を返します。
option(o)	string
有効な値は、「move」、「insert」、「over」、「segmentOver」です。キーに「move」を設定しても、そのキーは前後でほかのキーを越えては移動しません。キーを「insert」すると、(-timeChange の値に応じて)その前後にあるキーがすべて、同等の量、移動します。キーを「over」すると、このキーは(他のキーがその場所に既に存在しない限り)いつでも移動することができます。複数のキーのセットを「segmentOver」すると(このオプションは、複数のキーを移動する場合のみ、明らかなエフェクトを生み出します)、タイム レンジを指定しない限り、(時間的に)最初のキーと、最後のキーにより、セグメントが定義されます。その後、このセグメントは他のキーの上に移動できるようになり、このセグメントのための余地を作るために、キーは移動します。
adjustBreakdown(abd)	boolean
false のときは、キーを移動してもブレークダウン タイミングは保持されません。true (既定)のときは、ブレークダウン タイミング リレーションが保持されるように調整されます。
breakdown(bd)	boolean
キーのブレークダウン状態を設定します。整数を返します。既定は false です。キーのブレークダウン状態は、-tc や -fc フラグを使ったキーの移動コマンドでは設定できません。
tickDrawSpecial(tds)	boolean
タイム スライダの表示がキー マークに変わると、このキーに特殊な描画状態が設定されます。
keyframeCount(kc)	boolean
ターゲット用に見つかったキーの数に対して整数を返します。
name(n)	boolean
指定したノード、アトリビュート、キーのアニメーション カーブの名前を返します。
eval(ev)	boolean
入力接続と無関係に、-t/time または -f/float フラグで指定される時間で評価されるときのアニメーション カーブの値を返します。他の照会フラグと一緒に使ったり、タイム レンジ(-t "5:10")と共に使うことはできません。コマンド ラインに -t または -f フラグが使われていないとき、eval は現在のタイムに照会されます。照会すると float[] を返します。
selected(sl)	boolean
このフラグが照会で使われた場合、どんなアクティブなキーに対しても要求された値を返します。
lastSelected(lsl)	boolean
このフラグが照会で使われた場合、最後に選択したキーに対して要求された値を返します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

# Two ways to find out how many keys there are on the
# paramCurve connected to surface1.translateX;
#
cmds.keyframe( 'surface1', attribute='translateX', query=True, keyframeCount=True )
cmds.keyframe( 'surface1.translateX', query=True, keyframeCount=True )
# Query all keyframes of object "surface1" within the time range 0 to 20.
#
cmds.keyframe( 'surface1', time=(0,20), query=True, valueChange=True, timeChange=True);
# Query just the time of the first key in the
# "Translate X" parameter curve.  Note that the indices are 0-based.
#
cmds.keyframe('surface1.translateX',index=(0,0),query=True);
# Shift all the active object's keys in the range 10-20
# by one (current) time unit (frame, second, etc.)
#
cmds.keyframe(edit=True,relative=True,timeChange=1,time=(10,20))
# Two ways to move all keys at time 10 of
# the active object to time 12.  Note that "-absolute"
# is the default.
#
cmds.keyframe(time=(10,10),timeChange=12)
cmds.keyframe(time=(10,10),absolute=True,timeChange=12)
# Set the 2nd keyframe of cube1's Translate X parameter
# curve to be 10.25 at time 1.5 seconds.
#
cmds.keyframe('surface1.translateX',edit=True,index=(1,1),timeChange='1.5sec',valueChange=10.25)
# Evaluate the animCurve feeding into nurbsCone1's translateX attribute at time 3
#
cmds.keyframe('nurbsCone1',at='tx',t=(3,3),q=True,eval=True)
# Query the times of the active keys on attribute translateX of nurbsCone1
#
cmds.keyframe( 'nurbsCone1', at='tx', sl=True, q=True, tc=True )
# How many keys are selected on nurbsCone1?
#
cmds.keyframe( 'nurbsCone1', sl=True, q=True, kc=True )
# Here's a script to print out all a cone's animCurves that have
# keys selected.  Each animCurve is followed by a list of times
# for the selected keys.  The result of this script is:
#     nurbsCone1_translateX: 5
#     nurbsCone1_translateY: 12
#     nurbsCone1_translateZ: 4 14
#
myCone = cmds.cone()
cmds.setKeyframe( myCone[0], t=[0,5,10], at='tx', v=5 )
cmds.setKeyframe( myCone[0], t=[2,7,12], at='ty', v=10 )
cmds.setKeyframe( myCone[0], t=[4,9,14], at='tz', v=15 )
cmds.selectKey( t=[(5,5),(12,12),(4,4)] )
cmds.selectKey( animation='objects', add=True, t=(14,14) )
nodes = cmds.keyframe(myCone,query=True,name=True)
for node in nodes:
   keyTimes = cmds.keyframe(node,sl=True,query=True,tc=True)
   print "Node: %s" % node
   print keyTimes
# For the above sample script, the last selected key is
# nurbsCone1_translateZ: 14.  The following may be used to query
# the values for that key
#
cmds.keyframe( query=True, lastSelected=True, name=True )
cmds.keyframe( query=True, lastSelected=True, timeChange=True )
cmds.keyframe( query=True, lastSelected=True, valueChange=True )