.NET API

TwoRowsShankBuilderApi

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

from ArtisanPlugin.Scripting import TwoRowsShankBuilderApi

See also the Python package, ra.two_rows_shank.

Methods

Method
`Create`	Builds a two-rows shank (the ArtisanTwoRowsShank tool, headless): a classic band with a channel carved on each face, each carrying a row of round stones held by prongs.

Create

ITwoRowsShank TwoRowsShankBuilderApi.Create(
    double width = 0,
    double height = 0,
    double fingerDiameter = 0,
    string profile = null,
    string layoutMode = null,
    double topAngle = 0,
    double startAngle = 0,
    double endAngle = 0,
    double gemSize = 0,
    double channelWidth = 0,
    double channelOffset = 0,
    string railMode = null,
    bool withGems = true,
    bool withCutters = false,
    Plane? plane = null,
    string element = null)

Builds a two-rows shank (the ArtisanTwoRowsShank tool, headless): a classic band with a channel carved on each face, each carrying a row of round stones held by prongs. Millimetres; 0 keeps the tool default (or the user’s saved defaults): width 3, height 2 (band section), gemSize 1.0, channelWidth 1.3 (span along the face), channelOffset 0.3 (depth carved into the band). layoutMode “FULL” | “SIDE_ANGLE” (uses startAngle / endAngle, defaults 30-150) | “TOP_ANGLE” (uses topAngle, default 60; the tool default). railMode “DOUBLE” (one channel per face, the default) | “SINGLE” (one wide channel). withGems false bakes the carved 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 triangular profile the command starts from, or the default one); plane omitted = world XY. element = name of a saved TwoRowsShank element (ElementsApi.List(“TwoRowsShank”)) to start from; explicit arguments override it (its finger size is always replaced). Returns the ITwoRowsShank 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`
`layoutMode`	`string`	`null`
`topAngle`	`double`	`0`
`startAngle`	`double`	`0`
`endAngle`	`double`	`0`
`gemSize`	`double`	`0`
`channelWidth`	`double`	`0`
`channelOffset`	`double`	`0`
`railMode`	`string`	`null`
`withGems`	`bool`	`true`
`withCutters`	`bool`	`false`
`plane`	`Plane?`	`null`
`element`	`string`	`null`

Returns ITwoRowsShank.

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: ITwoRowsShank, IClassicProfile, ITwoRowsRail, ITwoRowsProng, IClassicGems, IClassicExternalProfile, IClassicAdvanced.