Scripting API
IPaveShank
Returned by PaveShankApi - a band carrying one or more longitudinal rows of stones. Multiple gems, so no single mother gem. Adds to IParametricObject:
| Member | Meaning |
|---|---|
RingSizeLabel / RingSizeRegion / RingDiameterMm | Ring size |
TopProfile | The band section - IClassicProfile |
Advanced | The band opening - IClassicAdvanced |
Rail | The rows and prongs - IPaveShankRail |
CuttersEnabled / SetCuttersEnabled | Whether the gem cutters are subtracted from the band |
Every setter regenerates the shank in place, re-baking stones and prongs.
The rail (IPaveShankRail)
| Member | Meaning |
|---|---|
Rows | The gem rows in lateral order - IPaveShankRow each |
Prongs | The prong definitions - IPaveShankProng each |
ProngHeight / ProngDiameter | Global defaults, mm |
ShowProngs | Whether prongs are built |
SetRows(rows) | Replaces the whole row list |
SetRow(index, gemSize, offset, spacing, startAngle, endAngle) | Edits one row in place |
SetProngHeight / SetProngDiameter / SetShowProngs |
A row (IPaveShankRow)
| Member | Meaning |
|---|---|
GemSize | Stone size, mm |
Offset | Lateral offset from the band centre, mm |
Spacing | Gap between adjacent stones, mm |
StartAngle / EndAngle | Where the row runs along the band, degrees |
Mirror | The row is the mirror of its opposite |
A prong (IPaveShankProng)
Read-only. Each prong is tied to a row by index.
| Member | Meaning |
|---|---|
RowIndex | The row it belongs to |
X / Y | Position, mm |
Diameter / Height | mm |
ApplyToAllGems / Mirror / Visible | Flags |