Introduction

VCollab Python API is an Application Programming Interface (API) for integrating and customizing VCollab Pro application using Python scripts. VCollab Pro is a standalone application. Python is embedded into VcollabPro to provide a scripting interface to VCollab. Python scripts with VCollab API function can be called from VCollab Pro to automate or customize certain VCollab Pro Functions.

In general, these python interface functions can be used for:

  • Developing customized functions load specific models, show required parts, compare models, display specific 2D labels, create specific results, create hotspots and viewpoints.

  • Develop customized batch mode applications to create images, merge CAX files.

  • Develop customized applications to generate viewpoints (CAX Reports) automatically (Report Automation)

The VCollab python API functions are arranged into the following groups.

  • General functions: General status quarry functions are in this group.

  • File operation functions: Functions such as load, save and merge CAX files, export viewpoints as PPT are placed in this group.

  • Edit operation functions: Functions for the selection and manipulation (show/hide/delete/rename/transform) of parts are in this group. Functions for setting background color are also in this group.

  • View operation functions: View related functions such as setting display modes, feature edge display mode, explode mode, fit view, etc. are in this group.

  • CAE operation functions: CAE operation functions can be used to select a result, set legend parameters, Probe label attributes, Hotspot dialog parameters, Create hotspots, CAE Animation settings, etc. are present in this group.

  • Multi-Model operation functions: Functions to set multi-model parameters such as current model, legend options, etc. are provided here.

  • Viewpoint operation functions: Functions to create, select and manipulate viewpoints are provided here.

  • Note/Label operation functions: Add Note dialog functions are listed in this group.

Note:

  • Python version 3 scripts are supported.

  • Most of the function names and arguments for Python interface functions are same as Presenter API functions.

  • When a CAD model is loaded, CAE functions may not work.

  • These functions are part of VCollab Pro, Python scripts with VCollab API can’t be executed independently.