Skip to content

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:

MemberMeaning
RingSizeLabel / RingSizeRegion / RingDiameterMmRing size
TopProfile / MidProfile / BottomProfileThe band sections - IClassicProfile each
ExternalProfileThe outside-face profile - IClassicExternalProfile
AdvancedThe band opening - IClassicAdvanced
RailThe channel - ITwoRowsRail
ProngThe prong cross-section - ITwoRowsProng
GemsThe stones on the rails - IClassicGems
GemsEnabled / SetGemsEnabledMaster toggle for the stones
CuttersEnabled / SetCuttersEnabledWhether 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)

MemberMeaning
LayoutMode"FULL", "SIDE_ANGLE" or "TOP_ANGLE"
StartAngle / EndAngleDegrees - used with "SIDE_ANGLE"
TopAngleTotal arc in degrees - used with "TOP_ANGLE"
WidthSpan of the channel along the face, mm
OffsetDepth carved into the band, mm
FitTolerance / Rotationmm / degrees
RailMode"DOUBLE" (one cutter per row) or "SINGLE" (one wider cutter)
CutOrientation"ANGLED" (follows the face) or "HORIZONTAL"; single mode is always horizontal
CentralWallMetal left between the two rows in double mode, mm
OuterBorderSingle mode: metal rim on each side of the band, mm
RowSpacingGap between the two gem rows, mm
EndMarginGap between the channel end and the first/last gem, mm
SetLayoutMode, SetSideAngles(start, end), SetTopAngleWhere the channel runs
SetWidth, SetOffset, SetFitTolerance, SetRotationThe channel section
SetRailMode, SetCutOrientationHow it is cut
SetCentralWall, SetOuterBorder, SetRowSpacing, SetEndMarginThe metal around the rows

Prongs (ITwoRowsProng)

MemberMeaning
ExternalDiameter / InternalDiametermm
Distancemm
EndProngCountProngs added at each end of a row
SetExternalDiameter, SetInternalDiameter, SetDistance, SetEndProngCount