snapKey

移動先: 概要 戻り値 関連項目 フラグ Python の例

概要

snapKey( animatedObject , [animation=string], [attribute=string], [controlPoints=boolean], [float=floatrange], [hierarchy=string], [includeUpperBound=boolean], [index=uint], [shape=boolean], [time=timerange], [timeMultiple=float], [valueMultiple=float])

注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。

snapKey は「元に戻す」が可能、「照会」が不可能、「編集」が不可能です。

キーセットを構成するアニメーション カーブは、「-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 番目のキーを意味します。

このコマンドは、すべてのターゲット キーの時間および/または値を、 指定したフラグ引数の倍数の時間および/または値に「スナップ」します。どちらの倍数も指定されていない場合は、 デフォルトで 1.0 の倍数の時間にスナップされます。 隣接する他のキーを超えてキーを移動すると、 このコマンドは失敗することに注意してください。snapKey 操作を実行しても、 キーのインデックスは変更されません。

TbaseKeySetCmd.h

戻り値

関連項目

フラグ

ロング ネーム（ショート ネーム）	引数型	プロパティ
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」です（詳細については、説明を参照してください）。
timeMultiple(tm)	float
このフラグがある場合、キーの時間は 指定した float 値の倍数にスナップされます。
valueMultiple(vm)	float
このフラグがある場合、キーの値は 指定した float 値の倍数にスナップされます。

: コマンドの作成モードで使用可能なフラグ	: コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ	: タプルまたはリストとして渡された複数の引数を持てるフラグ

Python の例

import maya.cmds as cmds

# Two ways to snap all keys on nurbsSphere1 to integer values.
#
cmds.snapKey( 'nurbsSphere1', tm=1.0 )
cmds.snapKey( 'nurbsSphere1' )

# Snap active objects' keys between times 10 and 20 so that
# they have times that are multiples of 0.5.
#
cmds.snapKey( t=(10,20), tm=0.5 )

# Snap active objects' keys between times 10 and 20 so that
# they have times that are multiples of 0.5 and values that
# are multiples of 1.0.
#
cmds.snapKey( t=(10,20), tm=0.5, vm=1.0 )