Skip to content

Python package

ra.advanced_signet_ring

Signet rings with independent top and side profiles.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.AdvancedSignetRingApi.

Functions

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

ra.advanced_signet_ring.all()

ra.advanced_signet_ring.all() -> List[AdvancedSignetRing]

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

ra.advanced_signet_ring.by_layer()

ra.advanced_signet_ring.by_layer(layer_name: str) -> List[AdvancedSignetRing]

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

ParameterType
layer_namestrrequired

ra.advanced_signet_ring.count()

ra.advanced_signet_ring.count() -> int

Number of objects of this kind in the active document.

ra.advanced_signet_ring.find()

ra.advanced_signet_ring.find(id: IdLike) -> AdvancedSignetRing

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

ParameterType
idIdLikerequired

ra.advanced_signet_ring.selected()

ra.advanced_signet_ring.selected() -> List[AdvancedSignetRing]

AdvancedSignetRing 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().

AdvancedSignetRing (handle)

Advanced signet ring: the same face, plus a lateral profile that shapes the sides and an optional wedge cut at the bottom of the band.

PropertyTypeSettable
bottom_cut_anglefloatyestotal opening of the bottom wedge cut, degrees; 0 = no cut
faceSignetFace
lateral_profile_namestrasset shaping the sides, "" when unset
layer_namestr
mother_gem_idstr
object_typestr
positionPoint3d
ring_diameter_mmfloat
ring_size_labelstr
ring_size_regionstr
Method
delete()
move(translation: VectorLike)
set_element(element: str)Applies a saved AdvancedSignetRing element (ra.elements.list(“AdvancedSignetRing”)) to this ring: its parameters replace the current ones, the ring size stays, and the ring regenerates in place (same id).
set_lateral_profile(asset_name: str)

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.

PropertyTypeSettable
heightfloatyesface height, mm
height_bottom_profilefloatmm
height_middle_profilefloatmm
height_positionfloatyeshow high the face sits over the finger, mm
inner_heightfloatyesmm — used when Recess is on
profile_namestrRING_PROFILE asset name, "" when unset
recessboolyeshollow the back of the face
rotationfloatyesdegrees
shape_modestryes”Circle” or “Custom”
tangentfloatyes
thicknessfloatyesmm — used when Recess is on
widthfloatyesface width, mm
width_bottom_profilefloatband section at the bottom, mm
width_middle_profilefloatband 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”)