MicroSettingApi

Micro settings (micro-pave heads).

from ArtisanPlugin.Scripting import MicroSettingApi

See also the guide, Gemsets › Micro setting, and the Python package, ra.micro_setting.

Methods

Method
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.
ByLayer	IMicroSetting 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 null when the id does not belong to an object of this kind.
Selected	MicroSettings currently selected in the active doc.

All

IReadOnlyList<IMicroSetting> MicroSettingApi.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.

Returns IReadOnlyList<IMicroSetting>.

ByLayer

IReadOnlyList<IMicroSetting> MicroSettingApi.ByLayer(string layerName)

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

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<IMicroSetting>.

Count

int MicroSettingApi.Count()

Number of objects of this kind in the active document.

Returns int.

Create

IReadOnlyList<Guid> MicroSettingApi.Create(
    IEnumerable<Guid> gemIds = null,
    bool? cutters = null,
    bool? vCutters = null,
    bool? channel = null,
    bool? rowProngs = null)

Builds the micro-setting (pavé infrastructure: cutters, V-cutters, optional channel and row prongs) for a run of small gems — the ArtisanMicroSetting tool, headless. gemIds null/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 null 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	Default
gemIds	IEnumerable<Guid>	null
cutters	bool?	null
vCutters	bool?	null
channel	bool?	null
rowProngs	bool?	null

Returns IReadOnlyList<Guid>.

Find

IMicroSetting MicroSettingApi.Find(Guid id)

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

Parameter	Type	Default
id	Guid	required

Returns IMicroSetting.

Selected

IReadOnlyList<IMicroSetting> MicroSettingApi.Selected()

MicroSettings currently selected in the active doc.

Returns IReadOnlyList<IMicroSetting>.

Handles and sections

What the methods above hand back. A handle’s setters regenerate the object; wrap changes in a Transaction so they land as one undo step.

IMicroSetting

Handle — extends IParametricObject.

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 MicroSettingApi.Create (and Delete) to change one.

Property	Type
Channel	IMicroSettingChannel	get
ChannelEnabled	bool	get
Cutters	IMicroSettingCutters	get
CuttersEnabled	bool	get
Id	Guid	get	(from IParametricObject)
LayerName	string	get	(from IParametricObject)
MotherGemId	Guid	get	(from IParametricObject)
ObjectType	string	get	(from IParametricObject)
Position	Point3d	get	(from IParametricObject)
RowProngs	IMicroSettingRowProngs	get
RowProngsEnabled	bool	get
VCutters	IMicroSettingCutters	get
VCuttersEnabled	bool	get

Method
void Delete()	(from IParametricObject)
void Move(Vector3d translation)	(from IParametricObject)

IMicroSettingCutters

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
Enabled	bool	get
EndHeight	double	get	mm
EndWidth	double	get	mm
Keep	bool	get	the cutter solids are kept instead of booleaned
Length	double	get	mm
OverGirdle	double	get	mm, signed
OverGirdleMiddle	double	get	mm, signed
Shape	string	get	cutters only: U_SHAPE, V_SHAPE, SQUARE, TRAPEZOIDAL, FRENCH_SETTING
ShapeFactor	double	get	cutters only
StartHeight	double	get	mm
StartWidth	double	get	mm
WidthByPercentage	bool	get	cutters only: width sized as a % of each stone
WidthPercentage	double	get	cutters only

IMicroSettingRowProngs

Section.

The prongs shared between consecutive stones.

Property	Type
AllowCollisions	bool	get
Close	bool	get
Diameter	double	get	mm
DiameterByPercentage	bool	get	diameter sized as a % of the gap between stones
Enabled	bool	get
HeightOverGirdle	double	get	mm, signed
HeightUnderGirdle	double	get	mm, signed
InsidePercentage	double	get
SmartAdapt	bool	get

IMicroSettingChannel

Section.

The channel rail running under the stones.

Property	Type
Close	bool	get
Enabled	bool	get
EndBend	double	get	signed
EndExtension	double	get	signed
EndHeight	double	get
EndOverGirdle	double	get	signed
EndWidth	double	get
FlatEnds	bool	get
Keep	bool	get
Precise	bool	get
Shape	string	get	UShape, VShape, Square, Trapezoidal, FrenchSetting
ShapeFactor	double	get
StartBend	double	get	signed
StartExtension	double	get	signed
StartHeight	double	get
StartOverGirdle	double	get	signed
StartWidth	double	get