Document toolboxDocument toolbox

Scripting Examples

Owned by Glen Yamakawa
Last updated: Mon Aug 07, 2023 by Mark Anderson
2 min read

Here are a few simple examples that you can demonstrate on your licensed copy of SpinFire Ulitmate.

Acquire full scripting help from within SpinFire Ultimate using the Documentation menu item from the script menu.

The following shows simple examples of some scripting primitives



The following demonstrates getting the physical properties of the assembly and printing to the console through scriptnig.

Usage

GetPhysicalProperties()

Parameters

none



List physical properties for model
# First open a 3D model to execute this script # Open the python.NET console panel import spinfirescript as sfs sfs.SelectItem([]) propertiesData = sfs.GetPhysicalProperties() print(propertiesData) print(propertiesData.Message)







The following demonstrates selecting and rotating an assembly through scripting.

Usage

RotaeSelectedAssemblyItems(axis, degrees)

Parameters

axis: selectd the x, y, or z axis

degrees: amount to rotate in degrees



List physical properties for model
# First open a 3D model to execute this script   import spinfirescript as sfs for i in range(0,10): sfs.SelectItem([]) sfs.RotateSelectedAssemblyItems(sfs.Axis.X, 30) sfs.RotateSelectedAssemblyItems(sfs.Axis.Y, 20) sfs.RotateSelectedAssemblyItems(sfs.Axis.Z, 45) sfs.ClearSelectedItems()





The following demonstrates creating 2D lines through scripting.

Usage

InsertLine(x-coord, y-coord, color, thickness)

Parameters

x-coord: starting x-coordinate.

y-coord: starting y-coordinate.

color: color as a string in the form "#AARRGGBB"

where AA is the alpha channel

RR is the red channel

GG is the green channel

BB is the blue channel

thickness: line thickness number > 0 



2D Line Example code
# First open a 2D workspace to execute this script import spinfirescript as sfs import random for i in range(1,10): newColor = "#FF"+''.join([random.choice('0123456789ABCDEF') for j in range(6)]) sfs.InsertLine([0, (i+(i*4))*-1], [50, (i+(i*4))*-1], "#FF000000", i) sfs.InsertLine([100, (i+(i*4))*-1], [150, (i+(i*4))*-1], newColor, i)





The following demonstrates creating a 3D polyline through scripting.

Usage:

InsertPolyline([x-coord 1, y-coord 1, z-coord 1], [x-coord 2, y-coord 2, z-coord 2], [x-coord n, y-coord n, z-coord n], color, thickness)

Parameters

x-coord: Starting x-coordinate.

y-coord: Starting y-coordinate.

z-coord: Starting z-coordinate.

color: color as a string in the form "#AARRGGBB",

thickness: lne thickness number > 0 



3D Polyline Example code







The following demonstrates saving the workspace to an ACT3D file through scripting.

Usage:

ImportFile(filename path)

Parameters

filename path: filename path of the file to import.



Import a File Example code







Related Topics