Global Parameters |
These parameters effect the behavior of the entire script, setting things like proxy information and global motion blur controls. Many of these parameters can be set in the command line, so you don't necessarily have to reset them each time you write out a script. For example, your timeRange may be 1-10, but you can modify that when you render on the command line with the -t option:
shake -exec my_script -t 1-240
To access the global parameters, click on the Globals tab or double-click on a blank spot in the Node View. They will pop up in the Parameter View. They also appear when you first launch Shake.
Here are the default values, as they are listed out in the saved script. See Customization - Format for how to set these.
SetTimeRange("1");
SetFieldRendering(0);
SetFps(24);
SetMotionBlur(1, 1, 0);
SetQuality(1);
SetProxyScale(1, 1);
SetProxyFilter("default");
SetPixelScale(1, 1);
SetUseProxyOnMissing(1);
SetDefaultWidth(720);
SetDefaultHeight(486);
SetDefaultBytes(1);
SetDefaultAspect(1);
SetDefaultViewerAspect(1);
SetTimecodeMode("24 FPS");
SetDisplayThumbnails(1);
Name | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||
cacheMode |
Sets the caching mode. No kidding. The cache is a directory or precalculated images with script information attached. When Shake evaluates a node tree, it compares it to the cache to see if it has done this before. If so, by default, it calls up the cached image rather than recalculate. For more information on caching, see About Caching. none: No cache is read or written. |
||||||||||||||||||||||||||||||||||||||||||||||||||
ColorSettings | Controls the color for the text and noodle colors, as well as setting the drawing tension of the noodles. | ||||||||||||||||||||||||||||||||||||||||||||||||||
defaultAspect |
See Format, below. | ||||||||||||||||||||||||||||||||||||||||||||||||||
defaultZoom | When you change the proxyScale, you are changing the actual output resolution. Since the proxyScale is as a tool to speed up testing, and not as a resizing tool, defaultZoom is set equal to proxyScale to keep the visualized image in the Viewer at the same screen size. This is simply a hardware zoom. If you want to deactivate this behavior, set it to 1. | ||||||||||||||||||||||||||||||||||||||||||||||||||
displayThumbnails | See Interface - Node View - Thumbnails. | ||||||||||||||||||||||||||||||||||||||||||||||||||
dropFrame | Drop 30 frames to 29.97 frames for time code purposes when activated. | ||||||||||||||||||||||||||||||||||||||||||||||||||
fieldRendering | Activates field-based rendering. When 0, full frames are rendered. When set to 1, the odd field take precedence, meaning it is the first line at the top. This is usually for PAL images. When set to 2, it makes the even field dominant. This is usually for NTSC images. See About Video for more information. | ||||||||||||||||||||||||||||||||||||||||||||||||||
format |
Call up a preset format with this list. Doing so sets your defaultWidth, Height, etc. These settings are only for Shake-generated image nodes that you create in the future setting this does not change any that already exist. They also do not set the output resolution. Typically, you set this when you first start your project. Every time thereafter you create something like a RotoShape, it inherits this resolution. Default format choices are:
Changing any parameter in format sets the format to Custom. You can create your own formats in a startup .h file. In $HOME/nreal/include/startup, add a line in the following format: DefFormatType("Name", defaultWidth, defaultHeight, defaultAspect, defaultViewerAspectRatio, framesPerSecond, fieldRendering) For example: DefFormatType("NTSC (D1 4:3)", 720, 486, 1/.9f, 0.9f, 29.97,0); |
||||||||||||||||||||||||||||||||||||||||||||||||||
framesPerSecond | Sets the default playback rate of the launched flipbook. Note that this can be changed in the flipbook itself by pressing the number pad + and -. The frame rate is displayed at the top of the flipbook. | ||||||||||||||||||||||||||||||||||||||||||||||||||
interactiveScale | This is similar to proxyScale, but is applied only when you are doing an onscreen transform. The image uses lower-res samples, set to the interactiveScale (i.e., .5 is half resolution), and then pops back to your normal proxyScale when you are done moving. Note that this value is a factor of the proxyScale, so a value of .5 on the interactiveScale with a proxyScale value of .5 means .25 of the total resolution. See Overview - About Proxies for more information. | ||||||||||||||||||||||||||||||||||||||||||||||||||
maxThread | How many processors to use, and is set by default to the maximum amount on your system. | ||||||||||||||||||||||||||||||||||||||||||||||||||
motionBlur |
This is a global control for all transform node motionBlur parameters. Each node has its motionBlur parameter multiplied by this number. Therefore, if this number is 1, all transform parameters are left alone. If the number is 0, all motion blur is effectively turned off. By setting it to a number between 0 and 1, you control the amount of samples taken, speeding up the process. |
||||||||||||||||||||||||||||||||||||||||||||||||||
noodleTension | Sets the drawing tension of the noodles in the Node View. | ||||||||||||||||||||||||||||||||||||||||||||||||||
pixelRatio |
See Overview - About Proxies. | ||||||||||||||||||||||||||||||||||||||||||||||||||
quality | The equivalent of -fast on the command line, when this is 0, anti-aliasing is deactivated, using a poor-grade filter, and sets transformations to integer values to avoid sub-pixel sampling. This considerably speeds up your processing. Once you are finished with the script, boost quality back to 1 and save your script. | ||||||||||||||||||||||||||||||||||||||||||||||||||
shutterOffset | This value is added, not multiplied, to each individual transform node. It sets the beginning frame, relative to the current frame, at which motion is calculated for blurs. | ||||||||||||||||||||||||||||||||||||||||||||||||||
shutterTiming | Similar to the global motionBlur, this modifies all individual transform node shutterTiming parameters. A shutterTiming of 1 equals 360 degrees, .5 equals 180 degrees, etc. A value of 0 turns off motion blur. | ||||||||||||||||||||||||||||||||||||||||||||||||||
thumbnail parameters | See Interface - Node View - Thumbnails. | ||||||||||||||||||||||||||||||||||||||||||||||||||
time | This is linked to the Time Bar to list the current frame. It is only used for the interface, since the script and the command line both depend on the timeRange parameter to determine the current frame. | ||||||||||||||||||||||||||||||||||||||||||||||||||
timecodeMode | Sets how timecode is calculated, either as 24 FPS, 25 FPS, 30 FPS DF (Drop Frame) or 30 FPS ND (No Drop Frame). | ||||||||||||||||||||||||||||||||||||||||||||||||||
timeRange |
This sets the range of frames for the script. The flipbook will read this parameter by default when rendering out to see how many frames to render, and it will be saved with the script as well. See About Time for more information on the syntax. This parameter can be overridden in the command line. Pressing the Auto button takes the bounding box of all of your clips, i.e, the from the earliest frame in any clip to the last frame in any clip. |
||||||||||||||||||||||||||||||||||||||||||||||||||
useProxy useProxyOnMissingFile |
See Overview - About Proxies. | ||||||||||||||||||||||||||||||||||||||||||||||||||
videoHardwareConformMode | This is a setting used by Tremor to control how frames are rendered in vtr-out nodes when the incoming image is different from the regular video format. Shake needs to know about it because the same Shake renderer is used for background rendering for Tremor. There is a global default and per-node parameters that can be used to override it. If you are using just Shake, you can safely ignore this parameter. | ||||||||||||||||||||||||||||||||||||||||||||||||||
viewerAspectRatio | When set to formatDefault, it scales the X-size of the Viewer by format's defaultViewerAspectRatio. When set to custom, it is set to whatever value you want. This is usually used to compensate for video distortion. For cinema frames, you typically use the proxyRatio to scale down in Y. | ||||||||||||||||||||||||||||||||||||||||||||||||||
viewerZoom | The zoom level applied to the Viewer. This does not affect output resolution. | ||||||||||||||||||||||||||||||||||||||||||||||||||
virtualSliderMode | When zero, it is assumed you are using the mouse. When set to 1, it is assumed you are using a stylus. It also allows you to use the virtual sliders in the text fields simply by dragging the left button you don't have to press Ctrl. | ||||||||||||||||||||||||||||||||||||||||||||||||||
virtualSliderSpeed | This adjusts the speed of the virtual slider. When using a stylus, set it to 0. |