Skip to content

Scripting API

Split shank

from ArtisanPlugin.Scripting import SplitShankApi as split

A cathedral-style band that opens into two arms toward the setting. The band is swept along a parametric rail through three profile sections.

Create

No Create yet. Run ArtisanSplitShank in the UI once, then script every variant from the handle.

Edit

The ISplitShank handle has two sections plus the swept profiles; each setter regenerates the shank in place:

SectionWhat it edits
CurveThe rail: arm height and angle, outward bulge, tangency, where the split starts, how wide the arms separate, lateral displacement and inclination
SectionsThe three swept profiles, in rail order (bottom, side, top). Read the list, then edit one with SetSection(index, ...) or toggle it with SetSectionEnabled(index, enabled)
GemsThe pave run along the arms: a top-to-bottom size gradient, spacing per zone, channel shape and clearance, prongs, drills, V-cutters
from ArtisanPlugin.Scripting import SplitShankApi as split, Transaction

ring = split.Selected()[0]
with Transaction.Begin("Taller arms, wider split"):
    ring.Curve.SetArmHeight(4.5)
    ring.Curve.SetSplitWidth(8.4)
    ring.SetSection(1, position = 0.5, width = 2.8, height = 1.9)

Queries

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