SignetRingApi

Signet rings — a flat face carried on a band. Create takes the face and band dimensions; the rest is adjusted through the returned handle.

from ArtisanPlugin.Scripting import SignetRingApi

See also the guide, Shanks › Signet, and the Python package, ra.signet_ring.

Methods

Method
All	ISignetRing handles for every object of this kind in the active document (empty when there is no document).
ByLayer	ISignetRing handles on the layer with the given full path (empty when the layer does not exist).
Count	Number of objects of this kind in the active document.
Create	Builds a signet ring — the ArtisanSignetRing tool, headless.
Find	The handle for id, or null when the id does not belong to an object of this kind.
Selected	ISignetRing handles for the objects of this kind currently selected in the active document.

All

IReadOnlyList<ISignetRing> SignetRingApi.All()

ISignetRing handles for every object of this kind in the active document (empty when there is no document).

Returns IReadOnlyList<ISignetRing>.

ByLayer

IReadOnlyList<ISignetRing> SignetRingApi.ByLayer(string layerName)

ISignetRing handles on the layer with the given full path (empty when the layer does not exist).

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<ISignetRing>.

Count

int SignetRingApi.Count()

Number of objects of this kind in the active document.

Returns int.

Create

ISignetRing SignetRingApi.Create(
    double fingerDiameter = 0,
    double width = 0,
    double height = 0,
    double heightPosition = double.NaN,
    double rotation = double.NaN,
    double widthBottomProfile = 0,
    double heightBottomProfile = 0,
    double widthMiddleProfile = 0,
    double heightMiddleProfile = 0,
    bool? recess = null,
    double thickness = 0,
    double innerHeight = 0,
    string profile = null,
    Plane? plane = null,
    string element = null)

Builds a signet ring — the ArtisanSignetRing tool, headless. Millimetres / degrees; 0 keeps the tool default (or the user’s saved defaults). fingerDiameter 0 = the document’s finger size. recess hollows the face; thickness and innerHeight shape that recess. Returns an ISignetRing handle to the new ring. element = name of a saved signet ring element (ElementsApi.List(“SignetRing”)) to start from instead of the tool defaults; explicit arguments override it.

Parameter	Type	Default
fingerDiameter	double	0
width	double	0
height	double	0
heightPosition	double	double.NaN
rotation	double	double.NaN
widthBottomProfile	double	0
heightBottomProfile	double	0
widthMiddleProfile	double	0
heightMiddleProfile	double	0
recess	bool?	null
thickness	double	0
innerHeight	double	0
profile	string	null
plane	Plane?	null
element	string	null

Returns ISignetRing.

Find

ISignetRing SignetRingApi.Find(Guid id)

The handle for id, or null when the id does not belong to an object of this kind.

Parameter	Type	Default
id	Guid	required

Returns ISignetRing.

Selected

IReadOnlyList<ISignetRing> SignetRingApi.Selected()

ISignetRing handles for the objects of this kind currently selected in the active document.

Returns IReadOnlyList<ISignetRing>.

Handles and sections

What the methods above hand back. A handle’s setters regenerate the object; wrap changes in a Transaction so they land as one undo step.

Also used here: ISignetFace.

ISignetRing

Handle — extends IParametricObject.

Signet ring: a flat face carried on a band.

Property	Type
Face	ISignetFace	get
Id	Guid	get	(from IParametricObject)
LayerName	string	get	(from IParametricObject)
MotherGemId	Guid	get	(from IParametricObject)
ObjectType	string	get	(from IParametricObject)
Position	Point3d	get	(from IParametricObject)
RingDiameterMm	double	get
RingSizeLabel	string	get
RingSizeRegion	string	get

Method
void Delete()	(from IParametricObject)
void Move(Vector3d translation)	(from IParametricObject)
void SetElement(string element)	Applies a saved SignetRing element (ElementsApi.List(“SignetRing”)) to this ring: its parameters replace the current ones, the ring size stays, and the ring regenerates in place (same id).