Command Line Tools
Each of the parameters should be preceded by a double dash, ie.
pgYetiCacheInfo --file "myFileName.fur"
Please note, you will have to run these commands via the command line, in a terminal of some sort, and either be in the Yeti bin directory or have added it to your PATH environment variable.
pgYetiCacheInfo
A command line utility to provide feedback about evaluated cache files.
| Argument | Description |
|---|---|
--help | produce help message |
--file <string> | the input cache file name |
--density <float> | density of generated fur |
--samples <multi float> | a list of time samples that should be used to evaluate the cache |
--bounding_box | return the bounding box of the evaluated cache |
--hashAt <float> | will evaluate the hash of the cache at the specified time |
| --fastBoundingBox | checks the cache file for a stored bounding box, if it exists that value will be returned. If it doesn't exist the graphs input data will be used to compute a very rough bounding box. No graph evaluation will happen. |
| --textures | will list textures used by any Texture nodes present in the cache. |
| --nodes | returns the list of currently registered node types. |
| --parameters <nodeTypeName> | returns the list of parameters for the specified node type. |
| --detailed | Used with --parameters it will also return the parameter types and default values. |
| --parameterInfo <parameter> | queries the type and default of the specified parameter(s), the expected format is nodetype.parameter name, ie. texture.file_name. Multiple parameters may be specified as a single string value. |
Rendering
Rendering Extension Parameters
Yeti is integrated into the rendering engines as a procedural DSO which has arguments that can be used to control the output of the generated fur by modifying the call to the DSO in the scene description (.rib, .ass, vrscene etc.)
Some are renderer specific, we’ve made note of this in the description.
Argument | Description |
|---|---|
density <float> | Dynamically control the density of the generated geometry. |
length <float> | Dynamically control the length of the generated fibres. |
width <float> | Modulate the width of the generated fibres. |
verbosity<int> | The verbosity of the output ( 0 = none, 1 = some, 2 = all ) |
file <string> | The input fur cache file. |
frame <int> | The current frame, this is an integer and used to load caches etc. |
samples <list of floats> | A list of float values separated by a space representing the motion blur samples to be generated. (RenderMan, 3delight and Arnold only) ie. -samples -0.5 0.0 0.5 |
motionBlockSamples <list of floats> | The actual sample times defined in the Renderman motion block statement. (Renderman and 3delight) |
curveChunkSize <int> | Outputs fur objects as batches of RiCurve calls, this defines the size of the batches or 0 for all in one call. (Renderman and 3delight) |
center_samples <boolean> | A boolean value which tells Yeti to output motion samples centered around frame 0 vs. the current frame. (Renderman and 3delight) |
frameRelativeSamples <boolean> | A boolean value which forces Yeti to interpret the samples as frame relative, it will add the samples to the current frame value. (Arnold) |
setDeformTimeSamples <boolean> | A boolean value which forces Yeti to set the deform_time_samples parameter on newly generated nodes using the specified samples. (Arnold) |
setFrameRelativeDeformTimeSamples <boolean> | A boolean value which forces Yeti to set the deform_time_samples parameter on new generated nodes using the specified samples offset by the frame value. (Arnold) |
imageSearchPath <string> | A semi-colon separated string of paths used to search for images. (textures etc.) |
dynamicHairTesselation <boolean> | A boolean value to toggle between smooth or linear hair splines. (V-Ray) |
segmentLength <float> | The pixel length used to determine the tesselation factor of smooth hair splines. (V-Ray) |
mode <int> | Controls the curve style used for output firbres, 0 == ribbon, 1 == tubes, 2 == orientations (Arnold) |
customMotionStartAndEnd <float> <float> | Used to specify exact motion_start and motion_end parameters for generated geometry. (Arnold) |
Arnold deform_time_samples
There are two parameters that can affect how the deform_time_samples are output on a node in Arnold.
setDeformTimeSamples will use the values listed in the samples parameter as defined, whether or not frameRelativeSamples is used.
setFrameRelativeDeformTimeSamples will offset the values listed in the samples parameter by the current frame (ie. 1.5 and 2.0 on frame 2 would become -0.5 and 0), whether or not frameRelativeSamples is used.
At no point does Yeti reference any deform_time_samples values defined on the proc node.