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

概要

cacheFile([appendFrame=boolean], [attachFile=boolean], [cacheFileNode=string], [cacheFormat=string], [cacheInfo=string], [cacheableAttrs=string], [cacheableNode=string], [channelIndex=boolean], [channelName=string], [convertPc2=boolean], [createCacheNode=boolean], [creationChannelName=string], [dataSize=boolean], [deleteCachedFrame=boolean], [descriptionFileName=boolean], [directory=string], [doubleToFloat=boolean], [endTime=time], [fileName=string], [format=string], [geometry=boolean], [inAttr=string], [inTangent=string], [interpEndTime=time], [interpStartTime=time], [noBackup=boolean], [outAttr=string], [outTangent=string], [pc2File=string], [pointCount=boolean], [points=string], [pointsAndNormals=string], [prefix=boolean], [refresh=boolean], [replaceCachedFrame=boolean], [replaceWithoutSimulating=boolean], [runupFrames=int], [sampleMultiplier=int], [simulationRate=time], [singleCache=boolean], [startTime=time], [staticCache=boolean], [worldSpace=boolean])

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

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

ディスク上に 1 つまたは複数のキャッシュ ファイルを作成し、フレームのスパン用のアトリビュート データを格納します。キャッシュは、ジオメトリ上のポイント/法線(pts/points または pan/pointsAndNormals フラグを使用)、vectorArray 出力データ(oa/outAttr フラグを使用)、または追加のノード固有のデータ(データをサポートするこれらのノードに cnd/cacheableNode フラグを使用)に対して作成できます。

ia/inAttr フラグを使用すると、ディスク上のデータ ファイルをアトリビュートと関連付ける cacheFile ノードを接続します。

rcf/replaceCachedFrame フラグおよび apf/appendFrame フラグを使用すると、フレームを既存のキャッシュに置き換え/アペンドができます。置き換えられたフレームは絶対に削除されません。これは、f/fileName フラグで指定した名前でオリジナルのキャッシュ ファイルと同じディレクトリに格納されます。ファイル名を指定しないと、cacheFile 名の前に「backup」をつけて後ろに固有の番号を追加した名前になります。

単一のファイル キャッシュは丸ごとバックアップされます。前のバージョンに戻すには、このキャッシュにアタッチするだけです。フレームごとに 1 ファイル キャッシュは、記述ファイルおよび置き換えられたフレームのみをバックアップします。このタイプのキャッシュをリカバリするには、ファイル名をオリジナルの名前に変更する必要があります。

戻り値

string作成されたキャッシュの記述ファイルの名前

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

キーワード

cache, file, disk

フラグ

appendFrame, attachFile, cacheFileNode, cacheFormat, cacheInfo, cacheableAttrs, cacheableNode, channelIndex, channelName, convertPc2, createCacheNode, creationChannelName, dataSize, deleteCachedFrame, descriptionFileName, directory, doubleToFloat, endTime, fileName, format, geometry, inAttr, inTangent, interpEndTime, interpStartTime, noBackup, outAttr, outTangent, pc2File, pointCount, points, pointsAndNormals, prefix, refresh, replaceCachedFrame, replaceWithoutSimulating, runupFrames, sampleMultiplier, simulationRate, singleCache, startTime, staticCache, worldSpace
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
appendFrame(apf) boolean create
startTime フラグと endTime フラグで指定した時間の間、データをキャッシュにアペンドします。時間が指定されていない場合は、現在のタイムにアペンドします。pts/points フラグか cnd/cacheableNode フラグと一緒に使用する必要があります。上書きされたフレームは削除されませんが、f/fileName フラグで指定した名前に変更されます。
attachFile(af) boolean create
キャッシュ ファイルを作成するのではなく、ディスク上の既存のキャッシュ ファイルをシーン内のアトリビュートにアタッチすることを示すために使用します。アトリビュートを指定するには inAttr フラグを使用します。
cacheFileNode(cfn) string createmultiuse
指定したジオメトリに複数のキャッシュがアタッチされている場合に、アペンドする/置き換えるキャッシュ ファイル ノード名を指定します。

照会モードでは、このフラグに値が必要になります。

cacheFormat(cf) string createquery
キャッシュ ファイル フォーマットです。既定は Maya の .mcx フォーマットですが、その他のフォーマットもプラグイン経由で使用できます。
cacheInfo(ci) string createquerymultiuse
作成モードでは、文字配列を返す MEL スクリプトを指定するために使用します。キャッシュの作成時には、この MEL スクリプトを実行して返された文字列をキャッシュの .xml 記述ファイルに書き込みます。照会モードでは、ユーザ名、Maya シーン名、Maya バージョン番号など、cacheFile に保管された記述情報を返します。
cacheableAttrs(cat) string query
付随のキャッシュ ノードで定義されたキャッシュ可能なアトリビュートのリストを返します。この引数は cacheableNode フラグが必要です。
cacheableNode(cnd) string createmultiuse
内容をキャッシュするキャッシュ可能なノードの名前を指定します。キャッシュ可能なノードとは、キャッシング メカニズムで動作するように特別にデザインされたノードです。キャッシュ可能なノードの例として、nCloth ノードがあります。

照会モードでは、このフラグに値が必要になります。

channelIndex(chi) boolean createquery
cacheFileNode フラグを使用して指定した cacheFile ノードに対して、選択したジオメトリのチャネル インデックスを返す照会専用フラグです。
channelName(cnm) string createquerymultiuse
attachFile を使用する場合に、inAttr にアタッチされるファイル内のチャネルを示すために使用します。指定しないと、ファイル内の最初のチャネルが使用されます。照会モードでは、記述ファイルに関連付けられたチャネルを照会できます。
convertPc2(pc2) boolean create
PC2 ファイルを Maya のキャッシュ フォーマットに変換する(true)か、Maya のキャッシュを pc2 フォーマットに変換(false)します。
createCacheNode(ccn) boolean create
キャッシュ ファイルを作成するのではなく、cacheFile ノードをディスク上の既存のキャッシュ ファイルに関連付けて作成することを示すために使用します。
creationChannelName(cch) string createmultiuse
新しいキャッシュの作成時には、この多目的フラグでキャッシュするチャネルを指定します。名前は、キャッシュされるオブジェクトで定義されたキャッシュ可能なチャネル名から付けられます。キャッシュの作成時にこのフラグを使用しないと、キャッシュ可能なすべてのチャネルがキャッシュされます。
dataSize(dsz) boolean query
これはフレーム単位でキャッシュされるデータのサイズを返す照会専用フラグです。このフラグは cacheableNode、points、pointsAndNormal、および outAttr フラグと一緒に使用します。
deleteCachedFrame(dcf) boolean create
startTime/endTime フラグで指定した時間のキャッシュ データを削除します。時間が指定されていない場合は、現在のフレームを削除します。pts/points フラグか cnd/cacheableNode フラグと一緒に使用する必要があります。削除されたフレームはディスクからは除去されませんが、f/fileName フラグで指定した名前に変更されます。
descriptionFileName(dfn) boolean query
これは、既存の cacheFile ノードの記述ファイル名を返す照会専用フラグです。cacheFile ノードを指定しないと、指定したその他のフラグに基づいて作成された記述ファイル名を返します。
directory(dir) string createquery
キャッシュ ファイルを配置するディレクトリを指定します。ディレクトリ フラグを指定しないと、キャシュ ファイルはプロジェクト データ ディレクトリに配置されます。
doubleToFloat(dtf) boolean create
キャッシュ作成時には、double データを float としてファイルに格納します。これにより、ファイル サイズが軽減します。
endTime(et) time create
キャッシュ範囲の終了フレームを指定します。
fileName(f) string createquery
キャッシュ ファイルのベース ファイル名を指定します。複数のオブジェクトがキャッシュされていて、フォーマットが OneFilePerFrame の場合は、各キャッシュ ファイルはこのベース ファイル名にプリフィックスを付加した名前になります。照会モードでは、指定した cacheFile ノードに接続されたファイルを返します。rpf/replaceCachedFrame または apf/appendFrame と一緒に使用する場合は、バックアップ ファイル名を指定します。指定しないと、置き換えられたフレームは既定の名前で格納されます。

照会モードでは、このフラグは値を受け入れることができます。

format(fm) string create
キャッシュの分配フォーマットを指定します。有効な値は「OneFile」と「OneFilePerFrame」です。
geometry(gm) boolean query
指定したキャッシュ ノードでコントロールされるジオメトリを返す照会フラグです。
inAttr(ia) string createmultiuse
キャッシュ ファイルが制御するアトリビュートの名前を指定します。キャッシュ ファイルの作成時にはこのフラグはオプションです。作成モード時にこのフラグを指定しないと、ディスク上にキャッシュ ファイルが作成されても、シーン内の何も制御されません。attachFile フラグを使用する場合は、このフラグが必要です。
inTangent(it) string create
置き換えたフレームの前にフレームを補間する場合のイン接線のタイプを指定します。ist/interpStartTime フラグと iet/interpEndTime フラグを一緒に使用する必要があります。有効な値は「linear」、「smooth」、「step」です。
interpEndTime(iet) time create
endTime で開始したリニア補間を終了するフレームを指定します。rpf/replaceCachedFrame フラグか apf/appendFrame フラグと一緒に使用する必要があります。補間は、endTime と interpEndTime との間のフレームをキャッシュから除去することで達成されます。除去されたフレームは、f/fileName フラグで指定した名前に変更されます。
interpStartTime(ist) time create
リニア補間を開始して startTime で終了するフレームを指定します。rpf/replaceCachedFrame フラグか apf/appendFrame フラグと一緒に使用する必要があります。補間は、interpStartTime と startTime の間のフレームをキャッシュから除去することで達成します。この除去されたフレームは、f/fileName フラグで指定した名前に変更されます。
noBackup(nb) boolean create
キャッシュ フレームのアペンド、置き換え、削除時に上書きされるファイルに対して、バックアップ ファイルを作成しないように指定します。apf/appendFrame、rpf/replaceCachedFrame、または dcf/deleteCachedFrame フラグと一緒の場合にのみ使用できます。
outAttr(oa) string createmultiuse
ディスクにキャッシュされるアトリビュートの名前を指定します。

照会モードでは、このフラグに値が必要になります。

outTangent(ot) string create
置き換えたフレームの後にフレームを補間する場合のアウト接線のタイプを指定します。ist/interpStartTime フラグと iet/interpEndTime フラグを一緒に使用する必要があります。有効な値は「linear」、「smooth」、「step」です。
pc2File(pcf) string create
pc2 ファイルへのフル パスを指定します。pc2 フラグと一緒に使用する必要があります。
pointCount(pc) boolean query
キャッシュ ファイルに保管されたポイントの数を返す照会フラグです。照会するチャネルを指定するには、channelName フラグを使用します。
points(pts) string createmultiuse
ポイントをキャッシュするジオメトリ名を指定します。

照会モードでは、このフラグに値が必要になります。

pointsAndNormals(pan) string createmultiuse
ポイントおよび法線をキャッシュするジオメトリ名を指定します。法線は頂点単位、ポリゴン単位です。法線のキャッシュをジオメトリに読み込み直すことはできません。このフラグは、キャッシュ ファイルを書き出すためにのみ使用できます。apf/appendFrame、dcf/deleteCachedFrame、および rpf/replaceCachedFrame フラグとともに使用することはできません。

照会モードでは、このフラグに値が必要になります。

prefix(p) boolean create
指定した fileName を cacheName のプリフィックスとして使用することを示します。
refresh(r) boolean create
キャッシュの作成時に使用すると、キャッシング中に強制的にスクリーンをリフレッシュします。これによりキャッシュの作成速度は落ちますが、キャッシュ中にシミュレーションの進行状況を確認できます。
replaceCachedFrame(rcf) boolean create
startTime/endTime フラグで指定された時間のキャッシュ データを置き換えます。時間が指定されていない場合は、現在のタイムのキャッシュ ファイルを置き換えます。pts/points フラグか cnd/cacheableNode フラグと一緒に使用する必要があります。置き換えられたフレームは削除されませんが、f/fileName フラグで指定した名前に変更されます。
replaceWithoutSimulating(rws) boolean edit
キャッシュ フレームを置き換えるときに、シミュレーションなしでキャッシュ ノードから置き換えるか、または進行中の時間から置き換えてシミュレーションを実行させるかを指定します。このフラグは、startTime フラグと endTime フラグのどちらも使用していない場合、または startTime フラグと endTime フラグが同じ時間値を指定している場合にのみ有効です。
runupFrames(rf) int createqueryedit
開始フレームの前にシミュレートする準備フレームの数を指定します。値は 0 以上である必要があります。既定は 2 です。
sampleMultiplier(spm) int createqueryedit
キャッシュを複数のシミュレーション レートとして作成する場合のサンプリング レートを指定します。値が 1 の場合は、時間が進むごとにサンプルをキャッシュします。値が 2 の場合は 1 つおきにサンプルをキャッシュ、以下同様に続きます。既定は 1 です。
simulationRate(smr) time createqueryedit
キャッシュを作成しているときのシミュレーション レートを指定します。キャッシュの作成時には、キャッシュの終了時間に到達するか超過するまで、シミュレーション レートに従って時間を進めます。値はフレームで指定します。既定値は 1 フレームです。
singleCache(sch) boolean create
points、pointsAndNormal、または cacheableNode フラグと一緒に使用する場合に、複数のジオメトリを単一のキャッシュに入れるか、またはジオメトリごとに 1 つのキャッシュを作成するか(既定)のどちらかを指定します。
startTime(st) time create
キャッシュ範囲の開始フレームを指定します。
staticCache(sc) boolean createquery
false の場合、アニメーションや変形がないように見える場合は、キャッシュ作成時にオブジェクトのキャッシュを保存しません。true の場合、オブジェクトにアニメーションや変形がないように見える場合でも、キャッシュを保存します。既定は true です。照会モードでは、シェイプを指定すると、そのシェイプにアニメーションや変形がないように見える場合は true を返します。
worldSpace(ws) boolean create
points フラグを使用している場合にこのフラグをオンにすると、ポイントを書き込む場所がワールド空間になります。このフラグは、キャッシュ 書き出しなどに使用されます。

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

Python 例

import maya.cmds as cmds

# Create a disk cache containing the points of a plane from
# frames 1 - 100. Typically the shape would be deforming.
#
cmds.polyPlane()
cacheFiles = cmds.cacheFile(f='shapeCache', st=1, et=100, points='pPlaneShape1')

# Add a historySwitch node to the history of the shape, and attach the
# newly created cache into the historySwitch node.
#
switch = maya.mel.eval('createHistorySwitch("pPlaneShape1",false)')
cacheNode = cmds.cacheFile(f=cacheFiles[0], cnm='pPlaneShape1', ia='%s.inp[0]' % switch ,attachFile=True)
cmds.setAttr( '%s.playFromCache' % switch, 1 )

# query the files associated with a cacheFile node
#
cmds.cacheFile( cacheNode, query=True, f=True )

# Now use the staticCache flag to indicate that the cache should not be
# created if the object appears to have no animation.
# Since the plane is not animated or deformed, no cache will be created.
#
cmds.polyPlane()
cacheFiles = cmds.cacheFile(f='shapeCache', staticCache=0, st=1, et=100, points='pPlaneShape2')

# Convert a maya cache into pc2 format. The maya cache is named
# pSphereShape1.xml and located in the directory "c:/test/".
#
cmds.cacheFile(pc2=0,pcf='c:/test/mypc2.pc2',f='pSphereShape1',dir='c:/test/')

# Convert a pc2 cache into a maya cache, with the cache data in a single
# file.
#
cmds.cacheFile(pc2=1,pcf='c:/test/mypc2.pc2',f='mayaCache2',dir='c:/test/',format='OneFile')