This repository is no longer active after the migration from Vault SDK to udSDK. Please use the udSDKPython moving forward.

Python3 Vault SDK

This integration contains several demonstrations of using Vault SDK renderer in increasingly complex contexts. The code is written to be as modular as possible and is designed as an interface for Vault SDK to the Python language and it's libraries.

Language:              Python3
Type:                  Language Example
Contributor:           Euclideon Vault Development Team <support@euclideon.com>
Organization:          Euclideon, https://euclideon.com/vault
Date:                  2020-04-30
Vault SDK Version:     0.6
Toolsets:              Python 3.8 Pillow Pyglet Numpy IPython3

Resources Required

This resource requires Euclideon Vault SDK and the following Python libraries to be installed for python 3.8:

Install Euclideon Vault SDK

Euclideon Vault SDK can be obtained from here

Set the system variable for VAULTSDK_HOME on your operating system to the folder that vault SDK was downloaded to

Windows

On Windows, run command prompt as administrator and then run the command:

setx VAULTSDK_HOME "[path to vault SDK]"

e.g.

setx VAULTSDK_HOME "C:\Euclideon_vdk0.6.0"

Linux

Add the following command to your .bashrc

`export VAUTLSDK_HOME="[path to vault sdk]"

Restart your terminal or open a new one

Configure Python

The following packages are required to run the contained packages.

• pillow (formerly PIL)

• Pyglet

• Numpy (or Scipy)

• Ipython3

All packages are available through the pip repository and can be installed via

pip install ipython pyglet pillow scipy

How to use the sample

vault.py

This is the low level wrapper for Vault SDK to python. It implements a subset of the available C library as Python classes. Not all functionality of Vault SDK is currently implemented in this file. See the Vault SDK documentation for a full list of exposed functions.

main.py

This file contains the basic usage of vault SDK for rendering a UDS and writing it to file using Pillow. It demonstrates low level usage of functions and is a good starting point for users wanting to fully understand the process of generating a render using Vault SDK

Usage: python3 main.py yourvaultusername yourvaultpassword [pathtoUDS] will run the sample code and write an image using the Vault Renderer

As this is a low level wrapper the test code is designed to work with DirCube.uds located in the vault SDK

easyrenderer.py

This file contains a python object wrapper EasyRenderer which automates many commonly set features and renders a UDS to a set of images. It is intended as a demonstration of generating renderings from UDS files.

Python Client

This example includes and example client written in python using the above wrappers for Vault SDKs libraries. It is intended as a starting point for Vault SDK users wanting to develop their own client implementations and is designed to be easily extensible using python. It relies on numpy and pyglet libraries in addition to Vault and Pillow

The integration can be run by running the following in console from the main directory:

ipython3 [vaultUsername] [vaultPassword]

UDS files can then be loaded by dragging and dropping from your OS shell (Explorer on Windows) into the window that is created.

Controls are described for each camera type on the right hand side of the screen, the camera type can be changed using tab. The terminal used to start the program can be used to directly modify the behaviour of the running program.

pygletexample.py

A basic python client for viewing UDS models made using pyglet (an openGL wrapper for python). It makes use of the EasyRender object interface App represents the window context that the application runs in. It handles all user input and manages dispaches the draw commands to the various UI objects. VDKViewPort and it's derived objects represents an OpenGL quad which is to be textured using the frame buffer written to by each call of vdkRenderContext.Render

When this file is run as a python script (i.e. by running python3 pygletexample.py with the appropriate python environment set up, the calling terminal is transferred to an IPython session with access to the namespace of current session. This allows the user control of the session from the terminal. For example, to change the camera object the main viewport is attached to the user may run main.set_camera(OrthoCamera) to change the type of camera to the Orthographic projection camera.

Camera.py

Contains camera classes for use with the python. For the purposes of this example The class definitions included in this file are designed to be extended using python's inheritance features. Each object inherits from the base Camera class to allow overwriting of object methods to achieve different effects and control schemes.

Camera is a basic camera class implementing a perspective camera with standard controls

OrthoCamera subclasses Camera and overwites the behaviour when setting the projection matrix of the render to Orthographic. This mode displays all parts of the model at the same scale regardless of the distance from the camera (i.e. ignoring perspective) As such the camera 'moving' in space corresponds only to moving the locations of the planes that define the box that the user sees.

OrbitCamera sublasses Camera and modifies the method for determining camera movement direction such that it orbits about a fixed point in space.

MapCamera Inherits from the OrthoCamera We add an additional parameter to this camera target which is a reference to another camera that the MapCamera sets its position to be above and looking directly down on to. It intended to be used in conjunction with VDKMapPort to produce the Map UI element in the sample.