Commit
Function
This is a pre-comp node for manaul caching of trees. You set the directory (not
file) with the browser, set the range you want to commit (which can be automatically
calculated with the Auto button), and turn status to 1 to turn
it on. At this first stage of the node's development, it will render the image
into cache when you are reviewing it inside the GUI, meaning you hit Play on
the Time Bar, but not from a batch render/flipbook render. At a later
development stage, we automatically will launch it into a render queue. Promise.
This caching will create a directory following the format of Shake's normal
cache, named for the size in x and y in percent, meaning 100x100 at full resolution.
If you set a smaller proxy, it will save it in a different directory, i.e.,
.5 proxy means a directory named 50x50. There are only two places of precision,
so .501 proxy scale will overwrite your .5 proxy scale. Since resolutions are
recognized, you can use this for a pre-generated proxy.
Shake will use this cached file whenever it detects that the cache id is valid,
i.e., you haven't changed any parameters above it. If you change the parameters
and hit Play on the Time Bar again, it will overwrite the cache
file, but will automatically do so on the current frame anyway.
As long as the directory is pointed to with a UNC name, other machines will
recognize the cached files and use them in batch renders.
IMPORTANT: You don't want to use Commit when the image
has more information than you are finally going to be using, i.e.,
Failure to follow the above principles will generate inefficiencies in terms
of storage space, access time, and batch-processing time.
Parameters
|
Type
|
Defaults
|
Function
|
cachePath |
string
|
|
This is the directory in which Commit will create further subdirectories storing the cache |
timeRange |
string
|
|
The range in which the cache should be either calculated or read. |
status |
int
|
0
|
Synopsis
image Commit( const char * cachePath, const char * timeRange, int status );
Script
image Commit( "cachePath", "timeRange", status );