ra.graduated

Graduated shanks: a run of stones shrinking away from the centre.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.GraduatedApi.

Functions

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

ra.graduated.all()

ra.graduated.all() -> List[Graduated]

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

ra.graduated.by_layer()

ra.graduated.by_layer(layer_name: str) -> List[Graduated]

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

Parameter	Type
layer_name	str	required

ra.graduated.count()

ra.graduated.count() -> int

Number of objects of this kind in the active document.

ra.graduated.create()

ra.graduated.create(finger_diameter=None, number_of_stones=None, size_start=None, size_end=None, center_stone_size=None, top_width=None, top_height=None, bottom_width=None, bottom_height=None, profile=None, plane=None, element=None) -> Graduated

Builds a graduated shank — the ArtisanGraduated tool, headless. Millimetres; omitting keeps the tool default (or the user’s saved defaults): number_of_stones 4 per side, size_start 2.5, size_end 1.5, center_stone_size 6.1, top profile 1.5 x 1.6, bottom profile 3.0 x 1.6. finger_diameter 0 = the document’s finger size. profile picks a RING_PROFILE asset by name for both band sections. Returns an Graduated handle: use handle.Shank / handle.Gems to adjust the rest of the parameters. 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
number_of_stones	int	optional — None = the tool default
size_start	float	optional — None = the tool default
size_end	float	optional — None = the tool default
center_stone_size	float	optional — None = the tool default
top_width	float	optional — None = the tool default
top_height	float	optional — None = the tool default
bottom_width	float	optional — None = the tool default
bottom_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.graduated.find()

ra.graduated.find(id: IdLike) -> Graduated

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

Parameter	Type
id	IdLike	required

ra.graduated.selected()

ra.graduated.selected() -> List[Graduated]

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

Graduated (handle)

Graduated shank: a band whose section grows from the centre stone down toward the finger, carrying a run of stones that shrink along the way. Multiple gems, so no single MotherGem.

Property	Type	Settable
gems	GraduatedGems
layer_name	str
mother_gem_id	str
object_type	str
position	Point3d
ring_diameter_mm	float
ring_size_label	str
ring_size_region	str
shank	GraduatedShank

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

GraduatedGems (section)

The graduated stone run: stones stepping down in size from the centre stone toward the band, with prongs that taper along the way.

Property	Type	Settable
automatic_prong_diameter	bool	yes
bright_cut	float	yes	mm
center_stone_size	float	yes	mm
distance	float	yes	gap between adjacent stones, mm
drill_allow_intersection	bool	yes
drill_height	float	yes	mm
drill_type	str	yes	”NONE”, “ROUND” or “QUAD”
drill_width	float	yes	mm
enabled	bool	yes
end_prong_count	int	yes
extension_for_manufacturing	float	yes	mm
gem_inside	float	yes	mm
gem_move_in_z_end	float		mm
gem_move_in_z_start	float		mm
gem_shape	str	yes	”ROUND”, “PRINCESS”, …
inner_height	float	yes	mm
inner_width	float	yes	mm
lift	float	yes	mm
number_of_stones	int	yes	per side
prong_cut_by_ring_size	bool	yes
prong_diameter_end	float
prong_diameter_start	float
prong_distance	float	yes
prong_grow	float	yes
prong_height_end	float
prong_height_start	float
prong_min_diameter	float	yes
prong_move_in_z	float	yes
prong_over_girdle_end	float
prong_over_girdle_start	float
prong_separation_end	float
prong_separation_start	float
prong_spacing	float	yes
prong_type	str	yes	”NONE”, “SHARED” or “SCALLOPED”
prongs_enabled	bool	yes	Prongs — most sizes taper from the centre stone (Start) to the band (End).
size_end	float		nearest the band, mm
size_start	float		nearest the centre stone, mm
under_bezel_bottom_width	float	yes	mm
under_bezel_enabled	bool	yes	The rail under the stones.
under_bezel_gem_inside	float	yes	rail offset into the stone, mm
under_bezel_girdle_width	float	yes	top diameter span, mm
under_bezel_height	float	yes	0 = auto (drop to the finger curve)
under_bezel_over_girdle	float	yes	rise above the girdle, mm
under_bezel_width	float	yes	total radial width, mm
vertical	float	yes	mm

Method
set_gem_move_in_z(start: float, end: float)
set_prong_diameters(start: float, end: float)
set_prong_heights(start: float, end: float)
set_prong_over_girdle(start: float, end: float)
set_prong_separation(start: float, end: float)
set_sizes(start: float, end: float)	start = nearest the centre stone

GraduatedShank (section)

The graduated band: two profiles that the section morphs between, plus the opening at the bottom.

Property	Type	Settable
bottom_profile	GraduatedProfile
cut_bumping	float	yes	mm
opening_margin	float	yes	mm
top_profile	GraduatedProfile

GraduatedProfile (section)

One of a graduated band’s two profiles (top / bottom). Same shape as a classic profile, on its own model.

Property	Type	Settable
comfort	float	yes	mm — used when Type is “COMFORT”
displacement	float	yes	mm
enabled	bool	yes
height	float	yes	mm
orientation	int	yes	0 = Natural, 1 = Reverse
profile_name	str		RING_PROFILE asset name, "" when unset
rotation	float	yes	degrees
thickness	float	yes	mm — used when Type is “THICKNESS”
type	str	yes	”SOLID”, “COMFORT” or “THICKNESS”
width	float	yes	mm

Method
set_profile(asset_name: str)	RING_PROFILE asset by name