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:
| Member | Meaning |
|---|---|
RingSizeLabel / RingSizeRegion | Ring size as label + region |
RingDiameterMm | Inner diameter, mm |
Face | The 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.
| Member | Meaning |
|---|---|
ProfileName | RING_PROFILE asset name, "" when unset |
Width / Height | Face size, mm |
HeightPosition | How high the face sits over the finger, mm |
Rotation | degrees (signed) |
Tangent | Tangency of the transition into the band |
ShapeMode | "Circle" or "Custom" |
WidthBottomProfile / HeightBottomProfile | Band section at the bottom, mm |
WidthMiddleProfile / HeightMiddleProfile | Band section at the middle, mm |
Recess | Hollow the back of the face |
Thickness / InnerHeight | mm — used when Recess is on |
SetProfile(assetName) | RING_PROFILE asset by name |
SetWidth / SetHeight / SetHeightPosition / SetRotation / SetTangent | The face |
SetShapeMode | "Circle" or "Custom" |
SetBottomProfile(width, height) / SetMiddleProfile(width, height) | Band sections, in one call each |
SetRecess / SetThickness / SetInnerHeight | The recess |
String parameters are case-insensitive and tolerate dashes/spaces; an unknown value raises a clear error listing the valid ones.