移動先: 概要 戻り値 関連項目 フラグ Python の例
file(
string
, [anyModified=boolean], [buildLoadSettings=boolean], [channels=boolean], [cleanReference=string], [command=string], [constraints=boolean], [constructionHistory=boolean], [copyNumberList=boolean], [defaultExtensions=boolean], [defaultNamespace=boolean], [deferReference=boolean], [editCommand=string], [errorStatus=boolean], [executeScriptNodes=boolean], [exists=boolean], [expandName=boolean], [exportAll=boolean], [exportAnim=boolean], [exportAnimFromReference=boolean], [exportAsReference=boolean], [exportSelected=boolean], [exportSelectedAnim=boolean], [exportSelectedAnimFromReference=boolean], [expressions=boolean], [flushReference=string], [force=boolean], [groupLocator=boolean], [groupName=string], [groupReference=boolean], [i=boolean], [ignoreVersion=boolean], [importReference=boolean], [lastFileOption=boolean], [lastTempFile=boolean], [list=boolean], [loadAllDeferred=boolean], [loadAllReferences=boolean], [loadNoReferences=boolean], [loadReference=string], [loadReferenceDepth=string], [loadSettings=string], [location=boolean], [lockContainerUnpublished=boolean], [lockFile=boolean], [lockReference=boolean], [modified=boolean], [namespace=string], [newFile=boolean], [open=boolean], [options=string], [parentNamespace=boolean], [postSaveScript=string], [preSaveScript=string], [preserveReferences=boolean], [prompt=boolean], [reference=boolean], [referenceDepthInfo=uint], [referenceNode=string], [removeReference=boolean], [rename=string], [renameAll=boolean], [renameToSave=boolean], [renamingPrefix=string], [renamingPrefixList=boolean], [returnNewNodes=boolean], [save=boolean], [saveDiskCache=string], [saveReference=boolean], [saveTextures=string], [sceneName=boolean], [selectAll=boolean], [shader=boolean], [sharedNodes=string], [sharedReferenceFile=boolean], [shortName=boolean], [strict=boolean], [swapNamespace=[string, string]], [type=string], [uiConfiguration=boolean], [unloadReference=string], [unresolvedName=boolean], [usingNamespaces=boolean], [withoutCopyNumber=boolean], [writable=boolean])
注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。
file は「元に戻す」が可能、「照会」が可能、「編集」が可能です。
ファイルのオープン、インポート、エクスポート、参照、保存、名前の変更を行う
このコマンドには、実行するアクションを指定するメイン フラグが 1 つ必要です。
一部のメイン フラグには、そのアクションを修正するオプションの 2 次フラグが続くものもあります。
メインフラグを以下に示します。
| cr | ea |
ean | ear | eas |
er | esa | es |
| esn | ex |
fr | i | ir |
l | lr |
| loc | ltf |
mf | new | o |
op | ot | pmt |
| r | rdi |
rn | rr | rts |
s | sa | sdx |
| st | stx |
typ | uc | ur |
w |
-o/-open は、次の 2 次フラグで修飾できます。
| f | lad |
lad | lnr | rnn |
-es/-exportSelected は、次の 2 次フラグで修飾できます。
| ch | chn |
con | exp | sh |
-r/-reference は、次の 2 次フラグで修飾できます。
| dns | dr |
gr | gl | gn |
ns | rfn | rpr |
sns | srf | shd |
rnn |
-i/-import は、次の 2 次フラグで修飾できます。
| dns | dr |
gr | gn | pr |
ra | rdn | rnn |
rpr | sns |
-n/-new と -s/-save は、次の 2 次フラグで修飾できます。
| f |
-er/exportAsReference は、次の 2 次フラグで修飾できます。
| ns | rpr |
-ea/-exportAll と -es/-exportSelected は、次の 2 次フラグで修飾できます。
| f | pr |
-ean/-exportAnim, -eas/-exportSelectedAnim は、次の 2 次フラグで修飾できます。
| f |
ear/-exportAnimFromReference、-esa/-exportSelectedAnimFromReference は、次の 2 次フラグで修飾できます。
| f | rfn |
ファイルに関する情報を照会する
このコマンドは、照会する照会を指定する主要な照会フラグ 1 つと、その照会を修正するオプションの 2 次フラグを必要とします。
主要な照会フラグを以下に示します。
| amf | ch |
chn | con | dr |
err | ex | exn |
| exp | l |
loc | ltf | mf |
ns | op | ot |
| pmt | pns |
r | rfn | rpl |
rpr | rts | sdc |
| sh | sn |
stx | typ | uc |
w |
-dr/-deferReference は、次の 2 次フラグで修飾できます。
| rfn |
-exn/-expandName、-l/-list、-r/reference、-sn/sceneName は、次の 2 次フラグで修飾できます。
| un | shn |
wcn |
ファイル名を照会する
ファイル名を照会する際、結果をフォーマットする方法がいくつかあります。
解決された名前と未解決の名前:
ファイルを開いたり参照したりして Maya にロードするときに、ファイル パスが完全ではない場合があります。たとえば、相対パス（「scenes/myScene.ma」など）であったり、環境変数（「$PRODUCTION_DIR/myScene.ma」など）を含んでいたり、単にローカル ディスク上に存在しないパスである場合などがあります。このような場合はそれぞれ、Maya ではいくつかの手順を経てパスを解決し、ディスク上でファイルを探します。
デフォルトで「file」コマンドは、解決されたファイル名（Maya が実際にファイルを読み込んでいる場所など）を返しますが、-un/-unresolved フラグを使用した場合は、未解決のファイル（元々指定されていたファイルなど）を返します。
フル ネームとショート ネーム:
デフォルトで「file」コマンドはファイルへのフル パスを返しますが、-shn/-shortName フラグを使用した場合は、ファイル名だけが返されます。
コピー番号付きとコピー番号なし:
同じファイルを 2 回以上ロードする（同じファイルを 2 回参照するなど）ときに、Maya はファイル名の最後にコピー番号をアペンドしてコピー ファイルを区別します。初めてファイルを読み込んだきには、コピー番号はアペンドされません。ファイルを 2 回目に読み込んだきに「{1}」がアペンドされ、3 回目は「{2}」というふうに続きます。デフォルトで「file」コマンドは、コピー番号をアペンドしたファイル名を返しますが、-wcn/-withoutCopyNumber フラグを使用した場合は、コピー番号なしでファイル名を返します。
追加の詳細事項:
- 通常は file コマンドでファイル名を引数として指定しますが、ファイル名が指定されていない場合は、ルートのシーンが使用されます。
- 詳細と制限事項については、各フラグの説明を参照してください。
| string | 大部分のアクションでは、指定したファイルの名前です。 |
戻り値の型は照会モードでは照会フラグが基になります。
filetest, getFileList, namespace, namespaceInfo, referenceEdit, referenceQuery, workspace
anyModified, buildLoadSettings, channels, cleanReference, command, constraints, constructionHistory, copyNumberList, defaultExtensions, defaultNamespace, deferReference, editCommand, errorStatus, executeScriptNodes, exists, expandName, exportAll, exportAnim, exportAnimFromReference, exportAsReference, exportSelected, exportSelectedAnim, exportSelectedAnimFromReference, expressions, flushReference, force, groupLocator, groupName, groupReference, i, ignoreVersion, importReference, lastFileOption, lastTempFile, list, loadAllDeferred, loadAllReferences, loadNoReferences, loadReference, loadReferenceDepth, loadSettings, location, lockContainerUnpublished, lockFile, lockReference, modified, namespace, newFile, open, options, parentNamespace, postSaveScript, preSaveScript, preserveReferences, prompt, reference, referenceDepthInfo, referenceNode, removeReference, rename, renameAll, renameToSave, renamingPrefix, renamingPrefixList, returnNewNodes, save, saveDiskCache, saveReference, saveTextures, sceneName, selectAll, shader, sharedNodes, sharedReferenceFile, shortName, strict, swapNamespace, type, uiConfiguration, unloadReference, unresolvedName, usingNamespaces, withoutCopyNumber, writable
: コマンドの作成モードで使用可能なフラグ
|
: コマンドの編集モードで使用可能なフラグ
|
: コマンドの照会モードで使用可能なフラグ
|
: タプルまたはリストとして渡された複数の引数を持てるフラグ
|
import maya.cmds as cmds
# save the current scene to an ascii file named "fred.ma"
#
cmds.file( rename='fred.ma' )
cmds.file( save=True, type='mayaAscii' )
# save the current scene to an ascii file without the ".ma" extension
#
cmds.file( rename='tmp' )
cmds.file( save=True, de=False, type='mayaAscii' )
# open the file fred.ma, using the default load settings. Any references will
# be brought in in the same state they were in when fred.ma was last saved.
#
cmds.file( 'fred.ma', o=True )
# reference the file wilma.ma
#
cmds.file( 'C:/mystuff/wilma.mb', r=True )
# reference the file barney.mb into a namespace called "rubble".
#
cmds.file( 'C:/maya/projects/default/scenes/barney.ma', r=True, type='mayaAscii', namespace='rubble' )
# change the namespace containing barney.mb.
#
cmds.file( 'C:/maya/projects/default/scenes/barney.ma', e=True, namespace='purpleDinosaur' )
# retrieve a string array of all files referenced in the scene
#
cmds.file( q=True, l=True )
# Result: C:/maya/projects/default/scenes/fred.ma C:/mystuff/wilma.mb C:/maya/projects/default/scenes/barney.ma
# Select "betty" and export betty to a separate file called "betty.mb".
# Reference the new betty file into this scene, replacing the
# previous betty object from this scene with the reference to betty.
#
cmds.file( 'c:/mystuff/betty.mb', type='mayaBinary', namespace='rubble', er=True )
# Select all the objects associated with file betty.mb
#
cmds.file( 'c:/mystuff/betty.mb', sa=True )
# Result: rubble:betty
# Remove the reference file betty.mb. All nodes in betty.mb will
# be removed from the scene
cmds.file( 'c:/mystuff/betty.mb', rr=True )
# Query whether the file named "foo.mb" exists on disk
#
cmds.file( 'foo.mb', q=True, ex=True )
# Result: 0 #
# Query whether the reference node "rubble:betty is deferred loaded.
# Note, -rfn flag has to come before -q flag.
cmds.file(rfn='rubbleRN', q=True, dr=True )
# Query the last temp file during file save
#
cmds.file( query=True, lastTempFile=True)
####################################/
#/ Example for the '-buildLoadSettings' and '-loadSettings' flags #/
####################################/
# Build load settings for "ref.ma"
cmds.file( 'ref.ma', o=True, buildLoadSettings=True )
# Edit those settings, to indicate that some reference should
# be brought in unloaded.
# Note: the following command is primarily intended for internal
# use. It may not be easy to determine the numeric ID of a given
# reference ("2" in this case) .
# cmds.loadSettings( '2', deferReference=1 )
# Use the edited settings when opening the file
cmds.file('ref.ma', o=True, loadSettings='implicitLoadSettings')
#
# Example for the '-cleanReference' and '-editCommand' flags
#
# Create a simple reference to a sphere
#
cmds.file( f=True, new=True )
cmds.polySphere()
cmds.file( rename='ref.ma' )
cmds.file( f=True, type='mayaAscii', save=True )
cmds.file( f=True, new=True )
cmds.file( 'ref.ma', r=True, ns='ref' )
# Scale the sphere
#
cmds.setAttr( 'ref:pSphere1.s', 5, 5, 5 )
cmds.getAttr( 'ref:pSphere1.s' )
# Result: 5 5 5 #
# The 'cleanReference' and 'editCommand' flags only work on
# unloaded references.
#
cmds.file( unloadReference='refRN' )
# Query the setAttr edits:
#
cmds.reference( rfn='refRN', q=True, editCommand=True )
# Result: setAttr ref:pSphere1.s -type "double3" 5 5 5 setAttr ref:lightLinker1.lnk -s 2 #
# Remove all setAttr edits on refRN:
#
cmds.file( cleanReference='refRN', editCommand='setAttr' )
cmds.reference( rfn='refRN', q=True, editCommand=True )
# Note that nothing is returned
cmds.file( loadReference='refRN' )
cmds.getAttr( 'ref:pSphere1.s' )
# Result: 1 1 1 #
# Note that scale has returned to 1 1 1