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

‌SyPy Module Overview

SyPy's main programmer-level interface is called SyLevel; you can think of it as "high level" as it interacts with SynthEyes at a relatively high level, allowing you to open new SynthEyes instances, open shot files, examine trackers and meshes, etc.

Other files include:

 syobj - an intermediate-level class used to represent references to SynthEyes shots, trackers, objects, etc

 sywin - a class representing windows and controls within SynthEyes

 symenu - a class representing menus and submenus

 sypy - the low-level interface from python to SynthEyes via the communication channel

 syconfig - configuration variables that you might need to adjust, such as the full path name of the SynthEyes application

 sytrans - module with the SyTrans class for manipulating transform matrices plus various utility functions

 sytalker - a small stand-alone program that allows hand debugging via the communication channel

Note that for Python 3, you'll need to import from SyPy3 not SyPy, though if you want your scripts to work in either environment, you can install SyPy3 as SyPy instead.

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