PaveShankBuilderApi

Headless builder for the multi-row 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 multi-row pavé shank (the Pavé Shank tool, ArtisanPaveShank, headless): a classic band with ONE profile and ONE size carrying rows automatic rows of round pavé stones on its outer surface, held by bead prongs.

Create

IPaveShank PaveShankBuilderApi.Create(
    double width = 0,
    double height = 0,
    double fingerDiameter = 0,
    string profile = null,
    string opening = null,
    string layoutMode = null,
    double topAngle = 0,
    double startAngle = 0,
    double endAngle = 0,
    int rows = 0,
    double rowDistance = 0,
    double gemSize = 0,
    double lateralGemSize = 0,
    double minDistance = 0,
    double prongDiameter = 0,
    bool withGems = true,
    bool withCutters = false,
    Plane? plane = null,
    string element = null)

Builds a multi-row pavé shank (the Pavé Shank tool, ArtisanPaveShank, headless): a classic band with ONE profile and ONE size carrying rows automatic rows of round pavé stones on its outer surface, held by bead prongs. With 3+ rows the two outermost rows use lateralGemSize and the inner rows gemSize; the row pitch is automatic (half of each neighbouring stone size + rowDistance). Millimetres; 0 keeps the tool default (or the user’s saved defaults): width 3, height 2 (band section), rows 3, rowDistance 0.1, gemSize 1.6 (central), lateralGemSize 1.3, minDistance 0.1 (gap along the row), prongDiameter 0.8 (every bead shares one size). layoutMode “FULL” (all round the ring; the tool default) | “SIDE_ANGLE” (uses startAngle / endAngle, defaults 30-150) | “TOP_ANGLE” (uses topAngle, default 120). opening “NONE” (default) | “STRANGLE” | “CUT” — the classic band opening. withGems false bakes the band alone; withCutters adds a parametric drill cutter under every stone, like the panel does. fingerDiameter 0 = the document’s finger size; profile picks a RING_PROFILE asset by name (omitted = the oval profile the command starts from, or the default one); plane omitted = world XY. element = name of a saved MultiRowShank element (ElementsApi.List(“MultiRowShank”)) to start from; explicit arguments override it (its finger size is always replaced). The bead offsets (Prong.SetEdgeOffset / SetEndOffset) are handle setters. Returns the IPaveShank handle of the new shank (stones, cutters and prongs are its children).

Parameter	Type	Default
width	double	0
height	double	0
fingerDiameter	double	0
profile	string	null
opening	string	null
layoutMode	string	null
topAngle	double	0
startAngle	double	0
endAngle	double	0
rows	int	0
rowDistance	double	0
gemSize	double	0
lateralGemSize	double	0
minDistance	double	0
prongDiameter	double	0
withGems	bool	true
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, IPaveShankRows, IPaveShankProng, IClassicGems, IClassicAdvanced.