Skip to content

Scripting API

ISignetRing

Returned by SignetRingApi — a signet ring: a flat face carried on a band. No gems, so no mother gem. Adds to IParametricObject:

MemberMeaning
RingSizeLabel / RingSizeRegionRing size as label + region
RingDiameterMmInner diameter, mm
FaceThe face and the band under it — ISignetFace

The section is a live view over the ring’s stored parameters: its getters read the current values and every setter regenerates the ring in place (same Guid).

The face (ISignetFace)

Shared with IAdvancedSignetRing — both rings store the same face model.

MemberMeaning
ProfileNameRING_PROFILE asset name, "" when unset
Width / HeightFace size, mm
HeightPositionHow high the face sits over the finger, mm
Rotationdegrees (signed)
TangentTangency of the transition into the band
ShapeMode"Circle" or "Custom"
WidthBottomProfile / HeightBottomProfileBand section at the bottom, mm
WidthMiddleProfile / HeightMiddleProfileBand section at the middle, mm
RecessHollow the back of the face
Thickness / InnerHeightmm — used when Recess is on
SetProfile(assetName)RING_PROFILE asset by name
SetWidth / SetHeight / SetHeightPosition / SetRotation / SetTangentThe face
SetShapeMode"Circle" or "Custom"
SetBottomProfile(width, height) / SetMiddleProfile(width, height)Band sections, in one call each
SetRecess / SetThickness / SetInnerHeightThe recess

String parameters are case-insensitive and tolerate dashes/spaces; an unknown value raises a clear error listing the valid ones.