Skip to content

Scripting API

IGraduated

Returned by GraduatedApi - a band whose section grows toward the centre stone, carrying a run of stones that shrink toward the finger. Multiple gems, so no single mother gem. Adds to IParametricObject:

MemberMeaning
RingSizeLabel / RingSizeRegion / RingDiameterMmRing size
ShankThe band - IGraduatedShank
GemsThe stone run - IGraduatedGems

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

The band (IGraduatedShank)

MemberMeaning
TopProfile / BottomProfileThe two profiles the section morphs between - IGraduatedProfile each
CutBumping / OpeningMarginmm
SetCutBumping / SetOpeningMargin

A profile (IGraduatedProfile)

MemberMeaning
Enabled / ProfileName / TypeWhether it is used, its RING_PROFILE asset, and how the curve is closed ("SOLID", "COMFORT", "THICKNESS")
Width / Height / Thickness / Comfortmm
Rotation / Displacement / OrientationProfile placement
SetEnabled, SetProfile, SetType, SetWidth, SetHeight, SetThickness, SetComfort, SetRotation, SetDisplacement, SetOrientation

The stone run (IGraduatedGems)

Most sizes come as start/end pairs: start is nearest the centre stone, end nearest the band.

MemberMeaning
Enabled / GemShape
NumberOfStonesPer side
SizeStart / SizeEndStone size at each end of the run, mm
DistanceGap between adjacent stones, mm
CenterStoneSizemm
Lift / Vertical / GemInsidePlacement, mm
GemMoveInZStart / GemMoveInZEndmm
InnerWidth / InnerHeight / BrightCutChannel, mm
ProngsEnabled / ProngType / ProngCutByRingSizeThe prongs
ProngHeightStart / ProngHeightEndmm
ProngOverGirdleStart / ProngOverGirdleEndmm
AutomaticProngDiameter / ProngDiameterStart / ProngDiameterEndmm
ProngSeparationStart / ProngSeparationEndmm
ProngMoveInZ / ProngGrow / ProngMinDiameter / EndProngCount / ProngSpacing / ProngDistanceProng layout
UnderBezelEnabledThe rail under the stones
UnderBezelWidth / UnderBezelHeight / UnderBezelOverGirdle / UnderBezelGirdleWidth / UnderBezelBottomWidth / UnderBezelGemInsideThe rail, mm - height 0 means auto (drop to the finger curve)
DrillType / DrillWidth / DrillHeight / DrillAllowIntersectionDrills
ExtensionForManufacturingmm
SetSizes(start, end), SetProngHeights(start, end), SetProngDiameters(start, end), SetProngSeparation(start, end), SetProngOverGirdle(start, end), SetGemMoveInZ(start, end)The paired setters
Plus one setter per remaining member