cacheFile

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.

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)	Type	Default	Flags
cacheName (cn)	string	nullptr
The name of the disk cache file
cachePath (cp)	string	nullptr
The path to the disk cache file
cacheWeights (cw)	doubleArray	empty
Weights for the cache
channel (ch)	string	nullptr
The channel name of the channel in the cache file that should be hooked up to the associated outVectorArray
displayLoadProgress (dp)	bool	1
Whether or not to display the what percentage of the memory queue is full when multithreading is on.
enable (en)	bool	1
Whether or not the cache is enabled for playback
end (e)	time	0film
When the cache playback will end based on the startFrame, scale, etc.
format (fmt)	string	nullptr
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.
hold (h)	time	0film
Length of time that the cache holds its end value.
memQueueSize (qs)	integer	20
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.
multiThread (mt)	bool	0
Whether or not the cache is setup for multithreading during playback
originalEnd (oe)	time	0film
The time when the original cache ends. Used as reference to know where the actual end of the cache data on disk.
originalStart (os)	time	0film
The time when the original cache starts. Used as reference to know where the actual start of the cache data on disk.
oscillate (osc)	bool	0
Reverse every other cycle so that the cycles are continuous.
perPtWeights (ppw)	doubleArray	empty
Weights for the cache
postCycle (ca)	double	0.0
The postCycle value is used to repeat the cache, in whole or in part, after the end of the basic cache.
preCycle (cb)	double	0.0
The preCycle value is used to repeat the cache, in whole or in part, before the beginning of the original cache.
reverse (rev)	bool	0
Play the clip backwards in time
scale (sc)	double	1.0
Used to scale the cache playback
sourceEnd (se)	time	0film
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.
sourceStart (ss)	time	0film
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).
start (st)	time	0film
When the cache playback will begin based on the startFrame and preCycle.
startFrame (sf)	time	0film
The start frame where the cache will start playback.
time (tim)	time	0film
The current time.
track (tr)	short	0
track index for the clip that corresponds to this cache
trackState (ts)	short	0
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