Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

UI Expand
titleClick Here to expand additional $(VARIABLE) and Channel Mapping information

$(same_as_output) [nodeName] – The same path that is set in the Output rollout would be used for loading the preview and render caches. When a node name is specified, its output is passed to the current input.
$(simoutput) – A synonym for $(same_as_output).
$(dir) – The scene directory.
$(data_dir) – The default directory where cache files are written. By default this is $(dir), meaning that the cache files are written next to the scene file, but it can be overridden with a custom directory from the Phoenix Global Preferences.
$(scene) – The scene file name.
$(handle) – A unique number of the node.
$(nodename) – The name of the node.
$env(<variable_name>) – An environment variable. See Using Environment Variables.

Pound signs can be used to specify the cache frame number with at least as many digits as the pound signs. If the number of frame digits is less than the number of pound signs, the number is padded with zeroes to the left. For example:

Align
aligncenter
 Result
Frame Number#######
11010001
1010100010
1000100010001000

...

Section

Example: Timeline Origin

 


 

Section
Column
width40%
UI Text Box
typeinfo

The following example demonstrates how the Timeline Origin parameter can be used to specify which frame on the timeline is treated as the first frame when reading the Input Path cache files.

The files go from simulationFrame_000 to simulationFrame_030. When the Timeline Origin is set to 10, they are read as if they were saved as simulationFrame_010 to simulationFrame_040.

Column
width60%

...

Section

Example: Cache Origin and Play Speed

 


 

Section
Column
width40%
UI Text Box
typeinfo

The following example demonstrates how the Cache Origin and Play Speed can be used to offset and speed up the input cache files.

The files go from simulationFrame_000 to simulationFrame_030. When the Timeline Origin is set to 100, they are read as if they were saved as simulationFrame_100 to simulationFrame_130.

The Cache Origin is then used to specify which simulation Frame will be placed on Timeline Origin = 100. Because Cache Origin is set to 10, the whole sequence is shifted 10 frames back such that simulationFrame_000 is placed at frame 90. Thus, the sequence now goes from frame 90 to frame 120.

The Play Speed is then set to 2.0. Those thirty frames are now reduced to fifteen. The Cache Origin frame is treated as the middle point when shrinking the sequence.

Column
width60%

...

Section

Example: Looping a Simulation

 


 

Section
Column
width40%
UI Text Box
typeinfo

The following example demonstrates how the Input rollout parameters can be used to loop a simulation.

The Timeline Origin parameter is set to 0 - this will be the first frame of the timeline which the Input Path files read into the scene by the Simulator will be placed on.

The Cache Origin is set to 10 so simulationFrame_010 will be read and placed at Timeline Origin = 0.

The Play Length is set to 15 so the sequence now repeats itself every 15 frames when played back (those are actually simulationFrame_010 to simulationFrame_025).

Finally, the Loop Overlap parameter is set to 5 to provide a few extra frames for blending the start and end of the loop together in a smooth transition.

Column
width60%

...