Skip to content

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:

MemberMeaning
RingSizeLabel / RingSizeRegion / RingDiameterMmRing size
TopProfileThe band section - IClassicProfile
AdvancedThe band opening - IClassicAdvanced
RailThe rows and prongs - IPaveShankRail
CuttersEnabled / SetCuttersEnabledWhether the gem cutters are subtracted from the band

Every setter regenerates the shank in place, re-baking stones and prongs.

The rail (IPaveShankRail)

MemberMeaning
RowsThe gem rows in lateral order - IPaveShankRow each
ProngsThe prong definitions - IPaveShankProng each
ProngHeight / ProngDiameterGlobal defaults, mm
ShowProngsWhether 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)

MemberMeaning
GemSizeStone size, mm
OffsetLateral offset from the band centre, mm
SpacingGap between adjacent stones, mm
StartAngle / EndAngleWhere the row runs along the band, degrees
MirrorThe row is the mirror of its opposite

A prong (IPaveShankProng)

Read-only. Each prong is tied to a row by index.

MemberMeaning
RowIndexThe row it belongs to
X / YPosition, mm
Diameter / Heightmm
ApplyToAllGems / Mirror / VisibleFlags