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

SyPy: Python Reference Manual for SynthEyes 2024

(SynthEyes 2023.10.1057)

The SyPy ("sigh-pie") module allows extensive control of a SynthEyes application process from within a Python programming environment using an object-oriented interface. The SynthEyes scene and user interface can be manipulated directly to add additional functionality, or to interface with other applications to integrate with a studio workflow. SyPy can launch SynthEyes instances, control existing ones, or be run by SynthEyes at the user’s request to implement custom tools.

SynthEyes interfaces with a Python interpreter using a client/server approach, much like an X server on Linux. This provides important advantages of flexibility and reliability. You can use your own version of the Python interpreter, or use the Python interpreter built into third-party applications such as Shotgun or Maya. With this approach, you do not have to set up python/python communication channels: you can directly control SynthEyes from another app.

Usage Prerequisites and Setup What to Read SyPy Module Overview Configuring Python and SynthEyes Windows Mac OS X Linux To Other Apps Talking to SynthEyes SynthEyes’s Python Script Handling Programming SynthEyes in Python Direct Attribute Access Undo Consistency Control Additional Functionality SyLevel Class Reference SynthEyes Instance Control Adding New Shots Export Control User Interface Controls Appearance Flags Sizzle Interface Control SynthEyes Entity Access Undo Control Special Shot Routines Preferences Menu Operations Window Operations Actions Utility SyObj Class Reference SyPrefObj Reference SyTrans Reference Member Functions of SyTrans Standalone functions SyWin Reference SyMenu Class Reference SyPy Class Reference Calling Arbitrary Sizzle Functions Examples Changing a Tracked Camera to a Moving Object Shot Loading a Shot and Path Creating a Mesh Blendermash Importer

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