Document toolboxDocument toolbox

Scripting Examples

Owned by Glen Yamakawa
Mon Jun 06, 2022

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


 Get the Physical Properties of Items

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)

 Rotate the Entire Assembly

The following demonstrates selecting and rotating an assembly through scriptnig.

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()

 Insert a 2D Line

The following demonstrates creating 2D lines through scriptnig.

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)


 Insert a 3D Polyline

The following demonstrates creating a 3D polyline through scriptnig.

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
# First open a 3D workspace to execute this script
import spinfirescript as sfs

print(sfs.InsertPolyline([[00, 00, 00], [50, 50.5, -70], [100, 75, 83.7]], "#FFAA0000", 2))



 Import a Model

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

Usage:

ImportFile(filename path)

Parameters

filename path: filename path of the file to import.


Import a File Example code
# First open a 2D or 3D workspace to execute this script
import spinfirescript as sfs  

print(sfs.ImportFile("C:/temp/TestCube.CATPart"))
 Save to an ACT3D File

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

Usage:

SaveFile(filename path)

Parameters

filename path: filename path of the ACT3D file.


Save ACT3D File Example code
# First open a 2D or 3D workspace to execute this script
import spinfirescript as sfs

print(sfs.SaveFile("c:/temp/new.ACT3D"))

Related Topics