Skip to content

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
ParameterDefaultMeaning
topWidth x topHeight2.5 x 1.9Band section at the top
bottomWidth x bottomHeight3.5 x 1.8Band section at the bottom
armWidth / armHeight4.5 / 3.5The opening between the rising arms and how high they climb over the finger circle
withGemsFalseAdds the pave row along the top - one run per arm
gemSize1.3Stone size of the pave row, mm
gemsAngle180Degrees of the shank covered by the row
gemsCount0Exact number of gems per side instead of an arc (implies withGems; the arc is derived)
fingerDiameter00 = the document’s configured ring size
profileNoneRING_PROFILE asset by name
bridgeGemsFalseAdds 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
bridgeGemSize1.0Stone size of the bridge accent gems, mm
bridgeGemsCount0Exact 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:

SectionWhat it edits
ShankProfile asset, top and bottom band sections, arm angle/width/height/tangent, cap distance, and the whole bridge
GemsThe pave row: shape, size, arc, spacing, channel, prongs, drills, scalloped proportions
BridgeGemsThe 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).