Document toolboxDocument toolbox

Scripting Changes

Owned by Franz Barta
Mon Jul 31, 2023
2 min read

A number of additional functionality has been added to SpinFire Ultimate scripting, primarliy focused around cooridate systems.

SpinFire Ultimate 11.10.1 adds the following features,

  • Get a coordinate systems list.

  • Show a coordinate system.

  • Hide a coordinate system.

  • Export the coordinate system's transformation matrix.

  • Select items by type.

  • Rename a selected assembly

 

Function

GetCoordinateSystems()

Summary

Returns the 'SpinFire.Scripting.API.Geometry.CoordinateSystemsData' object with collection of coordinate systems and possible message.

Example

Output Example

 

Function

ShowCoordinateSystem()

Summary

Shows the coordinate system.

Parameters

The name or index of the coordinate system.

Example

Output Example

n/a

Function

HideCoordinateSystem()

Summary

Hides the coordinate system.

Parameters

The name or index of the coordinate system.

Example

Output Example

n/a

Function

SelectItemsByTypes(itemTypes, clearSelection=true)

Summary

Selects the items by types.

Parameters

itemTypes(list(TreeItemType)): The types of the items.clearSelection(bool): The value indicates whether to clear all currently selected items.

Example

Output Example

Function

RenameSelectedItem(“new name“)

Summary

Renames the select item.

Parameters

The new name for the selected assembly.

Example

Output Example