Pixyz UI Overview

The Pixyz UI is a simple interface where you can test Pixyz SDK functionality on your models and familiarize yourself with Pixyz concepts.

Importing a model

To import any file, just drag and drop it on the Pixyz UI. A list of supported file formats can be found HERE. Alternatively, you can select a file via IO/Import File in the menu bar or by pressing Ctrl+I.

Executing Pixyz SDK functions

Function Browser

Any function available in the SDK can be tested by opening the Function Browser window at Python API/Function Browser. After entering your parameters, it is also possible to copy the function code as a python snippet to clipboard.

Command Palette

There is also a simple Command Palette available, which can be opened with Ctrl+Shift+P. You can search for functions and press Enter to open a popup which enables you to execute that function. This is not different from the Function Browser, but more convenient for working quickly.

Scripting

Additionally, there is a scripting window which can be opened via Python API/Scripting . Due to its limited functionality, it is not recommended to write long scripts inside the Pixyz UI. It has proven most efficient for small iterations, to import and test existing scripts or just to tweak parameters. Anything else should be done using your preferred IDE with the Pixyz SDK.

Modifying Preferences

Pixyz SDK Properties can be modified via Windows/Properties. For Viewer properties, Windows/Visualization can be used to access preferences that are viewer-specific. Keep in mind that these settings will be saved in between sessions.

Additional Functionality

Pixyz UI comes with multiple predefined windows, which can be accessed via the Windows dropdown in the menu bar. They range from a simple animation player to a more elaborated UV Viewer tool and many others.