ジャンプ先: 概要. 戻り値. キーワード. フラグ. Python 例.
cacheEvaluator([cacheFillMode=string], [cacheFillOrder=string], [cacheInvalidate=timerange], [cacheName=string], [cachingPoints=boolean], [creationParameters=boolean], [delegateEvaluation=boolean], [dynamicsAsyncRefresh=boolean], [dynamicsSupportActive=boolean], [dynamicsSupportEnabled=boolean], [flushCache=string], [flushCacheRange=[timerange, boolean]], [flushCacheSync=boolean], [flushCacheWait=boolean], [hybridCacheMode=string], [layeredEvaluationActive=boolean], [layeredEvaluationCachingPoints=boolean], [layeredEvaluationEnabled=boolean], [listCacheNames=boolean], [listCachedNodes=boolean], [listValueNames=boolean], [newAction=string], [newActionParam=string], [newFilter=string], [newFilterParam=string], [newRule=string], [newRuleParam=string], [pauseInvalidation=boolean], [preventFrameSkip=boolean], [resetRules=boolean], [resourceUsage=boolean], [resumeInvalidation=boolean], [safeMode=boolean], [safeModeMessages=boolean], [safeModeTriggered=boolean], [valueName=string], [waitForCache=float])
注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。
cacheEvaluator は、取り消し不可能、照会可能、および編集可能です。
このコマンドはキャッシングの設定をコントロールします。これにより、キャッシング システムを操作できるようになります。
キャッシングを設定するには、一連のルールを使用します。ほとんどのルールは、「フィルタ」と「アクション」で構成されています。フィルタは、ルールを適用する必要があるかどうかを判別するために実行されるテストのことです。アクションは、ルールを適用したときに、基準を満たすノードが受ける効果のことです。
したがって、キャッシング モードは、どのノードがキャッシングされているのかを判別する一連のルールを意味します。このモードは、照会モードで「creationParameters」フラグを使用することにより、JSON 文字列にシリアル化できます。
組み込みのキャッシュ設定モード
既定の組み込みキャッシング モードをサポートするために、いくつかのキャッシュ設定ルール、フィルタ、およびアクションが用意されています。
組み込みフィルタ
-
- evaluationCacheNodes
- このフィルタは、評価用キャッシュでサポートされている既定のリストにノード タイプが含まれているすべてのノードと一致します。現在サポートされているタイプのリストについては、以下のコード例を参照してください。
-
- nodeTypes
- このフィルタは、newFilterParam フラグで指定したリスト内にノード タイプが含まれているすべてのノードと一致します。パラメータの文字列は、「-」または「+」のプリフィックスが付いたノード タイプからなる、カンマ区切りのリストです。フィルタはリスト内を順番に移動し、指定したノード タイプ(または派生したノード タイプ)のノードが見つかった場合は、そこで停止します。プリフィックスが「-」の場合、フィルタは一致しなかったノードを返して、処理を停止します。プリフィックスが「+」の場合、フィルタは一致を返して、処理を停止します。
-
- downstreamNodeTypes
- このフィルタは、newFilterParam フラグで指定されたリスト内にノード タイプが含まれているすべてのノードのうち、該当するノード タイプのノードがすぐ下流に存在するものと一致します。パラメータの文字列は、「type=+type1,+type2 downstreamTypes=+type3,+type3」の形式になります。ノード タイプのリストには、nodeTypes フィルタと同じセマンティックが使用されます。
-
- vp2CacheNodes
- このフィルタは、VP2 キャッシングでサポートされているノード タイプのリストにノード タイプが含まれているすべてのノードと一致します。他のノード タイプに対して VP2 キャッシングを有効にしても、効果はありません。現在サポートされているタイプのリストについては、以下のコード例のコメントを参照してください。
-
- vp2FallbackNodes
- このフィルタは、サポートされていない機能であるために、VP2 キャッシングから評価用キャッシングに戻す必要があるすべてのノードと一致します。つまり、VP2 キャッシングが有効であるにもかかわらず、アニメートされた可視性またはアニメートされたトポロジを持つノードと一致します(頂点、エッジ、フェースなどの個数が変わる可能性があります)。 また、スタティック ジオメトリを持つノード、つまりフレームごとに VP2 形式でキャッシュする必要のある要素がないノードとも一致します。
-
- hybridCache
- このフィルタは、どのメッシュを考慮するかを制御するパラメータに基づいて、デフォーマ エバリュエータによって既に取得済みのすべてのノードに一致します。newFilterParam は、「mode」パラメータに対して次の値を指定できます: 「mode=disabled」は、このフィルタを常に false を返す no-op にします。「mode=smp」は、スムーズ メッシュ プレビューを使用する少なくとも 1 つのメッシュを持つデフォーマ エバリュエータ クラスタの一部であるノードに対して true を返します。「mode=all」はデフォーマ エバリュエータ クラスタの一部であるすべてのノードに対して true を返します。「mode=usePreference」はキャッシュされた再生プリファレンスの「ハイブリッド キャッシュ」プリファレンスを使用します。newFilterParam は、次の値を持つ「allowAnimatedInput」パラメータも受け入れます: 「allowAnimatedInput=0」(デフォルト値)は、メッシュが入力ジオメトリの 1 つがアニメートされるクラスタの一部である場合、そのメッシュを考慮しません。このような設定ではハイブリッド キャッシュの利点が失われます。それは、入力ジオメトリを GPU デフォーマにフィードするにはキャッシュする必要がありますが、ジオメトリがアニメートされるため、出力をキャッシュするのとほぼ同じ量のメモリが必要になるからです。「allowAnimatedInput=1」は、このフィルタリングを削除し、入力がアニメートされているかどうかに関係なくメッシュを取得できるようにします。
組み込みアクション
-
- enableEvaluationCache
- このアクションは、一致するノード上で評価用キャッシュを有効にします。評価用キャッシュが既に有効になっている場合は、効果がありません。
-
- disableEvaluationCache
- このアクションは、一致するノード上で評価用キャッシュを無効にします。評価用キャッシュが既に無効になっている場合は、効果がありません。
-
- disableAllCache
- このアクションは、一致したノード上のすべてのキャッシング タイプを無効にします。
-
- enableVP2Cache
- このアクションは、一致するノード上で VP2 キャッシュを有効にします。「useHardware=1」を newActionParam に渡すと、VP2 ハードウェア キャッシュが有効になり、「useHardware=0」を渡すと、VP2 ソフトウェア キャッシュが使用されます。このアクションを実行すると、一致したノード上で評価用キャッシュが無効化(VP2 キャッシュのみが維持)され、メモリを節約できます。「useevaluation=1」と指定すると、VP2 キャッシュとともに評価用キャッシュが有効になります。たとえば、NURBS サーフェスの場合、選択内容を効率的にハイライト表示するために、評価用キャッシュが維持されます。この操作を行うと、必要に応じて安全を確保するために、評価キャッシュ ルールにもフォールバックが自動的に適用されます。ノードが「vp2FallbackNodes」フィルタの基準と一致する場合は、このフォールバックが適用され、「fallbackFromVP2CacheToEvaluationCache」アクション内のアクションが適用されます。「fallback=0」を使用してこのフォールバックを無効にできますが、この操作を行うと、正確性に関する問題が生じ、不安定になって、クラッシュすることもあります。「useevaluation=0」と指定して、フォールバックの動作に影響を与えないようにします。複数のパラメータを使用する場合は、「useHardware=1 fallback=0 useEvaluation=1」のようにスペース(「 」)で区切ります。
-
- disableVP2Cache
- このアクションは、一致するノード上で VP2 キャッシュを無効にします。VP2 キャッシュが既に無効になっている場合は、効果がありません。
-
- fallbackFromVP2CacheToEvaluationCache
- このアクションは、一致したノード上で VP2 キャッシュを無効にして、代わりに評価用キャッシュを有効にします。
-
- delegateEvaluation
- このアクションにより、一致したノードおよび同じクラスタ内のすべてのノードでデリゲート評価が可能になります。つまり、これらのノードはキャッシュされず、フレームごとに評価されます。その結果として、評価をデリゲートするように設定されたノードの下流に、評価をデリゲートするように設定されていないノードは存在しなくなります。また、デリゲート評価ノードへのすべての入力(つまり、直接の親またはアップストリーム)がキャッシュ ポイントとして追加され、評価されるダウンストリーム ノードに対するデータの準備が完了します。
組み込みルール
-
- evaluationCache
- このルールは、evaluationCacheNodes フィルタと enableEvaluationCache アクションを使用した場合と同じ効果があります。
-
- customEvaluators
- このルールを使用すると、キャッシュ エバリュエータよりも優先度の高いカスタム エバリュエータで要求されているノードに、適切な動作を確実に実行できます。まず、優先度が高いカスタム エバリュエータで要求されているノードで、キャッシングが無効になっていることが確認されます。次に、優先度の高いカスタム エバリュエータがデータを要求している場合、このエバリュエータに属しているクラスタの入力ノードに評価用キャッシング ポイントとしてマークされます。これにより、エバリュエータが評価されているときに、プル型の評価が行われなくなります。
既定モード以外のキャッシュ設定ルールを組み合わせた場合、この組み合わせはサポート対象外とみなされ、ユーザ側の責任で使用する必要があることに注意してください。既定のモードは「Evaluation cache」、「VP2 software cache」、および「VP2 hardware cache」です。各モードを有効にするために使用されるルールのセットは、コード例に示されています。
キャッシュ設定の値を照会する
指定したノードまたはノード リストのキャッシュ設定値を取得するには、照会モードで cacheName フラグを使用します。追加パラメータを指定しない場合、この照会は valueName フラグが「active」に設定されている場合と同じです。つまり、指定したキャッシュがアクティブかどうかが照会されます。
照会したノードがキャッシング ポイントでない場合は、そこに関連付けられているキャッシング設定の情報はなく、空の文字列が返されます(基本的に、非アクティブなすべてのキャッシュ モードと同じです)。照会したノードがキャッシング ポイントである場合は、指定したキャッシュ内にある要求された情報が文字列として返されます。たとえば、「active」値を照会した場合の返り値は、「0」または「1」です。
| string | メモリ制限に達したかどうかを示す状態(「resourceUsage」フラグで「out」、「okay」、「low」、または「unlimited」を指定) |
| boolean | セーフ モードを有効にするかどうかを示す状態(「safeMode」フラグを指定) |
| boolean | セーフ モードがトリガされたかどうかを示す状態(「safeModeTriggered」フラグを指定) |
| boolean | フレームのスキップ禁止が有効かどうかを示す状態(「preventFrameSkip」フラグを指定) |
| boolean | バックグラウンドでキャッシュが計算されたかどうかを示す状態(「waitForCache」フラグを指定) |
| string[] | 使用可能なキャッシュ名(「listCacheNames」フラグを指定)。 |
| string | キャッシュ エバリュエータによって現在キャッシュされているノードのリスト(「listCachedNodes」フラグを指定) |
| string[] | 使用可能な値の名前(「listValueNames」フラグを指定) |
| string[] | 要求されたノードのパラメータ値(「cacheName」フラグを指定) |
| string[] | 要求されたノードでデリゲート評価が有効かどうかの状態(「delegateEvaluation」フラグを指定) |
| string | JSON 配列として表された、現在モードの作成パラメータ(「creationParameters」フラグを指定) |
| string[] | キャッシング ポイントとしてマークされたノードのリスト(「cachingPoints」フラグを指定) |
| string[] | レイヤ評価のためにキャッシング ポイントとして強制されるノードのリスト(「layeredEvaluationCachingPoints」フラグを指定) |
| string | 現在のキャッシュ充填モード(「cacheFillMode」フラグを指定) |
| string | 現在のキャッシュ充填順序(「cacheFillOrder」フラグを指定) |
| string | すべてのセーフ モード メッセージのリスト(「safeModeMessages」フラグを指定) |
| string | 現在のハイブリッド キャッシュ モード(「hybridCacheMode」フラグを指定) |
照会モードでは、戻り値のタイプは照会されたフラグに基づきます。
Caching
cacheFillMode, cacheFillOrder, cacheInvalidate, cacheName, cachingPoints, creationParameters, delegateEvaluation, dynamicsAsyncRefresh, dynamicsSupportActive, dynamicsSupportEnabled, flushCache, flushCacheRange, flushCacheSync, flushCacheWait, hybridCacheMode, layeredEvaluationActive, layeredEvaluationCachingPoints, layeredEvaluationEnabled, listCacheNames, listCachedNodes, listValueNames, newAction, newActionParam, newFilter, newFilterParam, newRule, newRuleParam, pauseInvalidation, preventFrameSkip, resetRules, resourceUsage, resumeInvalidation, safeMode, safeModeMessages, safeModeTriggered, valueName, waitForCache
フラグはコマンドの作成モードで表示できます
|
フラグはコマンドの編集モードで表示できます
|
フラグはコマンドの照会モードで表示できます
|
フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。
|
import maya.cmds as cmds
import maya.cmds as cmds
# Enable evaluation cache.
cmds.cacheEvaluator(resetRules=True)
cmds.cacheEvaluator(newFilter="evaluationCacheNodes", newAction="enableEvaluationCache")
cmds.cacheEvaluator(newRule="customEvaluators")
# Enable VP2 software cache.
cmds.cacheEvaluator(resetRules=True)
# VP2 cache only works on a subset of types (mesh, nurbsCurve, nurbsSurface, bezierCurve),
# so we still enable evaluation cache for other types.
cmds.cacheEvaluator(newFilter="evaluationCacheNodes", newAction="enableEvaluationCache")
# Enabling VP2 cache will disable evaluation cache on the supported types.
cmds.cacheEvaluator(newFilter="vp2CacheNodes", newAction="enableVP2Cache", newActionParam="useHardware=0")
# Custom evaluators of a higher priority than the caching evaluator
# may need additional caching points around its boundary to evaluate properly.
cmds.cacheEvaluator(newRule="customEvaluators")
# Enable VP2 hardware cache.
cmds.cacheEvaluator(resetRules=True)
# VP2 cache only works on a subset of types (mesh, nurbsCurve, nurbsSurface, bezierCurve),
# so we still enable evaluation cache for other types.
cmds.cacheEvaluator(newFilter="evaluationCacheNodes", newAction="enableEvaluationCache")
# Enabling VP2 cache will disable evaluation cache on the supported types.
# Note that using the vp2CacheNodes filter is equivalent to using the
# "nodeTypes" filter with the right types specified as the "newFilterParam"
# string, i.e. "types=+mesh,+nurbsCurve,+bezierCurve,+nurbsSurface".
cmds.cacheEvaluator(newFilter="vp2CacheNodes", newAction="enableVP2Cache", newActionParam="useHardware=1")
# Custom evaluators of a higher priority than the caching evaluator
# may need additional caching points around its boundary to evaluate properly.
cmds.cacheEvaluator(newRule="customEvaluators")
# Enable evaluation cache using explicit node types.
cmds.cacheEvaluator(resetRules=True)
cmds.cacheEvaluator(newFilter='nodeTypes', newFilterParam='types=-constraint,+transform,+mesh,+nurbsCurve,+bezierCurve,+nurbsSurface,+subdiv,+lattice,+baseLattice,+cMuscleDebug,+cMuscleDirection,+cMuscleDisplace,+cMuscleDisplay,+cMuscleFalloff,+cMuscleKeepOut,+cMuscleObject,+cMuscleSmartCollide,+cMuscleSpline,+cMuscleSurfAttach,-THlocatorShape,+locator,+light,+camera,+imagePlane,+clusterHandle,+deformFunc,+hwShader,+pfxGeometry,+follicle', newAction='enableEvaluationCache')
cmds.cacheEvaluator(resetRules=True)
cmds.cacheEvaluator(newFilter="evaluationCacheNodes", newAction="enableEvaluationCache")
cmds.cacheEvaluator(query=True, creationParameters=True)
# Result: [
{
"newAction": "enableEvaluationCache",
"newFilter": "evaluationCacheNodes"
}
] #
# Query current cache fill mode.
cmds.cacheEvaluator(query=True, cacheFillMode=True)
# Result: syncAsync #
# Set new cache fill mode. Options are: 'asyncOnly', 'syncOnly', 'syncAsync'.
cmds.cacheEvaluator(cacheFillMode = 'syncAsync')
# Query current cache fill order.
cmds.cacheEvaluator(query=True, cacheFillOrder=True)
# Result: bidirectional #
# Set new cache fill order. Options are: 'forward', 'backward', 'bidirectional', 'forwardFromBegin'.
cmds.cacheEvaluator(cacheFillOrder='forward')
# Enable the Dynamics (Simulation) Support
# Outcome: Scenes with Dynamics nodes will be cached in 'Dynamics Support Mode'
# Caching HUD will indicates the state as 'On (Dynamics Mode)'
cmds.cacheEvaluator(dynamicsSupportEnabled=True)
# Query if Dynamics Support Mode is active (Dynamics nodes present in the scene)
cmds.cacheEvaluator(query=True, dynamicsSupportEnabled=True)
# Disable the Dynamics Support
# Outcome: Safe mode being triggered and cached playback is disabled when Dynamics nodes present.
cmds.cacheEvaluator(dynamicsSupportEnabled=False)
# Query or set the Dynamics-Async-Refresh option
cmds.cacheEvaluator(q=True,dynamicsAsyncRefresh=False)
cmds.cacheEvaluator(dynamicsAsyncRefresh=True)
# Query current hybrid cache mode.
cmds.cacheEvaluator(query=True, hybridCacheMode=True)
# Result: disabled #
# Set new hybrid cache mode. Options are: 'disabled', 'smp', 'all'.
cmds.cacheEvaluator(hybridCacheMode = 'smp')
# Invalidate cache for all the frames in range from 10 to 20, inclusive, in current time unit.
cmds.cacheEvaluator(cacheInvalidate=('10','20'))
cmds.cacheEvaluator(cacheInvalidate=('10:20',))
# Invalidate cache for all the frames in range from 10 onwards to the maximum time in the animation range, in current time unit.
cmds.cacheEvaluator(cacheInvalidate=('10:',))
# Invalidate cache for all the frames in range from minimum time on the animation range up to (and including) to 10, in current time unit.
cmds.cacheEvaluator(cacheInvalidate=(':10',))
# Invalidate cache from minimum to maximum time on the current animation range.
cmds.cacheEvaluator(cacheInvalidate=(':',))
# Check whether or not evaluation cache is active on a given node.
cmds.cacheEvaluator("myNode", query=True, cacheName="evaluation")
# Result: [u'1'] #
cmds.cacheEvaluator("myNode", query=True, cacheName="evaluation", valueName="active")
# Result: [u'1'] #
# Check whether or not VP2 cache is active, and using hardware cache.
cmds.cacheEvaluator("myNode", query=True, cacheName="VP2")
# Result: [u'1'] #
cmds.cacheEvaluator("myNode", query=True, cacheName="VP2", valueName="active")
# Result: [u'1'] #
cmds.cacheEvaluator("myNode", query=True, cacheName="VP2", valueName="useHardware")
# Result: [u'1'] #
# Check whether or not delegate evaluation is active on a given node.
cmds.cacheEvaluator("myNode", query=True, delegateEvaluation=True)
# Result: [u'0'] #
cmds.cacheEvaluator(query=True, cachingPoints=True)
# Result: [u'nurbsCone1', u'nurbsConeShape1'] #
# Flush current cache. "keep" and "destroy" flags can be used to store or destroy the existing cache.
cmds.cacheEvaluator(flushCache='destroy')
# Result: destroy #
# Query the cache evaluator's flush synchronization mode.
cmds.cacheEvaluator(query=True, flushCacheSync=True)
# Result: 0 #
# Set the cache evaluator's flush synchronization mode. Valid values are: True for synchronous, False for asynchronous.
cmds.cacheEvaluator(flushCacheSync=True)
# Wait for cache destruction.
cmds.cacheEvaluator(flushCacheWait=True)
# Check the available types of cache.
cmds.cacheEvaluator(query=True, listCacheNames=True)
# Result: [u'evaluation', u'VP2'] #
# Query the list of cached nodes.
cmds.cacheEvaluator(query=True, listCachedNodes=True)
# Result: nurbsSphere1,nurbsSphereShape1 #
# Check the available values that can be queried for available caches.
cmds.cacheEvaluator(query=True, cacheName="evaluation", listValueNames=True)
# Result: [u'active'] #
cmds.cacheEvaluator(query=True, cacheName="VP2", listValueNames=True)
# Result: [u'active', u'useHardware'] #
# Query if prevent-frame-skipping is on.
cmds.cacheEvaluator(query=True, preventFrameSkip=True)
# Result: 1 #
# Set prevent-frame-skipping to on.
cmds.cacheEvaluator(preventFrameSkip=True)
# Query if the cache invalidation is paused. Returns how many times invalidation is paused.
cmds.cacheEvaluator(query=True, pauseInvalidation=True)
# Result: 0 #
# Pause cache invalidation.
cmds.cacheEvaluator(pauseInvalidation=True)
# Resume cache invalidation.
cmds.cacheEvaluator(resumeInvalidation=True)
# Query whether or not the resource limit has been reached.
cmds.cacheEvaluator(query=True, resourceUsage=True)
# Result: okay #
# Turn safe mode state for evaluator on.
cmds.cacheEvaluator(safeMode=True)
# Query the safe mode state for evaluator.
cmds.cacheEvaluator(query=True, safeMode=True)
# Result: 1 #
# If safe mode was triggered return the safe mode messages
cmds.cacheEvaluator(query=True, safeModeMessages=True)
# Result: #
# Check if safe mode was triggered
cmds.cacheEvaluator(query=True, safeModeTriggered=True)
# Result: 0 #
# Wait for 10 seconds for cache to fill in background
cmds.cacheEvaluator(waitForCache=10)
# Result: True #
# Save the current caching mode.
cacheModeString = cmds.cacheEvaluator(query=True, creationParameters=True)
useEval = True
if useEval:
# The return string can be evaluated as regular Python code to get an array
# of dictionaries describing the rule.
cacheMode = eval(cacheModeString)
else:
# json.loads can also be used to parse that string. However, it creates
# unicode strings as keys which cannot be used as argument names when
# unpacking the dictionary.
import json
jsonCacheMode = json.loads(cacheModeString)
cacheMode = []
for rule in jsonCacheMode:
newRule = { key.encode('ascii'): value for key, value in rule.iteritems() }
cacheMode.append(newRule)
# Restore previous cache mode.
cmds.cacheEvaluator(resetRules=True)
for rule in cacheMode:
cmds.cacheEvaluator(**rule)
# Use the CacheEvaluatorManager to get/set modes.
from maya.plugin.evaluator.CacheEvaluatorManager import CacheEvaluatorManager
manager = CacheEvaluatorManager()
currentMode = manager.cache_mode
from maya.plugin.evaluator.CacheEvaluatorManager import CACHE_STANDARD_MODE_VP2_HW, CACHE_STANDARD_MODE_VP2_SW, CACHE_STANDARD_MODE_EVAL
# Enable evaluation cache.
manager.cache_mode = CACHE_STANDARD_MODE_EVAL
# Enable VP2 software cache.
manager.cache_mode = CACHE_STANDARD_MODE_VP2_SW
# Enable VP2 hardware cache.
manager.cache_mode = CACHE_STANDARD_MODE_VP2_HW
# Restore the previous mode.
manager.cache_mode = currentMode