EngravingApi

Text engraved around a ring band (the ArtisanEngraveRing tool — the Engraving entry of the Smart Components tab).

from ArtisanPlugin.Scripting import EngravingApi

See also the guide, Accessories › Engraving, and the Python package, ra.engraving.

Methods

Method
Create	Engraves text around a ring of the given inner diameter (mm; 0 = the session’s current finger size, default 17.35).

Create

IReadOnlyList<Guid> EngravingApi.Create(
    string text,
    double diameter = 0,
    double angle = 0,
    double height = 0,
    double spacing = 0,
    double thickness = 0,
    string font = null,
    string fontStyle = null,
    string horizontalAlign = null,
    string verticalAlign = null,
    Plane? plane = null)

Engraves text around a ring of the given inner diameter (mm; 0 = the session’s current finger size, default 17.35). angle rotates the text around the ring (the tool’s gumball, degrees). thickness 0 keeps flat engraving curves only; > 0 also builds the solid text. Defaults: font Bienchen regular, height 1.5, spacing 0.5, horizontal align CENTER, vertical align CENTER. plane is the text orientation plane (default: active construction plane). Returns the ids of the created objects (solid text on the metal layer, engraving curves on the user layer, all grouped as an editable Engrave Ring component).

Parameter	Type	Default
text	string	required
diameter	double	0
angle	double	0
height	double	0
spacing	double	0
thickness	double	0
font	string	null
fontStyle	string	null
horizontalAlign	string	null
verticalAlign	string	null
plane	Plane?	null

Returns IReadOnlyList<Guid>.