diskCache

Go to: Synopsis. Flags. Return value. Keywords. MEL examples.

Synopsis

diskCache [-append] [-cacheType string] [-close string] [-closeAll] [-delete string] [-deleteAll] [-empty string] [-emptyAll] [-enabledCachesOnly] [-endTime time] [-frameRangeType string] [-overSample] [-samplingRate int] [-startTime time] [-tempDir]

diskCache is NOT undoable, queryable, and NOT editable.

Flags

Long name (short name)	[argument types]	Properties
-frameRangeType(-frt)	string
Specifies the type of frame range to use, namely "Render Globals", "Time Slider", and "Start/End". In the case of "Time Slider", startFrame and endFrame need to be specified. (This flag is now obsolete. Please use the -startTime and -endTime flags to specify the frame range explicitly.) In query mode, this flag needs a value.
-startTime(-st)	time
Specifies the start frame of the cache range. In query mode, this flag needs a value.
-endTime(-et)	time
Specifies the end frame of the cache range. In query mode, this flag needs a value.
-samplingRate(-sr)	int
Specifies how frequently to sample relative to each frame. When over-sampling (-overSample has been specified), this parameter determines how many times per frame the runup will be evaluated. When under-sampling (the default, when -overSample has not been specified), the runup will evaluate only once per sr frames, where sr is the value specified to this flag. In query mode, this flag needs a value.
-enabledCachesOnly(-eco)
When present, this flag restricts the -ea/emptyAll, so that only "enabled" disk caches (i.e., disk cache nodes with the ".enable" attribute set to "true") are affected. In query mode, this flag needs a value.
-emptyAll(-ea)
Clear the content of all disk caches. If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected. In query mode, this flag needs a value.
-empty(-e)	string
Clear the content of the disk cache with the given disk cache node name. If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected. In query mode, this flag needs a value.
-deleteAll(-da)
Delete all disk cache files. If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected. In query mode, this flag needs a value.
-delete(-d)	string
Delete the cache given the disk cache node name. If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected. In query mode, this flag needs a value.
-closeAll(-ca)
Close all disk cache files. If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected. In query mode, this flag needs a value.
-close(-c)	string
Close the cache given the disk cache node name. If -eco/enabledCachesOnly is "true" only enabled disk cache nodes are affected. In query mode, this flag needs a value.
-append(-a)
Append at the end and not to flush the existing cache In query mode, this flag needs a value.
-overSample(-os)
Over sample if true. Otherwise, under sample. In query mode, this flag needs a value.
-cacheType(-ct)	string
Specifies the type of cache to overwrite. "mcfp" for particle playback cache, "mcfi" for particle initial cache. "mcj" for jiggle cache. This option is only activated during the cache creation. In query mode, this flag needs a value.
-tempDir(-tmp)
Query-only flag for the location of temporary diskCache files. In query mode, this flag needs a value.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command

Return value

Keywords

MEL examples

// Explicitly specify the settings for disk cache
// creation: the start time to 3 and the end time to 10.
diskCache -startTime 3 -endTime 10;
// Specify to use over sampling and with sampling
// rate set to 2, sampling twice for each frame.
diskCache -overSample -samplingRate 2;
// Delete all caches
diskCache -deleteAll;
// Clear the cache content for diskCache3's cache.
diskCache -empty "diskCache3";
// Close all the disk caches.
diskCache -emptyAll;