Skip to content

Scripting API

Pave shank

from ArtisanPlugin.Scripting import PaveShankApi as pave

A band carrying one or more longitudinal rows of stones - each row a line of equal stones at its own lateral offset, running between two angles along the band.

Create

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

Edit

The IPaveShank handle exposes the band and the rail; each setter regenerates the shank in place, re-baking stones and prongs:

SectionWhat it edits
TopProfileThe band section - the same classic profile model: asset, closing type, width/height, thickness, comfort, rotation, orientation
AdvancedThe opening at the bottom: none, cut or strangle
RailThe rows (replace the whole list, or edit one by index), the prong definitions, and the global prong height and diameter
CuttersEnabledWhether the gem cutters are subtracted from the band
from ArtisanPlugin.Scripting import PaveShankApi as pave, Transaction

ring = pave.Selected()[0]
with Transaction.Begin("Tighter centre row"):
    ring.Rail.SetRow(0, gemSize = 1.1, offset = 0.0, spacing = 0.15,
                     startAngle = 20, endAngle = 160)
    ring.Rail.SetProngDiameter(0.6)

Each row reports GemSize, Offset, Spacing, StartAngle, EndAngle and Mirror; each prong reports its RowIndex, position, Diameter, Height and flags.

Queries

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