PaveShankBuilderApi

Headless builder for the pavé shank. PaveShankApi stays query-only (All/Find/Selected); the IPaveShank handle returned here is the same one it hands out, so PaveShankApi.Find(id) finds what Create made.

from ArtisanPlugin.Scripting import PaveShankBuilderApi

See also the Python package, ra.pave_shank.

Methods

Method
Create	Builds a pavé shank (the ArtisanPaveShank tool, headless): a classic band carrying one or more longitudinal rows of round stones, each row running along the band at a lateral offset from its centre.

Create

IPaveShank PaveShankBuilderApi.Create(
    double width = 0,
    double height = 0,
    double fingerDiameter = 0,
    string profile = null,
    string openingType = null,
    double gemSize = 0,
    double spacing = 0,
    double offset = 0,
    double startAngle = double.NaN,
    double endAngle = double.NaN,
    bool mirror = false,
    IEnumerable<double> rowOffsets = null,
    bool withCutters = false,
    Plane? plane = null,
    string element = null)

Builds a pavé shank (the ArtisanPaveShank tool, headless): a classic band carrying one or more longitudinal rows of round stones, each row running along the band at a lateral offset from its centre. Millimetres; 0 keeps the tool default (or the user’s saved defaults): width 2.5, height 2.5, gemSize 1.2, spacing 0.15, offset 0 (middle of the band). Angles in degrees; NaN keeps the default (startAngle 0, endAngle 360 = full turn). rowOffsets given = one row per lateral offset (all sharing gemSize / spacing / angles), otherwise the row settings apply to the default single row; mirror also places every row at -offset. openingType “NONE” | “CUT” | “STRANGLE” (default STRANGLE). withCutters subtracts one cutter per stone from the band, like the panel does. fingerDiameter 0 = the document’s finger size; profile picks a RING_PROFILE asset by name; plane omitted = world XY. element = name of a saved PaveShank element (ElementsApi.List(“PaveShank”)) to start from; explicit arguments override it (its finger size is always replaced). Returns the IPaveShank handle of the new shank (stones and prongs are its children).

Parameter	Type	Default
width	double	0
height	double	0
fingerDiameter	double	0
profile	string	null
openingType	string	null
gemSize	double	0
spacing	double	0
offset	double	0
startAngle	double	double.NaN
endAngle	double	double.NaN
mirror	bool	false
rowOffsets	IEnumerable<double>	null
withCutters	bool	false
plane	Plane?	null
element	string	null

Returns IPaveShank.

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.

Also used here: IPaveShank, IClassicProfile, IPaveShankRail, IPaveShankRow, IPaveShankProng, IClassicAdvanced.