filePathEditor

ジャンプ先: 概要. 戻り値. キーワード. フラグ. Python 例.

概要

filePathEditor([attributeType=string], [copyAndRepath=[string, string]], [deregisterType=string], [force=boolean], [listDirectories=string], [listFiles=string], [listRegisteredTypes=boolean], [preview=boolean], [recursive=boolean], [refresh=boolean], [registerType=string], [relativeNames=boolean], [repath=string], [replaceAll=boolean], [replaceField=string], [replaceString=[string, string]], [status=boolean], [temporary=boolean], [typeLabel=string], [withAttribute=boolean])

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

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

Maya では、テクスチャまたはその他の Maya シーンなどの外部ファイルを参照して使用することができます。このコマンドは、これらのファイル パスに関する情報を取得し、一括で修正するために使用されます。既定では、最も頻繁に使用されるタイプのファイルのみがユーザに表示されます。

• テクスチャ
• シーン リファレンス
• オーディオ
• イメージ プレーン

コマンドでより多くのファイル タイプを管理する場合、「registerType」フラグを使用して呼び出し元がこれらを明示的に要求する必要があります。このフラグは、コマンドを使用するときにパスを表示する必要があるアトリビュートまたはノードについてコマンドに指示します。

現在、このフラグで指定したアトリビュートには「usedAsFileName」プロパティがある必要があります。サポートされるノードは、「リファレンス」とプラグイン ノードです。例: 「brush.flowerImage」または「reference」は、このフラグの値として使用することができます。

逆に、「deregisterType」フラグを使用すると、特定のアトリビュートまたはノードの処理を停止するようにコマンドに伝えることができます。

外部ファイルを検索するアトリビュートおよびノードのセットを選択すると、コマンドを使用してファイル名が含まれているプラグのリストを取得することができます。各ファイルの名前、フォルダ、およびファイルが存在するかどうかのレポートなどの追加情報を取得することもできます。関連付けられたノードまたはプラグに関する名前、タイプ、ラベルなどの追加情報も取得することができます。

最後に、コマンドを使用すると、パスの編集、ファイルのリマップ、または対象フォルダ内の同名ファイルの存在の確認などのさまざまな操作を実行することができます。詳細については、「repath」、「copyAndRepath」、および「replaceField」フラグを参照してください。

「preview」フラグを使用すると、これらの操作の結果を適用される前にプレビューすることができます。

戻り値

なし

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

キーワード

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
registerType(rt)	string
コマンドで今後処理および認識される新しいファイル タイプを登録します。「temporary」フラグを使用しない限り、登録されたタイプはプリファレンスに保存され、アプリケーションの再起動時に再度表示されます。新しいタイプが既存のタイプまたはラベルと衝突する場合は拒否されます。この 1 つの例外は、タイプが「temporary」フラグを使用して登録された後に「temporary」フラグなしでタイプを登録する場合です。これは、新しいタイプの登録ではなく、既存のタイプの永続的または一時的なプロパティの修正とみなされます。
deregisterType(dt)	string
コマンドでの処理を停止するため、登録されているタイプのリストからファイル タイプを登録解除します。「temporary」フラグを使用しない限り、タイプはプリファレンスから除去され、アプリケーションの再起動時に再表示されなくなります。「temporary」フラグを指定する場合、登録解除は現在のセッションでのみ有効になります。タイプが既に登録解除されている場合、登録解除は拒否されます。ただし、一時的に登録解除された後、タイプの(「temporary」フラグを使用しない)永続的な登録解除は有効になります。
temporary(tmp)	boolean
「register」または「deregister」フラグの効果を現在のセッションにのみ適用するようにします。通常、タイプの登録/登録解除は永続的であり、プリファレンス ファイルによって維持されます。「temporary」フラグを指定する場合、変更はプリファレンス ファイルに保存されません。アプリケーションを再起動すると、前に一時的に登録されていたタイプは表示されず、一時的に登録解除されたタイプは再び表示されます。
listRegisteredTypes(lrt)	boolean
登録されているアトリビュート タイプのリストを照会します。登録されているタイプには、プリファレンス ファイルから自動ロードされたタイプと、「temporary」フラグを使用しているものと使用していないものの両方の、ユーザが明示的に登録したタイプが含まれます。
typeLabel(tl)	string
新しいファイル タイプのラベル名を設定するために、「registerType」とともに使用されます。指定したアトリビュート タイプのタイプ ラベルを返すには、「query」と一緒に使用します。既定のタイプでは、タイプ ラベルはローカライズされた文字列です。その他のタイプでは、タイプ ラベルはユーザによって指定されます。 照会モードでは、このフラグに値が必要になります。
attributeType(at)	string
指定したプラグのアトリビュート タイプを照会します。
status(s)	boolean
「listFiles」と一緒に使用され、これにより、返されるファイルのリストにファイルごとに 1 つのステータス フラグ(解決できない場合は 0、解決できる場合は 1)が含められます。「listDirectories」と一緒に使用され、これにより、返されるフォルダのリストにフォルダごとに 1 つのステータス フラグ(解決できない場合は 0、解決できる場合は 1、解決が部分的な場合は 2)が含められます。ファイル/フォルダ名とともにステータスが交互に配置され、名前が最初に表示されます。「listFiles」の例を参照してください。ファイルごとの情報を取得するもう 1 つの方法については、「withAttribute」フラグを参照してください。エントリごとに複数の項目がリストに表示される場合(例: プラグ名)、ステータスは常に最後になります。
listDirectories(ld)	string
リストは、指定されたフォルダのすべてのサブ フォルダをリストします。タイプが登録されている 1 つ以上のファイルを含むフォルダのみがリストされます(「registerType」を参照)。フォルダが指定されていない場合、シーンに適用可能なすべてのフォルダが返されます。 照会モードでは、このフラグに値が必要になります。
listFiles(lf)	string
指定したフォルダ内のファイルをリストします。サブフォルダの再帰は実行されません。 照会モードでは、このフラグに値が必要になります。
relativeNames(rel)	boolean
「listDirectories」または「listFiles」と一緒に使用され、各フォルダまたはファイルの相対パスを返します。パスは、現在のプロジェクト フォルダからの相対パスです。ファイルまたはフォルダが現在のプロジェクト フォルダの下にない場合、返されるパスはフル パスになります。
withAttribute(wa)	boolean
「listFiles」と一緒に使用され、特定のファイルを使用するプラグの名前を返します。たとえば、「file.jpg」がプラグ「node1.fileTextureName」によって使用されている場合、返される文字列はペアの「file.jpg node1.fileTextureName」になります。ファイルごとの情報を取得するもう 1 つの方法については、「status」フラグを参照してください。
refresh(rf)	boolean
シーンのファイル情報をクリアして再収集します。コマンドでは、シーン内のファイル パスの変更は自動的に追跡されません。このため、最新の情報を取得するための更新はユーザが行う必要があります。
repath(r)	string
ファイル パスのフォルダ部分を指定された場所に置き換えます。ファイル名は保持されます。
preview(p)	boolean
「repath」、「replaceString」、または「copyAndRepath」と一緒に使用し、実行する代わりに操作の結果をプレビューします。「repath」または「replaceString」と一緒に使用する場合、コマンドは新しいファイル パスと、新しいファイルが存在する(1)か存在しない(0)かを示すステータス フラグを返します。パス名とファイル ステータスはペアでリストされます。「copyAndRepath」と一緒に使用する場合、コマンドはコピーする必要があるファイルを返します。
recursive(rc)	boolean
「repath」フラグと一緒に使用し、ターゲット フォルダおよびそのサブフォルダ内のファイルを再帰的に検索します。フラグがオンの場合、コマンドはターゲット フォルダまたはサブフォルダ内で同じ名前を持つファイルにプラグを再パス設定します。フラグがオフの場合、コマンドは結果のファイルが存在することを確認することなくフォルダの変更を適用します。
replaceString(rs)	[string, string]
ファイル パス内でターゲット文字列を新しい文字列に置き換えます。フラグには 2 つの引数が必要です。1 番目の引数はターゲット文字列、2 番目の引数は新しい文字列です。置換を実行する方法をコントロールする場合は、「replaceField」フラグと「replaceAll」フラグを参照してください。
replaceField(rfd)	string
「replaceString」フラグと一緒に使用し、置換の範囲をコントロールします。指定可能な値は次のとおりです。「pathOnly」: フォルダ部分の文字列のみを置換します。「nameOnly」: フォルダを除くファイル名の文字列のみを置換します。「fullPath」: フル ネーム内の文字列を置換します。既定の引数は「fullPath」です。
replaceAll(ra)	boolean
「replaceString」フラグと一緒に使用し、一致する文字列を置換する回数を指定します。フラグが false の場合、一致する最初の文字列のみが置換されます。それ以外の場合、一致するすべての文字列が置換されます。既定値は false です。
copyAndRepath(cr)	[string, string]
ソース ファイルを宛先パスにコピーし、プラグ データを新しいファイルに再パス設定します。ソース ファイルの名前はプラグ内のファイルと同じ名前である必要があります。コマンドは、指定した場所で最初にファイルを検索します。見つからない場合、コマンドはプラグ内の元のファイルを使用しようとします。それでもファイルが見つからない場合は、何も行われません。
force(f)	boolean
「repath」フラグと一緒に使用すると、解決されたファイルを含むすべてのファイルが新しい場所に再パス設定されます。使用しない場合、「repath」は見つからないファイルのみを処理します。「copyAndRepath」フラグと一緒に使用すると、宛先にある衝突するファイルがすべて上書きされます。使用しない場合、「copyAndRepath」は上書きする代わりに宛先にある既存のファイルを使用します。既定値はオフです。

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

Python 例

import maya.cmds as cmds

#Return the directories of the external files in the Maya scene.
#
cmds.filePathEditor(query=True, listDirectories="")
#Return the directories of the external files which are saved at the target
#location.
#
cmds.filePathEditor(query=True, listDirectories="c:/textures/", status=True)
#Return the files present in the specified directory, but not including the
#files in the sub directories.
#
#Use "withAttribute" to return the associated plugs.
#
#Use "status" to return whether the file exists.
#
#For example, if "stone.jpg" exists and it is used by the plug
#"node1.imageName", then the returned result will be an ordered pair:
#"stone.jpg node1.imageName 1".
#
cmds.filePathEditor(query=True, listFiles="c:/textures/", withAttribute=True, status=True)
#Return the label for the specified type.
#
#Strings are only guaranteed to be localized for the default types. For the
#other types, the strings are user-specified.
#
cmds.filePathEditor(query=True, typeLabel="imagePlane")
#Register and save a new file type and type label.
#
#These are persistent and can be used in future sessions.
#
cmds.filePathEditor(registerType="containerBase.iconName", registerLabel="ContainerIcon")
#Deregister a file type and clean the saved information.
#
cmds.filePathEditor(deregisterType="containerBase.iconName")
#Register a new non-persistent file type and type label.
#
cmds.filePathEditor(registerType="containerBase.iconName", registerLabel="ContainerIcon", temporary=True)
#Deregister a file type without affecting the persistent information.
#
cmds.filePathEditor(deregisterType="containerBase.iconName", temporary=True)
#Return all registered types, including default types.
#
cmds.filePathEditor(query=True, listRegisteredTypes=True)
#Query the attribute type for a plug instance.
#
cmds.filePathEditor("node1.fileTextureName", query=True, attributeType=True)
#Refresh all the file path editor's information for the current scene.
#
cmds.filePathEditor(refresh=True)
#Recursively look for files with the same name in the target directory. Repath
#the plugs value to those files.
#
#Use "force" to edit all the given plugs, even if the original path does not
#exist.
#
#Use "recursive" to find files recursively and to make sure the files do exist.
#
cmds.filePathEditor("node1.fileTextureName", "node2.fileTextureName", repath="e:/textures/",
						force=True, recursive=True)
#Preview the result of an operation without doing it.
#
#Returns the file name and whether the new file exists. This is returned as a
#list of pairs.
#
cmds.filePathEditor("node1.fileTextureName", "node2.fileTextureName", repath="e:/textures/", preview=True)
#Replace strings in file paths.
#
#Here, the string "image" in the directory part will be replaced by "texture".
#
cmds.filePathEditor("node1.fileTextureName", "node2.fileTextureName", replaceField="pathOnly", replaceString=("image", "texture"), replaceAll=True)
#Copy a file from the source to the destination and repath the plug data to the new file.
#
#Use "force" to overwrite the file at the destination if it has a name clash.
#
cmds.filePathEditor("node1.fileTextureName", "node2.fileTextureName",  copyAndRepath=("e:/textures", "g:/image"), force=True)