AdvancedPaveShankApi

Pave shanks - a band carrying one or more longitudinal rows of stones. Query-only for now: run ArtisanAdvancedPaveShank in the UI once, then script every variant from the handle.

from ArtisanPlugin.Scripting import AdvancedPaveShankApi

See also the guide, Shanks › Advanced pavé shank, and the Python package, ra.advanced_pave_shank.

Methods

Method
All	IAdvancedPaveShank handles for every object of this kind in the active document (empty when there is no document).
ByLayer	IAdvancedPaveShank 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	IAdvancedPaveShank handles for the objects of this kind currently selected in the active document.

All

IReadOnlyList<IAdvancedPaveShank> AdvancedPaveShankApi.All()

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

Returns IReadOnlyList<IAdvancedPaveShank>.

ByLayer

IReadOnlyList<IAdvancedPaveShank> AdvancedPaveShankApi.ByLayer(string layerName)

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

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<IAdvancedPaveShank>.

Count

int AdvancedPaveShankApi.Count()

Number of objects of this kind in the active document.

Returns int.

Find

IAdvancedPaveShank AdvancedPaveShankApi.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 IAdvancedPaveShank.

Selected

IReadOnlyList<IAdvancedPaveShank> AdvancedPaveShankApi.Selected()

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

Returns IReadOnlyList<IAdvancedPaveShank>.

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.

IAdvancedPaveShank

Handle — extends IParametricObject.

Pave shank: a band carrying one or more longitudinal rows of stones. Multiple gems, so no single MotherGem.

Property	Type
Advanced	IClassicAdvanced	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)
Rail	IAdvancedPaveShankRail	get
RingDiameterMm	double	get
RingSizeLabel	string	get
RingSizeRegion	string	get
TopProfile	IClassicProfile	get	The band section and the opening — the same models the classic shank uses.

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

IClassicProfile

Section.

One of the shank’s three section profiles (top / mid / bottom). The top profile is always enabled; mid and bottom are optional.

Property	Type
Comfort	double	get	mm — used when Type is “COMFORT”
Displacement	double	get	mm
Enabled	bool	get
Height	double	get	mm
Orientation	int	get	0 = Natural, 1 = Reverse (flips the profile curve)
ProfileName	string	get	RING_PROFILE asset name, "" when unset
Rotation	double	get	degrees
Thickness	double	get	mm — used when Type is “THICKNESS”
Type	string	get	”SOLID”, “COMFORT” or “THICKNESS”
Width	double	get	mm

Method
void SetComfort(double comfort)
void SetDisplacement(double displacement)
void SetEnabled(bool enabled)
void SetHeight(double height)
void SetOrientation(int orientation)
void SetProfile(string assetName)	RING_PROFILE asset by name — list them with AssetsApi.List(“RING_PROFILE”)
void SetRotation(double degrees)
void SetThickness(double thickness)
void SetType(string type)	”SOLID”, “COMFORT” or “THICKNESS”
void SetWidth(double width)

IAdvancedPaveShankRail

Section.

The rail: the gem rows the band carries and the prongs holding them.

Property	Type
ProngDiameter	double	get	global default, mm
ProngHeight	double	get	global default, mm
Prongs	IReadOnlyList<IAdvancedPaveShankProng>	get
Rows	IReadOnlyList<IAdvancedPaveShankRow>	get
ShowProngs	bool	get

Method
void SetProngDiameter(double diameter)
void SetProngHeight(double height)
void SetRow( int index, double gemSize, double offset, double spacing, double startAngle, double endAngle)	Edits one row in place.
void SetRows(IEnumerable<IAdvancedPaveShankRow> rows)	Replaces the whole row list, in lateral order.
void SetShowProngs(bool show)

IAdvancedPaveShankRow

Section.

One longitudinal gem row: a line of equal stones running along the band at a lateral offset from the top profile’s centre, from StartAngle to EndAngle.

Property	Type
EndAngle	double	get	degrees
GemSize	double	get	mm
Mirror	bool	get	the row is the mirror of its opposite
Offset	double	get	lateral offset from the centre, mm
Spacing	double	get	gap between adjacent stones, mm
StartAngle	double	get	degrees along the band

IAdvancedPaveShankProng

Section.

One prong definition, tied to a row by index.

Property	Type
ApplyToAllGems	bool	get
Diameter	double	get	mm
Height	double	get	mm
Mirror	bool	get
RowIndex	int	get
Visible	bool	get
X	double	get	mm
Y	double	get	mm

IClassicAdvanced

Section.

The classic shank’s Advanced section: the opening at the bottom of the band.

Property	Type
CutBumping	double	get	mm — used when OpeningType is “CUT”
CutLength	double	get	mm — used when OpeningType is “CUT”
OpeningType	string	get	”NONE”, “CUT” or “STRANGLE”
StrangleBaseX	double	get	mm
StrangleBaseY	double	get	mm
StrangleBaseZ	double	get	mm
StrangleOpening	double	get	mm — used when OpeningType is “STRANGLE”

Method
void SetCutBumping(double bumping)
void SetCutLength(double length)
void SetOpeningType(string openingType)	”NONE”, “CUT” or “STRANGLE”
void SetStrangleBase(double x, double y, double z)
void SetStrangleOpening(double opening)