Sizzle Interface Control

< Previous | Contents | Manuals Home | Boris FX | Next >

‌Sizzle Interface Control

These routines control the Sizzle environment created when a python call does something using a Sizzle-based accessor routine. Note that these variables are local to a particular listener connection. The "Set" routines all return the previous value of the parameter.

The SzlRecalc flag controls whether or not certain splined attributes are immediately recalculated when the value is changed on a specific frame. If you are interactively moving the seed path, you want the rest of the path to update if you move one frame. But if you are loading 3000 points on the path in one operation, there is no need to constantly recalculate the splines. Disabling recalculation with SetSzlRecalc will save a lot of time. If you disable recalculation, be sure to explicitly recalculate anything you have changed using the corresponding recalculation Sizzle call. For example, if you load the camera seed path, do a cam.Call("RecalcSeedPath") call at the end for each affected object. Otherwise unkeyed frames will not be updated to match the new keys. You can tell which attributes are affected by SzlRecalc by looking for the matching recalculation call in the Sizzle Scripting guide.

SzlFrame() Get the SyPy frame number override. This frame number is the one used when animated SynthEyes object attributes are accessed. Equivalent to Sizzle's frame variable.

SetSzlFrame(frm) Set the SyPy frame number override, which is used when

animated attributes of SynthEyes objects are accessed or changed.

ClearSzlFrame() Clear the frame number override (ie to -1). Further references to animated attributes will refer to their value at the current user-level frame number.

SzlRecalc() State of the immediate recalculation flag. 1=recalculate (default), 0=suspend.

SetSzlRecalc() Sets the immediate recalculation flag. Use to suspend spline recalculation when making many changes to a camera/object seed or solve path, or seed or solve FOV etc. See discussion above.

AxisMode() The effective scene axisMode (0=Z Up, 1=Y Up, 2=Y Up Left), as coming from the scene modified by the sizzle setting below. The axis mode setting changes the value of vectors and transforms that are Sizzle attributes (r/w). Note that the base value is for the scene; the axis mode preference is used only when a new scene is created. To change a scene's axis mode, hlev.Scene().Set("axisMode", nnn) within a Begin/Accept.

SzlAxisMode() The current axis mode override setting, or -1 if none.

SetSzlAxisMode(md) Set the local axis mode override to this value. No override

if the value is -1

ClearSzlAxisMode() Clears the axis mode override by setting it to -1

RotOrder() Reports the rotation ordering setting from the preferences panel, but modified by any local override

SzlRotOrder() The local override for the rotation ordering SetSzlRotOrder(ord) Set the local rotation order override, or -1 to clear it. ClearSzlRotOrder() Clears the rotation order override by setting it to -1

Conform(vecn, veco) Calls Sizzle's Vector.Conform routine, adjusting the

rotation angle vector vecn to match rotation angle vector veco, returning the vector result. This is used to handle wraparound issues in exporters.

< Previous | Contents | Manuals Home | Boris FX | Next >