ra.wedding

Wedding sets (band pairs) built as one editable object.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.WeddingApi, ArtisanPlugin.Scripting.WeddingBuilderApi.

Functions

Function
all()	Wedding handles for every object of this kind in the active document (empty when there is no document).
by_layer()	Wedding 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()	Wedding handles for the objects of this kind currently selected in the active document.
create_band()	Builds a single wedding band (the ArtisanWeddingBand tool, headless): a plain band lofted from a RING_PROFILE asset at the document’s finger size, optionally with a row of stones around it.
create_set()	Builds a wedding set (the ArtisanWeddingRing tool, headless): two bands baked together as one group — his and hers — each with its own section, metal, finger size and optional stones.

ra.wedding.all()

ra.wedding.all() -> List[Wedding]

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

ra.wedding.by_layer()

ra.wedding.by_layer(layer_name: str) -> List[Wedding]

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

Parameter	Type
layer_name	str	required

ra.wedding.count()

ra.wedding.count() -> int

Number of objects of this kind in the active document.

ra.wedding.find()

ra.wedding.find(id: IdLike) -> Wedding

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

Parameter	Type
id	IdLike	required

ra.wedding.selected()

ra.wedding.selected() -> List[Wedding]

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

ra.wedding.create_band()

ra.wedding.create_band(width=None, height=None, finger_diameter=None, profile=None, metal=None, with_gems=None, gem_size=None, gem_shape=None, distribution=None, number_of_gems=None, prong_type=None, plane=None, element=None) -> WeddingBand

Builds a single wedding band (the ArtisanWeddingBand tool, headless): a plain band lofted from a RING_PROFILE asset at the document’s finger size, optionally with a row of stones around it. Millimetres; omitting keeps the tool default: width 3, height 2. finger_diameter 0 = the document’s finger size. profile picks a RING_PROFILE asset by name (omitted = the default profile); metal a Metal name like “GOLD_YELLOW_18” (omitted = the document’s Metal 01). with_gems True enables the stones: gem_size (default 1.2), gem_shape “Round” | “Princess”, distribution “Full” | “Half” | “Onequarter” | “Custom” (+ number_of_gems), prong_type “None” | “Shared” | “Channel”. plane omitted = world XY. Returns the WeddingBand handle of the new band group. element = name of a saved element (ra.elements.list) to start from; explicit arguments override it.

Parameter	Type
width	float	optional — None = the tool default
height	float	optional — None = the tool default
finger_diameter	float	optional — None = the tool default
profile	str	optional — None = the tool default
metal	str	optional — None = the tool default
with_gems	bool	optional — None = the tool default
gem_size	float	optional — None = the tool default
gem_shape	str	optional — None = the tool default
distribution	str	optional — None = the tool default
number_of_gems	int	optional — None = the tool default
prong_type	str	optional — None = the tool default
plane	Optional[PlaneLike]	optional — None = the tool default
element	str	optional — None = the tool default

ra.wedding.create_set()

ra.wedding.create_set(width=None, height=None, second_width=None, second_height=None, finger_diameter=None, second_finger_diameter=None, profile=None, second_profile=None, metal=None, second_metal=None, with_gems=None, gem_size=None, second_with_gems=None, second_gem_size=None, plane=None) -> Wedding

Builds a wedding set (the ArtisanWeddingRing tool, headless): two bands baked together as one group — his and hers — each with its own section, metal, finger size and optional stones. Millimetres; omitting keeps the tool default (width 3, height 2 for both). finger_diameter / second_finger_diameter 0 = the document’s finger size. profile / second_profile pick RING_PROFILE assets by name (omitted = the default profile); metal / second_metal are Metal names (omitted = the document’s Metal 01). with_gems + gem_size (and the second* pair) add a full row of round stones to that ring. plane omitted = world XY. Returns the Wedding handle of the new set (FirstRing / SecondRing).

Parameter	Type
width	float	optional — None = the tool default
height	float	optional — None = the tool default
second_width	float	optional — None = the tool default
second_height	float	optional — None = the tool default
finger_diameter	float	optional — None = the tool default
second_finger_diameter	float	optional — None = the tool default
profile	str	optional — None = the tool default
second_profile	str	optional — None = the tool default
metal	str	optional — None = the tool default
second_metal	str	optional — None = the tool default
with_gems	bool	optional — None = the tool default
gem_size	float	optional — None = the tool default
second_with_gems	bool	optional — None = the tool default
second_gem_size	float	optional — None = the tool default
plane	Optional[PlaneLike]	optional — None = the tool default

Handles

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

Wedding (handle)

A wedding set: the two rings baked together as one group.

Property	Type	Settable
first_ring	WeddingRing
layer_name	str
mother_gem_id	str
object_type	str
position	Point3d
region	str		sizing region of the set, "" when unset
second_ring	WeddingRing

Method
delete()
move(translation: VectorLike)

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

WeddingBand (handle)

A single wedding band.

Property	Type	Settable
layer_name	str
mother_gem_id	str
object_type	str
position	Point3d
region	str		sizing region, "" when unset
ring	WeddingRing

Method
delete()
move(translation: VectorLike)
set_element(element: str)	Applies a saved WeddingBand element (ra.elements.list(“WeddingBand”)) to this band: its profile, gems and metal replace the current ones, the ring size stays, and the band 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).

WeddingRing (section)

One ring of a wedding set, or the single band of a wedding band.

Property	Type	Settable
gems	WeddingGems
metal	str	yes	e.g. “GOLD_YELLOW_18”
profile	WeddingProfile
ring_diameter_mm	float
ring_size_label	str
ring_size_region	str

WeddingGems (section)

The stones a wedding ring can carry around its band.

Property	Type	Settable
automatic_prong_diameter	bool	yes
custom_distance	str	yes	”Continuous” or “Equidistant”
distribution	str	yes	”Full”, “Half”, “Onequarter” or “Custom”
drill_height	float	yes	mm
drill_type	str	yes	”NONE”, “ROUND” or “QUAD”
drill_width	float	yes	mm
enabled	bool	yes
extension_manufacturing	float	yes	mm
gem_inside	float	yes	mm
gem_size	float	yes	mm
inner_height	float	yes	inner channel height, mm
inner_width	float	yes	inner channel width, mm
min_distance	float	yes	mm
number_of_gems	int	yes	used when Distribution is “Custom”
prong_diameter	float	yes	mm
prong_height	float	yes	mm
prong_move_in_z	float	yes	mm
prong_type	str	yes	”None”, “Shared” or “Channel”
shape	str	yes	”Round” or “Princess”
vertical	float	yes	mm

WeddingProfile (section)

The band section of a wedding ring: its section and profile asset.

Property	Type	Settable
height	float	yes	mm
profile_name	str		RING_PROFILE asset name, "" when unset
width	float	yes	mm

Method
set_profile(asset_name: str)	list them with ra.assets.list(“RING_PROFILE”)