Classes

Every enum and class in spinfireapi, organized by the package that defines it — mirroring the Class List in SpinFire Insight’s own scripting docs, rather than a flat alphabetical list.

spinfirescript

Class	Values
Axis (enum)	X = 0, Y = 1, Z = 2

See spinfirescript.py — Script Module.

spinfireapi › assemblyitems

Class	Values
RenderMode (enum)	Wireframe = 0, HiddenLines = 1, TriangleMesh = 2, FlatShaded = 3, SmoothShaded = 4, SmoothWithEdges = 5, Reflective = 6, Metallic = 7, SurfaceAnalysis = 8
TreeItemType (enum)	Unknown = 0, Scene = 1, Model = 2, Container = 3, Part = 4, Surface = 5, Solid = 6, OpenShell = 7, Direction = 8, Point = 9, Set = 10, Polyline = 11, Polywire = 12, DrawingRoot = 13, View = 14, Sheet = 15

See assemblyitems.py — Assembly Items Module.

spinfireapi › sectionplanes

Class	Values
Plane (enum)	YZ = 0, XZ = 1, XY = 2
PlaneAxis (enum)	X = 0, Y = 1

See sectionplanes.py — Section Planes Module.

Sample - Calculate Cylindrical Radius

These two classes are defined locally in the sample script itself, not in spinfireapi.

Class	Fields
VertexInfo	Point, VertexNormal — a surface vertex paired with its normal
CircleInfo	Radius, Point — a candidate circle’s radius and center

See Sample Script — Calculate Cylindrical Radius.

Referenced But Defined Outside This Package

These types appear as parameters or return values in spinfireapi function signatures but are defined in the underlying SpinFire.Scripting.API .NET layer, not in the Python source — e.g. StandardView (used by graphics.ApplyStandardView), CSPositionParams, CSOrientationParams, CSRotationParams (used by the coordinate-system functions in graphics.py), and various ...Data result objects (PhysicalPropertiesData, TreeItemsData, CoordinateSystemData, ProjectionAreaData, etc.) returned across several modules. The ones confirmed so far are listed in the next section.

Observed Return Types

These were recorded by running the Probe — Return Values script in SpinFire (embedded Python 3.9.2) with Filter.CATPart open. All the .NET types below are in the SpinFire.Scripting.API.Geometry namespace. Each object’s str() gives a readable summary. Coordinates print in the model’s units (mm for this model).

Function	Returns	Members	Observed behaviour
SelectItem	str	—	The item name on success, e.g. Filter. For a bad path it does not raise; it returns an error message, e.g. Failed to get child item with index ‘999’ at level ‘1’.
GetSelectedItems	TreeItemsData	Items, Message	Prints as a numbered list, e.g. 0. Filter (Model).
GetChildren	TreeParentItemsData	Items, Message	Prints as parent and children, e.g. Filter (Model): [Filter (Container)].
ClearSelectedItems	str	—	Confirmation message.
InsertLine	LineData	ID, Message, Delete()	ID is a 32-character hex string. Message reads e.g. Line ‘<ID>’ was successfully inserted.
InsertShell	ShellData	ID, Message, Delete()	Same shape as LineData.
DeleteUserGeometry	str	—	Confirmation message.
ToggleSinglePlane	None	—	Switches on the YZ plane: every cut point it produced had X = 0, and the XY plane stayed off.
GetSectionCutEdges	SectionCutEdgesProfile	CutPlaneEdges, ErrorMessage	Prints each cut edge as a list of points, e.g. [[[0.00, -30.21, 6.36] mm, [0.00, -14.24, 6.36] mm]].
GetProjectionArea	ProjectionAreaData	AreaModel, Message	If the requested plane is off, Message says so rather than raising.
SelectEdge	Edge	Points	Prints as a list of points, e.g. [14.48, -26.51, 5.45] mm. Returns None if cancelled.

Not yet known: the element types inside Items, CutPlaneEdges and Edge.Points; what AreaModel holds; and whether the Delete() method on LineData and ShellData behaves like DeleteLine/DeleteShell. It hasn’t been tried.