Packages

Every package in spinfireapi, mirroring the Package List in SpinFire Insight’s own scripting docs. Scripts import spinfirescript, not the individual sub-modules directly.

Package

Description

spinfirescript.py — Script Module

The module scripts actually import (import spinfirescript as sfs). Re-exports every function from the modules below and defines the Axis enum.

spinfirecontext.py — Context Module

Holds ScriptManager and DefaultScriptManager, set by SpinFire before each script runs.

application.py — Application Module

Opens and closes SpinFire files.

selection.py — Selection Module

Interactive, prompt-driven selection of points, edges and surfaces.

geometry.py — Geometry Module

Creates and deletes user (script-authored) geometry — lines, polylines, shells.

graphics.py — Graphics Module

Screenshots, file import/save, coordinate systems, item visibility, standard views.

sectionplanes.py — Section Planes Module

Controls section/clipping planes. Defines Plane and PlaneAxis.

assemblyitems.py — Assembly Items Module

Tree/assembly queries, selection by path/name/type, appearance, transforms. The largest module. Defines RenderMode and TreeItemType.

Sample Scripts

Sample Script — Calculate Cylindrical Radius — demonstrates selection combined with NumPy-based geometry math. Defines VertexInfo and CircleInfo.

See Classes for every enum/class organized by owning package, Files for the mapping to actual source paths, and the Function Index (A–Z) for a flat alphabetical lookup.