Skip to content

.NET API

ThreeStonesApi

Three Stones ring top (the ArtisanThreeStones tool, headless): one center stone plus two symmetric side stones placed around a finger size — the classic trilogy engagement layout.

from ArtisanPlugin.Scripting import ThreeStonesApi

See also the Python package, ra.three_stones.

Methods

Method
CreateCreates the editable Three Stones group.

Create

IReadOnlyList<Guid> ThreeStonesApi.Create(
    string centerShape,
    double centerCarats,
    string sideShape,
    double sideCarats,
    string centerMaterial = "Diamond",
    string sideMaterial = "Diamond",
    double centerDistance = 4,
    double centerRotation = 0,
    double sideDistance = 3.2,
    double sideAngle = 28,
    double sideRotation = 0,
    double sideRotationY = 25,
    double fingerDiameter = 0)

Creates the editable Three Stones group. The center stone sits at the top of the finger size; the side stones mirror each other at sideAngle degrees to each side, optionally leaning toward the center (sideRotationY). The stones always come from the arguments; the placement starts from the user’s saved Three Stones defaults when there are any (an argument left at its signature default keeps the saved value), otherwise from the tool’s own. fingerDiameter 0 = the document’s finger size. Returns the gem ids as [center, side A, side B] (the group also carries the finger reference circle).

ParameterTypeDefault
centerShapestringrequired
centerCaratsdoublerequired
sideShapestringrequired
sideCaratsdoublerequired
centerMaterialstring"Diamond"
sideMaterialstring"Diamond"
centerDistancedouble4
centerRotationdouble0
sideDistancedouble3.2
sideAngledouble28
sideRotationdouble0
sideRotationYdouble25
fingerDiameterdouble0

Returns IReadOnlyList<Guid>.