ra.micro_setting

Micro settings (micro-pave heads).

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.MicroSettingApi.

Functions

Function
all()	A micro setting is baked as a GROUP carrying RaObjectUserData (both here and in the panel); nothing in the product ever creates a MicroSettingCustomObject, so resolving that type found nothing and every query below returned empty.
by_layer()	MicroSetting 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 the micro-setting (pavé infrastructure: cutters, V-cutters, optional channel and row prongs) for a run of small gems — the ArtisanMicroSetting tool, headless.
find()	The handle for id, or None when the id does not belong to an object of this kind.
selected()	MicroSettings currently selected in the active doc.

ra.micro_setting.all()

ra.micro_setting.all() -> List[MicroSetting]

A micro setting is baked as a GROUP carrying RaObjectUserData (both here and in the panel); nothing in the product ever creates a MicroSettingCustomObject, so resolving that type found nothing and every query below returned empty.

ra.micro_setting.by_layer()

ra.micro_setting.by_layer(layer_name: str) -> List[MicroSetting]

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

Parameter	Type
layer_name	str	required

ra.micro_setting.count()

ra.micro_setting.count() -> int

Number of objects of this kind in the active document.

ra.micro_setting.create()

ra.micro_setting.create(gem_ids=None, cutters=None, v_cutters=None, channel=None, row_prongs=None) -> List[str]

Builds the micro-setting (pavé infrastructure: cutters, V-cutters, optional channel and row prongs) for a run of small gems — the ArtisanMicroSetting tool, headless. gem_ids None/empty = the currently selected gems; at least one gem is required. The enable flags default to the tool’s behavior (cutters and V-cutters on, channel and row prongs off); pass True/False to override, or None to keep the default (or the user’s saved defaults). Numeric parameters keep the tool defaults. Returns the ids of every object baked (cutters, V-cutters, channel and prongs), all grouped under one MicroSetting group.

Parameter	Type
gem_ids	Sequence[IdLike]	optional — None = the tool default
cutters	Optional[bool]	optional — None = the tool default
v_cutters	Optional[bool]	optional — None = the tool default
channel	Optional[bool]	optional — None = the tool default
row_prongs	Optional[bool]	optional — None = the tool default

ra.micro_setting.find()

ra.micro_setting.find(id: IdLike) -> MicroSetting

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

Parameter	Type
id	IdLike	required

ra.micro_setting.selected()

ra.micro_setting.selected() -> List[MicroSetting]

MicroSettings currently selected in the active doc.

Handles

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

MicroSetting (handle)

A micro setting: the cutters, V-cutters, channel and row prongs cut and built around a run of stones. Each block is a section mirroring the panel’s own. READ-ONLY: the parametric engine has no RegenerateMicroSetting — the only edit path is reopening the panel (2ShapesEdit.EditMicroSetting) — so there are no in-place setters. Recreate with ra.micro_setting.create (and Delete) to change one.

Property	Type	Settable
channel	MicroSettingChannel
channel_enabled	bool
cutters	MicroSettingCutters
cutters_enabled	bool
layer_name	str
mother_gem_id	str
object_type	str
position	Point3d
row_prongs	MicroSettingRowProngs
row_prongs_enabled	bool
v_cutters	MicroSettingCutters
v_cutters_enabled	bool

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

MicroSettingChannel (section)

The channel rail running under the stones.

Property	Type	Settable
close	bool
enabled	bool
end_bend	float		signed
end_extension	float		signed
end_height	float
end_over_girdle	float		signed
end_width	float
flat_ends	bool
keep	bool
precise	bool
shape	str		UShape, VShape, Square, Trapezoidal, FrenchSetting
shape_factor	float
start_bend	float		signed
start_extension	float		signed
start_height	float
start_over_girdle	float		signed
start_width	float

MicroSettingCutters (section)

The cutters carved under each stone. The same shape describes the plain CUTTERS and the V-CUTTERS; the members marked “cutters only” read as empty/0 on the V-cutters, which have no such parameter.

Property	Type	Settable
enabled	bool
end_height	float		mm
end_width	float		mm
keep	bool		the cutter solids are kept instead of booleaned
length	float		mm
over_girdle	float		mm, signed
over_girdle_middle	float		mm, signed
shape	str		cutters only: U_SHAPE, V_SHAPE, SQUARE, TRAPEZOIDAL, FRENCH_SETTING
shape_factor	float		cutters only
start_height	float		mm
start_width	float		mm
width_by_percentage	bool		cutters only: width sized as a % of each stone
width_percentage	float		cutters only

MicroSettingRowProngs (section)

The prongs shared between consecutive stones.

Property	Type	Settable
allow_collisions	bool
close	bool
diameter	float		mm
diameter_by_percentage	bool		diameter sized as a % of the gap between stones
enabled	bool
height_over_girdle	float		mm, signed
height_under_girdle	float		mm, signed
inside_percentage	float
smart_adapt	bool