移動先: 概要 戻り値 フラグ. Python 例.
soundControl(
string
, [annotation=string], [backgroundColor=[float, float, float]], [beginScrub=boolean], [defineTemplate=string], [displaySound=boolean], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [endScrub=boolean], [exists=boolean], [height=int], [isObscured=boolean], [manage=boolean], [maxTime=time], [minTime=time], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [pressCommand=string], [preventOverride=boolean], [releaseCommand=string], [repeatChunkSize=float], [repeatOnHold=boolean], [resample=boolean], [sound=string], [useTemplate=string], [visible=boolean], [waveform=string], [width=int])
注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。
soundControl は 「元に戻す」が可能、「照会」が可能、「編集」が可能 です。
このコマンドは、カレント タイムの変更や、
音声ファイルのスクラッチ/スクラブを行う際に使用するコントロールを作成します。
string | 作成または編集されたコントロールの名前。 |
戻り値の型は照会モードでは照会フラグが基になります。
annotation, backgroundColor, beginScrub, defineTemplate, displaySound, docTag, dragCallback, dropCallback, enable, endScrub, exists, height, isObscured, manage, maxTime, minTime, numberOfPopupMenus, parent, popupMenuArray, pressCommand, preventOverride, releaseCommand, repeatChunkSize, repeatOnHold, resample, sound, useTemplate, visible, waveform, width
ロング ネーム(ショート ネーム) |
引数型 |
プロパティ |
sound(s)
|
string
|

|
|
サウンド表示ウィジェットにデータを表示する
オーディオ ディペンデンシー ノードの名前です。照会すると、このフラグは string を返します。
|
|
displaySound(ds)
|
boolean
|

|
|
サウンド表示をオフにします。照会すると、このフラグは整数を返します。
|
|
waveform(wf)
|
string
|

|
|
-displaySound が「true」の場合に、
表示するサウンドの波形の部分を定義します。有効な値は、「top」、「bottom」、「both」です。デフォルトは「top」です。照会すると、このフラグは string を返します。
|
|
resample(r)
|
boolean
|
|
|
ウィジェットに適合するように、サウンド表示を再びサンプリングします。
|
|
repeatOnHold(roh)
|
boolean
|

|
|
マウスダウン イベント時にサウンドを繰り返します。
|
|
repeatChunkSize(rcs)
|
float
|

|
|
-repeatOnHold が true の場合に繰り返す
サウンドの量(カレントの時間単位)。デフォルトは 1.0 です。
|
|
beginScrub(bs)
|
boolean
|
|
|
サウンドをスクラブするには、このウィジェットを設定します。
その後にカレント タイムが変更されると、
このウィジェットに対して「-endScrub」コマンドが発行されるまで、
「サウンド スクラブ」動作を実行します。
|
|
endScrub(es)
|
boolean
|
|
|
このウィジェットのサウンド スクラブを終了します。これでサウンド スクラブ動作が停止します。
これは、その後の「-beginScrub」フラグの前に
発行する必要があります。
|
|
exists(ex)
|
boolean
|
|
|
指定したオブジェクトが存在するかどうかによって、
true または false を返します。他のフラグは無視されます。
|
|
defineTemplate(dt)
|
string
|
|
|
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに
追加するモードに、コマンドのモードを変更します。
templateName がカレントのテンプレートとして設定されていれば、
その後コマンドが実行されるたびに、この引数がデフォルトの引数として使用されます。
|
|
useTemplate(ut)
|
string
|
|
|
コマンドに、カレント以外のコマンド テンプレートの使用を強制します。
|
|
parent(p)
|
string
|

|
|
enable(en)
|
boolean
|
 
|
|
コントロールの有効、無効です。デフォルトでは true に設定されていて、コントロールは有効になっています。false を指定すると
コントロールはグレー表示になって無効になります。
|
|
width(w)
|
int
|
 
|
|
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
|
|
height(h)
|
int
|
 
|
|
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
|
|
visible(vis)
|
boolean
|
 
|
|
コントロールの可視の状態です。デフォルトでは、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって
異なることに注意してください。
|
|
isObscured(io)
|
boolean
|
|
|
コントロールが実際に表示されるかどうかを返します。
コントロールは、次の場合に隠れた状態になります。
非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、
コントロールまたは親のレイアウトを制御できない場合、あるいは
コントロールのウィンドウが非表示またはアイコン化されている場合。
|
|
manage(m)
|
boolean
|
 
|
|
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。デフォルトでは、コントロールは管理できるように作成されます。
|
|
numberOfPopupMenus(npm)
|
boolean
|
|
|
このコントロールにアタッチされるポップアップ メニューの数を返します。
|
|
popupMenuArray(pma)
|
boolean
|
|
|
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
|
|
preventOverride(po)
|
boolean
|
 
|
|
true の場合、コントロールのコントロールは親のレイアウトの条件によって無効にされ右マウス ボタン メニューを使用した
コントロール アトリビュートのオーバーライドは無効です。
|
|
annotation(ann)
|
string
|
 
|
|
backgroundColor(bgc)
|
[float, float, float]
|

|
|
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0~1.0 です(Windows のみのフラグです)。
|
|
docTag(dtg)
|
string
|
 
|
|
コントロールにドキュメンテーション フラグを追加します。ドキュメンテーション フラグは、
階層のようなディレクトリ構造になっています。
例: -dt render/multiLister/createNode/material
|
|
dragCallback(dgc)
|
script
|

|
|
中マウス ボタンを押すと呼び出されるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。
global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)
proc はドロップ先に転送される文字配列を返します。
規則により、配列の先頭文字列はユーザ設定可能なメッセージ タイプを表しています。アプリケーションで定義されたドラッグ元のコントロールは、このコールバックを無視する可能性があります。$mods で、キー モディファイアである CTL と SHIFT をテストできます。有効な値は、0 == モディファイアなし、1 == SHIFT、2 == CTL、3 == CTL + SHIFT です。
Python でも同様ですが、コールバックの指定方法が 2 つあります。お勧めの方法は、引数として Python 関数オブジェクトを渡すことです。
この場合、Python コールバックの書式は次のようになります。
def callbackName( dragControl, x, y, modifiers ):
この引数の値は、上記の MEL バージョンの引数と同じです。
Python でコールバックを指定するもう 1 つの方法では、実行する文字列を指定します。この場合、Python の標準的なフォーマット演算子を介して文字列に値が代入されます。このフォーマットの値は、キー「dragControl」、「x」、「y」、「modifiers」と共に
辞書で渡されます。dragControl の値は文字列で、その他の値は整数です(コールバック文字列の例:「print '%(dragControl)s %(x)d %(y)d %(modifiers)d'」)。
|
|
dropCallback(dpc)
|
script
|

|
|
ドラッグ&ドロップ操作をドロップ位置で解放したときに呼び出されるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。
global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type)
proc は、ドラッグ元から転送される文字配列を受け取ります。
msgs 配列の先頭文字列はユーザ定義のメッセージ タイプを表します。
アプリケーションで定義されたドロップ先のコントロールでは、このコールバックが無視されることがあります。$type の値は、1 == 移動、2 == コピー、3 == リンクのいずれかです。
Python でも同様ですが、コールバックの指定方法が 2 つあります。お勧めの方法は、引数として Python 関数オブジェクトを渡すことです。
この場合、Python コールバックの書式は次のようになります。
def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ):
この引数の値は、上記の MEL バージョンの引数と同じです。
Python でコールバックを指定するもう 1 つの方法では、実行する文字列を指定します。この場合、Python の標準的なフォーマット演算子を介して文字列に値が代入されます。このフォーマットの値は、
キー「dragControl」、「dropControl」、「messages」、「x」、「y」、「type」と共に
辞書で渡されます。dragControl の値は文字列で、その他の値は整数です(コールバック文字列の例:「print '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'」)。
|
|
minTime(min)
|
time
|
 
|
|
コントロールに表示される範囲の最小時間を制御します。
照会すると、このフラグは float を返します。
|
|
maxTime(max)
|
time
|
 
|
|
コントロールに表示される範囲の最大時間を制御します。
照会すると、このフラグは float を返します。
|
|
pressCommand(pc)
|
string
|

|
|
このコントロールでのマウスダウン イベント時に
実行するスクリプトです。
|
|
releaseCommand(rc)
|
string
|

|
|
このコントロールでのマウスアップ イベント時に実行するスクリプトです。
|
|
: コマンドの作成モードで使用可能なフラグ
|
: コマンドの編集モードで使用可能なフラグ
|
: コマンドの照会モードで使用可能なフラグ
|
: タプルまたはリストとして渡された複数の引数を持てるフラグ
|
import maya.cmds as cmds
# To display sound in a soundControl, there must first be a sound
# node in the scene. We'll create one and give it the name "ohNo".
# Note that the argument to the -file flag must be a path to a valid
# soundfile.
#
cmds.sound( file='ohNo.aiff', name='ohNo' )
# Create a sound control (named "soundScrubber")
# and have it display the sound associated with audio node "ohNo".
#
cmds.window()
cmds.frameLayout( lv=False )
cmds.soundControl( 'soundScrubber', width=600, height=45, sound='ohNo', displaySound=True, waveform='both' )
cmds.showWindow()
# Now setup "soundScrubber" to actually scrub with
# mouse drags.
#
pressCmd = "soundControl -e -beginScrub soundScrubber"
releaseCmd = "soundControl -e -endScrub soundScrubber"
cmds.soundControl( 'soundScrubber', e=True, pc=cmds.soundControl('soundScrubber',e=True,beginScrub=True, rc=cmds.sound('soundScrubber',e=True,endScrub=True)))