Skip to content

Scripting API

IHalo

Returned by HaloApi — a halo of small stones around one center gem. Adds to IGemSetting:

MemberMeaning
HaloStoneCountNumber of stones forming the halo ring
HaloStoneSizeSize of each halo stone, mm
HaloStoneWeightCarat weight of one halo stone
HaloTotalWeightTotal carat weight of the halo stones
SetStoneSize(stoneSize)Halo stone size, mm
SetStoneDistance(stoneDistance)Distance between stones, mm
AutomaticSharedProngDistance / SharedProngDistanceShared prongs (StoneSetting "SHARED"): true, the two prongs of a gap sit where they fit tangent to the stones and the channel edges; false, at SharedProngDistance mm centre to centre, 0 = one prong per gap on the centre line. SetAutomaticSharedProngDistance / SetSharedProngDistance (the Prong… members are the centre stone’s prongs)

Each setter regenerates the halo: the group keeps its id, the member objects are rebuilt.