PaveShankApi

Multi-row pavé shanks - a classic band (one profile, one size) carrying N automatic rows of pavé stones. Query facade: PaveShankBuilderApi.Create builds one headless; every variant is then scripted from the handle.

from ArtisanPlugin.Scripting import PaveShankApi

See also the guide, Shanks › Pavé shank, and the Python package, ra.pave_shank.

Methods

Method
All	IPaveShank handles for every object of this kind in the active document (empty when there is no document).
ByLayer	IPaveShank 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.
Find	The handle for id, or null when the id does not belong to an object of this kind.
Selected	IPaveShank handles for the objects of this kind currently selected in the active document.

All

IReadOnlyList<IPaveShank> PaveShankApi.All()

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

Returns IReadOnlyList<IPaveShank>.

ByLayer

IReadOnlyList<IPaveShank> PaveShankApi.ByLayer(string layerName)

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

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<IPaveShank>.

Count

int PaveShankApi.Count()

Number of objects of this kind in the active document.

Returns int.

Find

IPaveShank PaveShankApi.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 IPaveShank.

Selected

IReadOnlyList<IPaveShank> PaveShankApi.Selected()

IPaveShank handles for the objects of this kind currently selected in the active document.

Returns IReadOnlyList<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: IClassicProfile, IClassicGems, IClassicAdvanced.

IPaveShank

Handle — extends IParametricObject.

Multi-row pavé shank: a classic band with ONE profile and ONE size carrying N automatic rows of round pavé stones on its outer surface. Multiple gems, so no single MotherGem.

Property	Type
Advanced	IClassicAdvanced	get
CuttersEnabled	bool	get
Gems	IClassicGems	get	The stones (GemSize = CENTRAL size, MinDistance, Vertical) and the bead options (TypeProng NONE/SHARED, ProngHeight = bead length, ProngMoveInZ = how far the bead top sits above the girdle, GemInside, ExtensionForManufacturing). AutomaticProngDiameter and ProngDiameter are ignored here: the bead size is Prong.Diameter.
GemsEnabled	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)
Prong	IPaveShankProng	get
RingDiameterMm	double	get
RingSizeLabel	string	get
RingSizeRegion	string	get
Rows	IPaveShankRows	get	Multi-row specifics.
TopProfile	IClassicProfile	get	The band: its one profile (asset, width, height, type…) and the classic opening (NONE / STRANGLE / CUT).

Method
void Delete()	(from IParametricObject)
void Move(Vector3d translation)	(from IParametricObject)
void SetCuttersEnabled(bool enabled)
void SetElement(string element)	Applies a saved MultiRowShank element (ElementsApi.List(“MultiRowShank”)) to this shank: its band, rows and gems replace the current ones, the ring size stays, and the shank regenerates in place (same id).
void SetGemsEnabled(bool enabled)

IPaveShankRows

Section.

The rows of a multi-row pavé shank: how many, how far apart, the lateral stone size and how far around the ring they run.

Property	Type
Count	int	get	number of rows across the band (1..9); with 3+ the two outermost rows are LATERAL, the rest CENTRAL
Distance	double	get	gap between the stones of two adjacent rows, mm (edge to edge); the row pitch is automatic
EndAngle	double	get	degrees — used when LayoutMode is “SIDE_ANGLE”
LateralGemSize	double	get	stone size of the two outermost rows, mm (only with 3+ rows)
LayoutMode	string	get	”FULL”, “SIDE_ANGLE” or “TOP_ANGLE”
StartAngle	double	get	degrees — used when LayoutMode is “SIDE_ANGLE”
TopAngle	double	get	total arc in degrees — used when LayoutMode is “TOP_ANGLE”

Method
void SetCount(int count)
void SetDistance(double distance)
void SetLateralGemSize(double size)
void SetLayoutMode(string layoutMode)	”FULL”, “SIDE_ANGLE” or “TOP_ANGLE”
void SetSideAngles(double startAngle, double endAngle)
void SetTopAngle(double degrees)

IPaveShankProng

Section.

The bead prongs of a multi-row pavé shank. Every bead shares one diameter; the beads between rows sit centred in their hollows, the beads on the band edges and at the row ends are placed for a reference radius and moved by the two offsets.

Property	Type
Diameter	double	get	diameter of every bead, mm
EdgeOffset	double	get	edge offset, mm: how far the beads on the band edges (outer sides of the outermost rows) are pushed outward; negative pulls them in
EndOffset	double	get	end offset, mm: how far the bead past the last stone of each row end is moved along the row; negative pulls it in over the stone

Method
void SetDiameter(double diameter)
void SetEdgeOffset(double offset)
void SetEndOffset(double offset)