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,
bridgeGems = False, bridgeGemSize = 1.0,
bridgeGemsCount = 0) # -> 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 |
gemsCount | 0 | Exact number of gems per side instead of an arc (implies withGems; the arc is derived) |
fingerDiameter | 0 | 0 = the document’s configured ring size |
profile | None | RING_PROFILE asset by name |
bridgeGems | False | Adds stones on the two side faces of the bridge, apart from the pave row. Enables the bridge, which then has no disc and no fillet and grows to the gem size + 0.2 mm when it is thinner |
bridgeGemSize | 1.0 | Stone size of the bridge accent gems, mm |
bridgeGemsCount | 0 | Exact number of accent gems per face (implies bridgeGems); 0 = as many as fit |
The pave rows are baked as child objects of the shank, like the tool’s Accept.
Edit
The ICathedral handle has three 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 |
BridgeGems | The stones on the two side faces of the bridge: the same members as Gems, with "FLUSH", "NONE" or "SHARED" as setting and "ANGLE" (fill the face) or "COUNT" as mode |
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).