Scripting API

Cathedral

from ArtisanPlugin.Scripting import CathedralApi as cathedral

The cathedral shank - arms rising toward the setting, the classic body under halo and solitaire designs.

Create

shank = cathedral.Create(topWidth = 2.5, topHeight = 1.9,
                         bottomWidth = 3.5, bottomHeight = 1.8,
                         armWidth = 4.5, armHeight = 3.5,
                         withGems = False, gemSize = 1.3, gemsAngle = 180,
                         fingerDiameter = 0, profile = None)          # -> ICathedral

Parameter	Default	Meaning
`topWidth` x `topHeight`	`2.5 x 1.9`	Band section at the top
`bottomWidth` x `bottomHeight`	`3.5 x 1.8`	Band section at the bottom
`armWidth` / `armHeight`	`4.5` / `3.5`	The opening between the rising arms and how high they climb over the finger circle
`withGems`	`False`	Adds the pave row along the top - one run per arm
`gemSize`	`1.3`	Stone size of the pave row, mm
`gemsAngle`	`180`	Degrees of the shank covered by the row
`fingerDiameter`	`0`	`0` = the document’s configured ring size
`profile`	`None`	`RING_PROFILE` asset by name

The pave rows are baked as child objects of the shank, like the tool’s Accept.

Edit

The ICathedral handle has two sections; each setter regenerates the shank in place:

Section	What it edits
`Shank`	Profile asset, top and bottom band sections, arm angle/width/height/tangent, cap distance, and the whole bridge
`Gems`	The pave row: shape, size, arc, spacing, channel, prongs, drills, scalloped proportions

SetTopWidth / SetTopHeight / SetBottomWidth / SetBottomHeight are shortcuts for the band sections.

shank.Shank.SetArmHeight(4.0)      # regenerates the cathedral
shank.Gems.SetProngType("SCALLOPED")

Queries

All(), Find(id), Count(), Selected(), ByLayer(name).