Function Index (A–Z)

Every function across the six spinfireapi modules, in alphabetical order, with its owning module and a one-line summary. All are called as sfs.FunctionName(...) after import spinfirescript as sfs.

Function

Module

Summary

ApplyStandardView

graphics.py — Graphics Module

Applies a standard camera view (Front, Top, TopRight, etc.).

ClearSelectedItems

assemblyitems.py — Assembly Items Module

Clears the current item selection.

CloseFile

application.py — Application Module

Closes the current SpinFire file.

CopyScreenshotToClipboard

graphics.py — Graphics Module

Copies a screenshot of the view to the clipboard.

CreateAxisAlignedBoundingBox

assemblyitems.py — Assembly Items Module

Creates an axis-aligned bounding box around the selected item(s).

CreateCoordinateSystem

graphics.py — Graphics Module

Creates a new coordinate system.

DeleteLine

geometry.py — Geometry Module

Deletes a previously inserted line by ID.

DeleteShell

geometry.py — Geometry Module

Deletes a previously inserted shell by ID.

DeleteUserGeometry

geometry.py — Geometry Module

Deletes all geometry created via the Scripting API.

ExportAllPoints

assemblyitems.py — Assembly Items Module

Exports all points.

ExportImage

graphics.py — Graphics Module

Exports the view as an image file.

ExportSectionCutProfiles

sectionplanes.py — Section Planes Module

Exports section cut profiles.

ExportSelectedPoints

assemblyitems.py — Assembly Items Module

Exports the selected points.

FromToSelectedAssemblyItems

assemblyitems.py — Assembly Items Module

Transforms selected items from one coordinate system to another.

GetChildren

assemblyitems.py — Assembly Items Module

Gets the children of the selected tree items.

GetCoordinateSystem

graphics.py — Graphics Module

Gets a single coordinate system.

GetCoordinateSystems

graphics.py — Graphics Module

Gets all coordinate systems.

GetPhysicalProperties

assemblyitems.py — Assembly Items Module

Gets physical properties of selected assembly items.

GetProjectionArea

sectionplanes.py — Section Planes Module

Gets the section cut projection area.

GetProperties

assemblyitems.py — Assembly Items Module

Gets properties of selected assembly items.

GetSectionCutEdges

sectionplanes.py — Section Planes Module

Gets the section cut edges.

GetSelectedItems

assemblyitems.py — Assembly Items Module

Gets info about the selected assembly items.

HideCoordinateSystem

graphics.py — Graphics Module

Hides a coordinate system.

HideItem

graphics.py — Graphics Module

Hides all selected items.

ImportFile

graphics.py — Graphics Module

Imports a file.

InsertLine

geometry.py — Geometry Module

Inserts a single line segment.

InsertPolyline

geometry.py — Geometry Module

Inserts a connected polyline.

InsertShell

geometry.py — Geometry Module

Inserts a custom polygonal shell (mesh).

MirrorSelectedAssemblyItems

assemblyitems.py — Assembly Items Module

Mirrors selected items through a plane.

MoveSectionPlane

sectionplanes.py — Section Planes Module

Moves a specific section plane.

MoveSelectedAssemblyItems

assemblyitems.py — Assembly Items Module

Translates the selected items.

MoveSelectedSectionPlane

sectionplanes.py — Section Planes Module

Moves the currently selected section plane.

OpenFile

application.py — Application Module

Opens a SpinFire file from a path.

OpenFiles

application.py — Application Module

Opens multiple SpinFire files.

RenameSelectedItem

assemblyitems.py — Assembly Items Module

Renames the selected item.

ResetSectionPlaneTransformation

sectionplanes.py — Section Planes Module

Resets the transformation of one section plane.

ResetSectionPlaneTransformations

sectionplanes.py — Section Planes Module

Resets transformations for all section planes.

RotateSectionPlane

sectionplanes.py — Section Planes Module

Rotates a section plane about an axis.

RotateSelectedAssemblyItems

assemblyitems.py — Assembly Items Module

Rotates the selected items.

SaveCurrentFile

graphics.py — Graphics Module

Saves to the current file path.

SaveFile

graphics.py — Graphics Module

Saves to a given file path.

ScaleSelectedAssemblyItems

assemblyitems.py — Assembly Items Module

Non-uniform scale of selected items.

SelectEdge

selection.py — Selection Module

Prompts the user to pick an edge.

SelectItem

assemblyitems.py — Assembly Items Module

Selects an item by tree path.

SelectItems

assemblyitems.py — Assembly Items Module

Selects multiple items by tree path.

SelectItemsByName

assemblyitems.py — Assembly Items Module

Selects items matching a name.

SelectItemsByNames

assemblyitems.py — Assembly Items Module

Selects items matching several names.

SelectItemsByType

assemblyitems.py — Assembly Items Module

Selects items of a given TreeItemType.

SelectItemsByTypes

assemblyitems.py — Assembly Items Module

Selects items of several types.

SelectParentItemsByName

assemblyitems.py — Assembly Items Module

Selects the parents of items matching a name.

SelectParentItemsByNames

assemblyitems.py — Assembly Items Module

Selects the parents of items matching several names.

SelectPoint

selection.py — Selection Module

Prompts the user to pick a point.

SelectSurface

selection.py — Selection Module

Prompts the user to pick a surface.

SetBackColor

assemblyitems.py — Assembly Items Module

Sets back color of selected items.

SetCoordinateSystemActive

graphics.py — Graphics Module

Makes a coordinate system the active one.

SetFrontAndBackColors

assemblyitems.py — Assembly Items Module

Sets front and back color of selected items.

SetFrontColor

assemblyitems.py — Assembly Items Module

Sets front color of selected items.

SetRenderMode

assemblyitems.py — Assembly Items Module

Sets the render mode of selected items.

SetTransparency

assemblyitems.py — Assembly Items Module

Sets transparency of selected items.

ShowCoordinateSystem

graphics.py — Graphics Module

Shows a coordinate system.

ShowItem

graphics.py — Graphics Module

Shows all selected items.

ToggleSinglePlane

sectionplanes.py — Section Planes Module

Toggles the single section plane (YZ).

ToggleThreePlanes

sectionplanes.py — Section Planes Module

Toggles three section planes.

ToggleTwoPlanes

sectionplanes.py — Section Planes Module

Toggles two section planes.

ToggleVisibilityItem

graphics.py — Graphics Module

Toggles visibility of selected items.

UniformScaleSelectedAssemblyItems

assemblyitems.py — Assembly Items Module

Uniform scale of selected items.

UpdateCanvas

geometry.py — Geometry Module

Forces a canvas redraw.

UpdateCoordinateSystem

graphics.py — Graphics Module

Updates an existing coordinate system.

UpdateCoordinateSystemName

graphics.py — Graphics Module

Updates only the name of a coordinate system.

UpdateCoordinateSystemOrientation

graphics.py — Graphics Module

Updates only the orientation of a coordinate system.

UpdateCoordinateSystemPosition

graphics.py — Graphics Module

Updates only the position of a coordinate system.

UpdateCoordinateSystemRotation

graphics.py — Graphics Module

Updates only the rotation of a coordinate system.

ZoomFit

graphics.py — Graphics Module

Zooms to fit all visible items.

73 functions across 6 modules. See the Classes page for the object types these functions accept or return.