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:
| Member | Meaning |
|---|---|
RingSizeLabel / RingSizeRegion / RingDiameterMm | Ring size |
Shank | The band - IGraduatedShank |
Gems | The stone run - IGraduatedGems |
Every setter regenerates the shank in place, re-baking stones, prongs and the under-bezel rail.
The band (IGraduatedShank)
| Member | Meaning |
|---|---|
TopProfile / BottomProfile | The two profiles the section morphs between - IGraduatedProfile each |
CutBumping / OpeningMargin | mm |
SetCutBumping / SetOpeningMargin |
A profile (IGraduatedProfile)
| Member | Meaning |
|---|---|
Enabled / ProfileName / Type | Whether it is used, its RING_PROFILE asset, and how the curve is closed ("SOLID", "COMFORT", "THICKNESS") |
Width / Height / Thickness / Comfort | mm |
Rotation / Displacement / Orientation | Profile 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.
| Member | Meaning |
|---|---|
Enabled / GemShape | |
NumberOfStones | Per side |
SizeStart / SizeEnd | Stone size at each end of the run, mm |
Distance | Gap between adjacent stones, mm |
CenterStoneSize | mm |
Lift / Vertical / GemInside | Placement, mm |
GemMoveInZStart / GemMoveInZEnd | mm |
InnerWidth / InnerHeight / BrightCut | Channel, mm |
ProngsEnabled / ProngType / ProngCutByRingSize | The prongs |
ProngHeightStart / ProngHeightEnd | mm |
ProngOverGirdleStart / ProngOverGirdleEnd | mm |
AutomaticProngDiameter / ProngDiameterStart / ProngDiameterEnd | mm |
ProngSeparationStart / ProngSeparationEnd | mm |
ProngMoveInZ / ProngGrow / ProngMinDiameter / EndProngCount / ProngSpacing / ProngDistance | Prong layout |
UnderBezelEnabled | The rail under the stones |
UnderBezelWidth / UnderBezelHeight / UnderBezelOverGirdle / UnderBezelGirdleWidth / UnderBezelBottomWidth / UnderBezelGemInside | The rail, mm - height 0 means auto (drop to the finger curve) |
DrillType / DrillWidth / DrillHeight / DrillAllowIntersection | Drills |
ExtensionForManufacturing | mm |
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 |