Python package

ra.signet_ring

Signet rings with a shaped top face.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.SignetRingApi.

Functions

Function
`all()`	`SignetRing` handles for every object of this kind in the active document (empty when there is no document).
`by_layer()`	`SignetRing` 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 None when the id does not belong to an object of this kind.
`selected()`	`SignetRing` handles for the objects of this kind currently selected in the active document.

ra.signet_ring.all()

ra.signet_ring.all() -> List[SignetRing]

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

ra.signet_ring.by_layer()

ra.signet_ring.by_layer(layer_name: str) -> List[SignetRing]

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

Parameter	Type
`layer_name`	`str`	required

ra.signet_ring.count()

ra.signet_ring.count() -> int

Number of objects of this kind in the active document.

ra.signet_ring.create()

ra.signet_ring.create(finger_diameter=None, width=None, height=None, height_position=None, rotation=None, width_bottom_profile=None, height_bottom_profile=None, width_middle_profile=None, height_middle_profile=None, recess=None, thickness=None, inner_height=None, profile=None, plane=None, element=None) -> SignetRing

Builds a signet ring — the ArtisanSignetRing tool, headless. Millimetres / degrees; omitting keeps the tool default (or the user’s saved defaults). finger_diameter 0 = the document’s finger size. recess hollows the face; thickness and inner_height shape that recess. Returns an SignetRing handle to the new ring. element = name of a saved element (ra.elements.list) to start from; explicit arguments override it.

Parameter	Type
`finger_diameter`	`float`	optional — None = the tool default
`width`	`float`	optional — None = the tool default
`height`	`float`	optional — None = the tool default
`height_position`	`float`	optional — None = the tool default
`rotation`	`float`	optional — None = the tool default
`width_bottom_profile`	`float`	optional — None = the tool default
`height_bottom_profile`	`float`	optional — None = the tool default
`width_middle_profile`	`float`	optional — None = the tool default
`height_middle_profile`	`float`	optional — None = the tool default
`recess`	`Optional[bool]`	optional — None = the tool default
`thickness`	`float`	optional — None = the tool default
`inner_height`	`float`	optional — None = the tool default
`profile`	`str`	optional — None = the tool default
`plane`	`Optional[PlaneLike]`	optional — None = the tool default
`element`	`str`	optional — None = the tool default

ra.signet_ring.find()

ra.signet_ring.find(id: IdLike) -> SignetRing

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

Parameter	Type
`id`	`IdLike`	required

ra.signet_ring.selected()

ra.signet_ring.selected() -> List[SignetRing]

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

Handles

Objects returned by the functions above. Assigning a settable property regenerates the object; the change is one undo step inside ra.transaction().

SignetRing (handle)

Signet ring: a flat face carried on a band.

Property	Type	Settable
`face`	SignetFace
`layer_name`	`str`
`mother_gem_id`	`str`
`object_type`	`str`
`position`	`Point3d`
`ring_diameter_mm`	`float`
`ring_size_label`	`str`
`ring_size_region`	`str`

Method
`delete()`
`move(translation: VectorLike)`
`set_element(element: str)`	Applies a saved SignetRing element (ra.elements.list(“SignetRing”)) to this ring: its parameters replace the current ones, the ring size stays, and the ring regenerates in place (same id).

Plus what every handle has: id, delete(), update(**kwargs), parameters(), equality and hashing by id, and raw (the underlying .NET object).

SignetFace (section)

The signet face and the band under it — shared by the classic signet and the advanced one. A live view over the ring’s stored parameters: getters read the current values, setters regenerate the ring in place (same Guid) and are license-gated.

Property	Type	Settable
`height`	`float`	yes	face height, mm
`height_bottom_profile`	`float`		mm
`height_middle_profile`	`float`		mm
`height_position`	`float`	yes	how high the face sits over the finger, mm
`inner_height`	`float`	yes	mm — used when Recess is on
`profile_name`	`str`		RING_PROFILE asset name, "" when unset
`recess`	`bool`	yes	hollow the back of the face
`rotation`	`float`	yes	degrees
`shape_mode`	`str`	yes	”Circle” or “Custom”
`tangent`	`float`	yes
`thickness`	`float`	yes	mm — used when Recess is on
`width`	`float`	yes	face width, mm
`width_bottom_profile`	`float`		band section at the bottom, mm
`width_middle_profile`	`float`		band section at the middle, mm

Method
`set_bottom_profile(width: float, height: float)`
`set_middle_profile(width: float, height: float)`
`set_profile(asset_name: str)`	RING_PROFILE asset by name — list them with ra.assets.list(“RING_PROFILE”)