Scripting API
ISplitShank
Returned by SplitShankApi - a cathedral-style band that opens into two arms toward the setting. Multiple gems, so no single mother gem. Adds to IParametricObject:
| Member | Meaning |
|---|---|
RingSizeLabel / RingSizeRegion / RingDiameterMm | Ring size |
Curve | The rail the band is swept along - ISplitShankCurve |
Sections | The three swept profiles in rail order - ISplitShankSection each |
Gems | The pave run along the arms - ISplitShankGems |
SetSection(index, position, width, height, type=None, profileName=None) | Edits one section in place |
SetSectionEnabled(index, enabled) | Toggles one section |
Every setter regenerates the shank in place (same Guid).
The rail (ISplitShankCurve)
| Member | Meaning |
|---|---|
ArmHeight | Rise of the arm tips above the ring top, mm |
ArmAngle | degrees |
ArmOffset | Extra outward bulge beyond the reference shape, mm (signed) |
Tangent / TopTangency | Tangency controls |
OpeningLength | mm |
SplitWidth | Separation between the front and back arm pairs, mm |
SplitStart | Where along the rail the split begins, 0..1 |
LateralDisplacement | Y displacement of the arm tips, mm (signed) |
LateralInclination | Inclination of the arms along the finger axis, degrees (signed) |
SetArmHeight, SetArmAngle, SetArmOffset, SetTangent, SetTopTangency | The arms |
SetOpeningLength, SetSplitWidth, SetSplitStart | The split |
SetLateralDisplacement, SetLateralInclination | The lateral shape |
A section (ISplitShankSection)
Read-only values; edit them through SetSection on the handle. The list is ordered bottom (Position 0) to arm tip (Position 1), and a split shank always keeps exactly three.
| Member | Meaning |
|---|---|
Position | T along the rail: 0 = ring bottom, 1 = arm tip |
Enabled | Whether the section is swept |
ProfileName | RING_PROFILE asset name, "" when unset |
Type | "SOLID", "COMFORT" or "THICKNESS" |
Width / Height / Thickness / Comfort | Section dimensions, mm |
Rotation / Displacement / Orientation | Profile placement |
The pave run (ISplitShankGems)
| Member | Meaning |
|---|---|
Enabled / Shape | Whether the run is built, and the stone shape |
TopSize / BottomSize | Stone size at the arm tip and at the ring bottom, mm |
ShankSize / TransitionSize | mm |
ArmSpacing / ShankSpacing / MinDistance | Spacing per zone, mm |
Angle / Margin / InnerMargin / Vertical / MoveInZ / GemInside | Placement |
InnerWidth / InnerHeight / BrightCut | Channel, mm |
ProngType / ProngHeight / ProngDiameter / AutomaticProngDiameter | Prongs |
DrillType | "NONE", "ROUND" or "QUAD" |
ChannelShape / ChannelClearance | The channel the stones sit in |
FlipStart / FlipEnd / VCutters | Run ends and V-cutters |
StartOffset / EndOffset | mm |
SetSizes(topSize, bottomSize), SetSpacing(armSpacing, shankSpacing), SetOffsets(start, end) | Paired setters |
| Plus one setter per remaining member |