Scripting API
ITwoRowsShank
Returned by TwoRowsShankApi - a classic band with a channel carved on each face, carrying two parallel rows of stones. Multiple gems, so no single mother gem. Adds to IParametricObject:
| Member | Meaning |
|---|---|
RingSizeLabel / RingSizeRegion / RingDiameterMm | Ring size |
TopProfile / MidProfile / BottomProfile | The band sections - IClassicProfile each |
ExternalProfile | The outside-face profile - IClassicExternalProfile |
Advanced | The band opening - IClassicAdvanced |
Rail | The channel - ITwoRowsRail |
Prong | The prong cross-section - ITwoRowsProng |
Gems | The stones on the rails - IClassicGems |
GemsEnabled / SetGemsEnabled | Master toggle for the stones |
CuttersEnabled / SetCuttersEnabled | Whether the gem drill cutters are built |
The band reuses the classic sections outright, so anything you know from IClassic applies here. Every setter regenerates the shank in place, re-baking stones, prongs and cutters.
The channel (ITwoRowsRail)
| Member | Meaning |
|---|---|
LayoutMode | "FULL", "SIDE_ANGLE" or "TOP_ANGLE" |
StartAngle / EndAngle | Degrees - used with "SIDE_ANGLE" |
TopAngle | Total arc in degrees - used with "TOP_ANGLE" |
Width | Span of the channel along the face, mm |
Offset | Depth carved into the band, mm |
FitTolerance / Rotation | mm / degrees |
RailMode | "DOUBLE" (one cutter per row) or "SINGLE" (one wider cutter) |
CutOrientation | "ANGLED" (follows the face) or "HORIZONTAL"; single mode is always horizontal |
CentralWall | Metal left between the two rows in double mode, mm |
OuterBorder | Single mode: metal rim on each side of the band, mm |
RowSpacing | Gap between the two gem rows, mm |
EndMargin | Gap between the channel end and the first/last gem, mm |
SetLayoutMode, SetSideAngles(start, end), SetTopAngle | Where the channel runs |
SetWidth, SetOffset, SetFitTolerance, SetRotation | The channel section |
SetRailMode, SetCutOrientation | How it is cut |
SetCentralWall, SetOuterBorder, SetRowSpacing, SetEndMargin | The metal around the rows |
Prongs (ITwoRowsProng)
| Member | Meaning |
|---|---|
ExternalDiameter / InternalDiameter | mm |
Distance | mm |
EndProngCount | Prongs added at each end of a row |
SetExternalDiameter, SetInternalDiameter, SetDistance, SetEndProngCount |