Python package

ra.wedding_band

Single wedding bands.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.WeddingBandApi.

Functions

Function
`all()`	`WeddingBand` handles for every object of this kind in the active document (empty when there is no document).
`by_layer()`	`WeddingBand` 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()`	`WeddingBand` handles for the objects of this kind currently selected in the active document.

ra.wedding_band.all() -> List[WeddingBand]

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

ra.wedding_band.by_layer(layer_name: str) -> List[WeddingBand]

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

Parameter	Type
`layer_name`	`str`	required

ra.wedding_band.count() -> int

Number of objects of this kind in the active document.

ra.wedding_band.find(id: IdLike) -> WeddingBand

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_band.selected() -> List[WeddingBand]

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

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

A single wedding band.

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

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

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

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”)