spinfirescript.py — Script Module
This is the module every script actually imports — import spinfirescript as sfs — as seen in the usage example on every function across the package. It is an aggregator: it wildcard-imports everything from application, selection, geometry, graphics, sectionplanes and assemblyitems, so all of their functions and enums (RenderMode, TreeItemType, Plane, PlaneAxis, and the .NET StandardView that graphics imports) are reachable as sfs.FunctionName / sfs.EnumName without importing each sub-module separately. It also loads the SpinFire.LinearAlgebra and SpinFire.Scripting.API .NET references via clr.AddReference, and imports spinfirecontext so ScriptManager is available underneath.
Enums
Enum |
Values |
|---|---|
|
|
Axis is used for rotation calls such as assemblyitems.RotateSelectedAssemblyItems(axis, directedAngle, coordinateSystem), e.g. sfs.RotateSelectedAssemblyItems(sfs.Axis.Y, 20.0).
What It Re-exports
Every function documented on the application.py — Application Module, selection.py — Selection Module, geometry.py — Geometry Module, graphics.py — Graphics Module, sectionplanes.py — Section Planes Module and assemblyitems.py — Assembly Items Module pages is callable directly off sfs. See the Function Index (A–Z) for the full flat list.
