Skip to content

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:

MemberMeaning
RingSizeLabel / RingSizeRegion / RingDiameterMmRing size
CurveThe rail the band is swept along - ISplitShankCurve
SectionsThe three swept profiles in rail order - ISplitShankSection each
GemsThe 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)

MemberMeaning
ArmHeightRise of the arm tips above the ring top, mm
ArmAngledegrees
ArmOffsetExtra outward bulge beyond the reference shape, mm (signed)
Tangent / TopTangencyTangency controls
OpeningLengthmm
SplitWidthSeparation between the front and back arm pairs, mm
SplitStartWhere along the rail the split begins, 0..1
LateralDisplacementY displacement of the arm tips, mm (signed)
LateralInclinationInclination of the arms along the finger axis, degrees (signed)
SetArmHeight, SetArmAngle, SetArmOffset, SetTangent, SetTopTangencyThe arms
SetOpeningLength, SetSplitWidth, SetSplitStartThe split
SetLateralDisplacement, SetLateralInclinationThe 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.

MemberMeaning
PositionT along the rail: 0 = ring bottom, 1 = arm tip
EnabledWhether the section is swept
ProfileNameRING_PROFILE asset name, "" when unset
Type"SOLID", "COMFORT" or "THICKNESS"
Width / Height / Thickness / ComfortSection dimensions, mm
Rotation / Displacement / OrientationProfile placement

The pave run (ISplitShankGems)

MemberMeaning
Enabled / ShapeWhether the run is built, and the stone shape
TopSize / BottomSizeStone size at the arm tip and at the ring bottom, mm
ShankSize / TransitionSizemm
ArmSpacing / ShankSpacing / MinDistanceSpacing per zone, mm
Angle / Margin / InnerMargin / Vertical / MoveInZ / GemInsidePlacement
InnerWidth / InnerHeight / BrightCutChannel, mm
ProngType / ProngHeight / ProngDiameter / AutomaticProngDiameterProngs
DrillType"NONE", "ROUND" or "QUAD"
ChannelShape / ChannelClearanceThe channel the stones sit in
FlipStart / FlipEnd / VCuttersRun ends and V-cutters
StartOffset / EndOffsetmm
SetSizes(topSize, bottomSize), SetSpacing(armSpacing, shankSpacing), SetOffsets(start, end)Paired setters
Plus one setter per remaining member