Go to: Related nodes. Attributes.

The cacheFile node maintains an association between cached data on disk and an output attribute. The cached data on disk is usually created by the cacheFile command. For example, let's say that you create cache data files containing vector arrays for frames 1-100. The cacheFile node can be used to read in the data from those files and output it to its vectorArrayOutput attribute.

This output attribute can then be connected to any vectorArray input attribute that wants to use the data from disk.

Node nameParentsMFn typeCompatible function sets
cacheFilecacheBasekCacheFilekBase
kNamedObject
kDependencyNode
kCacheBase
kCacheFile

Related nodes

cacheBlend

Attributes (26)

cacheName, cachePath, cacheWeights, channel, displayLoadProgress, enable, end, format, hold, memQueueSize, multiThread, originalEnd, originalStart, oscillate, perPtWeights, postCycle, preCycle, reverse, scale, sourceEnd, sourceStart, start, startFrame, time, track, trackState

Long name (short name)TypeDefaultFlags
cacheName (cn) stringNULLoutputinputconnectablestorable
The name of the disk cache file
cachePath (cp) stringNULLoutputinputconnectablestorable
The path to the disk cache file
format (fmt) stringNULLoutputinputconnectablestorable
Allows the format of the cache files to be explicitly set. The format is usually determined from the xml description file, in which case this attribute should be left unset.
channel (ch) stringNULLarrayoutputinputconnectablestorable
The channel name of the channel in the cache file that should be hooked up to the associated outVectorArray
cacheWeights (cw) doubleArrayemptyoutputinputconnectable
Weights for the cache
perPtWeights (ppw) doubleArrayemptyarrayoutputinputconnectablestorable
Weights for the cache
originalStart (os) time0filmoutputinputconnectablestorablehidden
The time when the original cache starts. Used as reference to know where the actual start of the cache data on disk.
originalEnd (oe) time0filmoutputinputconnectablestorablehidden
The time when the original cache ends. Used as reference to know where the actual end of the cache data on disk.
sourceStart (ss) time0filmoutputinputconnectablestorable
The time when playback starts, in terms of the time on the original cache. Can be used to trim the beginning portion of the cache to the desired starting point. For example, say the original cache was created for time 0-50. We stretch this cache out to 0-100, and then truncate the first 25 frames. In this case, sourceStart would have value 12.5 (25% of the original cache).
sourceEnd (se) time0filmoutputinputconnectablestorable
The time when playback starts, in terms of the time on the original cache. Used to trim the ending portion of the cache to the desired ending point. See description on sourceStart for details.
startFrame (sf) time0filmoutputinputconnectablestorable
The start frame where the cache will start playback.
scale (sc) double1.0outputinputconnectablestorable
Used to scale the cache playback
hold (h) time0filmoutputinputconnectablestorable
Length of time that the cache holds its end value.
preCycle (cb) double0.0outputinputconnectablestorable
The preCycle value is used to repeat the cache, in whole or in part, before the beginning of the original cache.
postCycle (ca) double0.0outputinputconnectablestorable
The postCycle value is used to repeat the cache, in whole or in part, after the end of the basic cache.
start (st) time0filmoutputconnectable
When the cache playback will begin based on the startFrame and preCycle.
end (e) time0filmoutputconnectable
When the cache playback will end based on the startFrame, scale, etc.
time (tim) time0filmoutputinputconnectablestorablehidden
The current time.
enable (en) bool1outputinputconnectablestorable
Whether or not the cache is enabled for playback
reverse (rev) bool0outputinputconnectablestorable
Play the clip backwards in time
oscillate (osc) bool0outputinputconnectablestorable
Reverse every other cycle so that the cycles are continuous.
track (tr) short0outputinputconnectablestorable
track index for the clip that corresponds to this cache
trackState (ts) short0outputinputconnectablestorablehidden
Flag bits for the track state. Current mask values are: 1: when set means that all the caches on the track are locked 2: when set means that all the caches on the track are soloed 4: when set means that all the caches on the track are muted 8: when set means that another track is soloed, so this track acts as if it is muted
multiThread (mt) bool0outputinputconnectablestorable
Whether or not the cache is setup for multithreading during playback
memQueueSize (qs) integer20outputinputconnectablestorable
If multithreading is enabled and is not setup to preload the entire cache, then attribute indicates the number of time entries the cache will try to preload and keep in memory.
displayLoadProgress (dp) bool1outputinputconnectablestorable
Whether or not to display the what percentage of the memory queue is full when multithreading is on.