Skip to content

Scripting API

IPaveShank

Returned by PaveShankApi and PaveShankBuilderApi.Create - a classic band with one profile and one size, carrying N automatic rows of pavé stones on its outer surface. Multiple gems, so no single mother gem. Adds to IParametricObject:

MemberMeaning
RingSizeLabel / RingSizeRegion / RingDiameterMmRing size
TopProfileThe band section - IClassicProfile. The band has one profile and one size, so there is no mid, bottom or external profile
AdvancedThe band opening - IClassicAdvanced
RowsHow many rows, how far apart and where they run - IPaveShankRows
ProngThe bead prongs - IPaveShankProng
GemsThe stones - IClassicGems. GemSize is the central size
GemsEnabled / SetGemsEnabledMaster toggle for the stones
CuttersEnabled / SetCuttersEnabledWhether the gem drill cutters are built
SetElement(element)Applies a saved MultiRowShank element; the ring size stays

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

From Gems, these are the ones that matter here: GemSize (central stones), MinDistance (gap along a row), Vertical (how deep the stones sit), TypeProng ("NONE" or "SHARED"), ProngHeight (bead length), ProngMoveInZ (how far the top of the bead sits above the girdle), GemInside and ExtensionForManufacturing. AutomaticProngDiameter and ProngDiameter are ignored: the bead size is Prong.Diameter.

Rows (IPaveShankRows)

MemberMeaning
CountRows across the band, 1 to 9. With 3 or more, the two outermost rows are lateral and the rest central
DistanceGap between the stones of two neighbouring rows, mm (edge to edge). The row pitch is automatic
LateralGemSizeStone size of the two outermost rows, mm (3 or more rows)
LayoutMode"FULL", "SIDE_ANGLE" or "TOP_ANGLE"
StartAngle / EndAngleDegrees - used with "SIDE_ANGLE"
TopAngleTotal arc in degrees - used with "TOP_ANGLE"
SetCount, SetDistance, SetLateralGemSizeThe rows
SetLayoutMode, SetSideAngles(start, end), SetTopAngleWhere the rows run

Neighbouring rows are always staggered, so every stone sits in the hollows of the next row. The full rows carry the stations and the staggered ones sit between them: with 3 rows the central row is full and the laterals have one stone fewer; with 5 rows, rows 2 and 4 are full, the middle row has one stone more and the laterals one fewer.

Beads (IPaveShankProng)

MemberMeaning
DiameterDiameter of every bead, mm - they all share one size
EdgeOffsetHow far the beads on the band edges are pushed outward, mm; negative pulls them in
EndOffsetHow far the bead past the last stone of each row is moved along the row, mm; negative pulls it in over the stone
SetDiameter, SetEdgeOffset, SetEndOffset

There is one bead in every hollow between stones, centred in it whatever its size. Changing Diameter makes the beads bite more or less into the stones without moving them.