ra.plain_band

Single plain bands.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.PlainBandApi.

Functions

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

ra.plain_band.all()

ra.plain_band.all() -> List[PlainBand]

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

ra.plain_band.by_layer()

ra.plain_band.by_layer(layer_name: str) -> List[PlainBand]

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

Parameter	Type
layer_name	str	required

ra.plain_band.count()

ra.plain_band.count() -> int

Number of objects of this kind in the active document.

ra.plain_band.find()

ra.plain_band.find(id: IdLike) -> PlainBand

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

Parameter	Type
id	IdLike	required

ra.plain_band.selected()

ra.plain_band.selected() -> List[PlainBand]

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

PlainBand (handle)

A single plain band.

Property	Type	Settable
layer_name	str
mother_gem_id	str
object_type	str
position	Point3d
region	str		sizing region, "" when unset
remove_channel	bool	yes	Shared and Scalloped: True leaves out the channel under the stones
ring	WeddingRing
scallop_boolean	bool	yes	Ring.Gems.ProngType Scalloped: True subtracts the cutters, False keeps them as objects
scallop_cutters	ScallopCutters		Scalloped: the cutters under each stone
scallop_v_cutters	ScallopCutters		Scalloped: the V-cutters between the stones (Enabled turns them on)

Method
delete()
move(translation: VectorLike)
set_element(element: str)	Applies a saved PlainBand element (ra.elements.list(“PlainBand”)) 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 plain 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

ScallopCutters (section)

The scalloped cutters (under each stone) or V-cutters (between the stones) of a shank, editable. The members marked “cutters only” read as empty/0 on the V-cutters and refuse a set there. Each setter regenerates the owner in place.

Property	Type	Settable
enabled	bool	yes	V-cutters: whether they are built; the cutters are always on
end_height	float	yes	mm
end_width	float	yes	mm
keep	bool	yes	True = start and end move together (the panel’s Both Sides)
length	float	yes	mm
over_girdle	float	yes	mm, signed
over_girdle_middle	float	yes	cutters only: mm, signed
shape	str	yes	cutters only: U_SHAPE or V_SHAPE
shape_factor	float	yes	cutters only: 0-2
start_height	float	yes	mm
start_width	float	yes	mm

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”; a plain band also “Scalloped”
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”)