| API Error Functions | Handling of OpenVSP ErrorObj information is accomplished through this group of API functions. Click here to return to the main page |
| General API Utility Functions | This group of functions is provided for general API utilities, such as printing to stdout, performing basic math functions, and identifying basic OpenVSP information. Click here to return to the main page |
| Advanced Link Functions | The following functions are available for the Advanced Link tool. Click here to return to the main page |
| Analysis Manager Functions | This group is for functions included in the Analysis Manager. The Analysis Manager allows for OpenVSP analyses to be setup and run through the API without having to modify Parms directly. Examples are available for every available analysis type. The results of running an analysis can be accessed through the functions defined in the Results group. Click here to return to the main page |
| Background3D Functions | This group of functions is used to work with 3D background images. Click here to return to the main page |
| BOR Functions | This group of API functions provides capabilities related to the body of revolution (BOR) geometry type in OpenVSP. Click here to return to the main page |
| CFD Mesh Functions | This group of functions is used to setup and run the CFD Mesh tool through the API. Click here to return to the main page |
| VSPAERO Control Surface Group Functions | This group of functions is available for manipulating VSPAERO control surface groups through the API. Note, VSPAERO also includes rectangle type sub-surfaces as possible control surfaces. Click here to return to the main page |
| General Computation Functions | The following group of API functions are available for general computations. In general, it is best practice to perform computations through the the Analysis group instead of calling these functions directly. Click here to return to the main page |
| Custom Geometry Functions | This functions grouped here are used to create and manipulate Custom Components. Custom components are defined in *.vsppart files included in the /"Custom Scripts/" directory. Examples of Custom Components are available in the directory for reference. OpenVSP looks in 3 locations for the /"Custom Scripts/" folder, where Custom Components are loaded: the root directory, the VSP executable directory, and the home directory. Note, these functions are specific to defining Custom Components and can't be called from standard API scripts (i.e. *.vspscript). However, a Custom Component can be created as a *.vsppart file and then accessed through secondary API scripts. Click here to return to the main page |
| Design File Functions | This group of functions is available for managing Design Variables through the API. Click here to return to the main page |
| Edit Curve XSec Functions | Functions for modifying XSecs of type XS_EDIT_CURVE are defined here. Click here to return to the main page |
| Enumerations | All API enumerations are defined in this group. Click here to return to the main page |
| FEA Mesh Functions | The following group of API functions supports all functionality of the FEA Mesh Tool. Structures, FEA Parts, materials, and properties can be defined and manipulated. Mesh and output file settings can be adjusted, and an FEA mesh can be generated. Click here to return to the main page |
| File Input and Output Functions | This group of functions provides file input and output interfacing through the API. Click here to return to the main page |
| Geom Functions | This group of functions is available for adding, deleting, and modifying OpenVSP Geoms through the API. Click here to return to the main page |
| Group Modification Functions | The functions in this group allow for sets to be scaled, rotated, and translated. Click here to return to the main page |
| Matrix4d Functions | API functions that utilize the Matrix4d class are grouped here. For details of the class, including member functions, see Matrix4d. Click here to return to the main page |
| Measure Tool Functions | This group of API functions can be used to control the Ruler Tool through the API. Click here to return to the main page |
| Propeller Blade Curve Functions | The following group of API functions may be used to control parametric propeller blade curves (PCurves). Click here to return to the main page |
| Parasite Drag Functions | This group of API functions is supplemental to performing a Paraste Drag analysis through the Analysis Manager. They include functions to write out Parasite Drag Tool equations, calculate atmospheric properties, and control excrescences. Click here to return to the main page |
| Parm Functions | Every Parm in OpenVSP can be accessed and modified through the functions defined in this API group. Every Parm has an associated ParmContainer. Click here to return to the main page |
| Parm Container Functions | All Parms in OpenVSP are stored in Parm Containers. The functions in this group can be used to work with Parm Containers through the API. Click here to return to the main page |
| API Proxy Utility Functions | The API functions defined in this group enable conversion between AngelScript and OpenVSP C++ data types, such as array and vector. Click here to return to the main page |
| Results Manager Functions | This group is for functions included in the Results Manager. The Results Manager stores analysis results and provides methods to get, print, and export them. Click here to return to the main page |
| Functions for Sets | The following group of API functions deals with set manipulation. Click here to return to the main page |
| Snap-To Functions | This group of API functions provide the capabilities available in the Snap-To tool. Click here to return to the main page |
| Sub-Surface Functions | Functions related to Sub-Surfaces are defined in this group. Click here to return to the main page |
| Geom Surface Query Functions | This group of API functions pertains to general surface queries for Geom surfaces, such as computing 3D location from surface coordinates, identifying curvature, and performing point projections. Click here to return to the main page |
| VSPAERO Functions | The following group of functions are specific to VSPAERO. However, their relevance has been mostly replaced by Analysis Manager capabilities. Click here to return to the main page |
| VSPAERO Actuator Disk and Propeller Functions | The following group of functions provide API capability for setting up actuator disks (Disk tab of VSPAERO GUI) and propellers (Propeller tab of VSPAERO GUI) for VSPAERO analysis. If a propeller geometry is used to model the actuator disk, the "PropMode" must be set to PROP_DISK or PROP_BOTH. Alternatively, the "PropMode" but be set to PROP_BLADE or PROP_BOTH for unsteady analysis. must be set to PROP_DISK or PROP_BOTH. Click here to return to the main page |
| Variable Preset Functions | This group of functions can be used to add, remove, and modify Variable Presets through the API. Click here to return to the main page |
| Vehicle Functions | The Vehicle group of functions are high-level commands that pertain to the entire OpenVSP model. Click here to return to the main page |
| Visualization Functions | The following group of functions allow for the OpenVSP GUI to be manipulated through the API. Click here to return to the main page |
| XSec and Airfoil Functions | This group of functions provides API control of cross-sections (XSecs). Airfoils are a type of XSec included in this group as well. API functions for Body of Revolution XSecs are included in the Specialized Geometry group. Click here to return to the main page |
| XSecSurf Functions | This group of API functions provides capabilities related to the XSecSurf class in OpenVSP. Click here to return to the main page |
| Vec3D Functions | API functions that utilize the vec3d class are grouped here. For details of the class, including member functions, see vec3d. Click here to return to the main page |
1.12.0