Scripting API
Signet
from ArtisanPlugin.Scripting import SignetRingApi as signet, AdvancedSignetRingApi as advsignet
A signet ring: a flat face carried on a band. Two variants - the classic one, and an advanced one that adds a lateral profile and a wedge cut.
Create
Neither has a Create yet. Run ArtisanSignetRing or ArtisanAdvancedSignetRing in the UI once, then script every variant from the handle.
Edit
Both handles share the same Face section, because both rings store the same face model:
Member of Face | What it edits |
|---|---|
| Face | Profile asset, width, height, height over the finger, rotation, tangent, shape mode (circle or custom) |
| Band | Bottom and middle sections, set in one call each |
| Recess | Whether the back of the face is hollowed, plus thickness and inner height |
from ArtisanPlugin.Scripting import SignetRingApi as signet, Transaction
ring = signet.Selected()[0]
with Transaction.Begin("Bigger oval face, hollowed"):
ring.Face.SetWidth(11.0)
ring.Face.SetHeight(9.0)
ring.Face.SetRecess(True)
See ISignetRing for the full member list.
Advanced signet
IAdvancedSignetRing adds two members on top of the same Face:
| Member | Meaning |
|---|---|
LateralProfileName / SetLateralProfile(assetName) | The RING_SIDE_CURVE asset that shapes the sides |
BottomCutAngle / SetBottomCutAngle(degrees) | Total opening of the wedge cut at the bottom of the band; 0 = no cut |
Queries
Both facades: All(), Find(id), Count(), Selected(), ByLayer(name).