Skip to content

Python package

ra.engraving

Ring engravings.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.EngravingApi.

Functions

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

ra.engraving.create()

ra.engraving.create(text: str, diameter=None, angle=None, height=None, spacing=None, thickness=None, font=None, font_style=None, horizontal_align=None, vertical_align=None, plane=None) -> List[str]

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).

ParameterType
textstrrequired
diameterfloatoptional — None = the tool default
anglefloatoptional — None = the tool default
heightfloatoptional — None = the tool default
spacingfloatoptional — None = the tool default
thicknessfloatoptional — None = the tool default
fontstroptional — None = the tool default
font_stylestroptional — None = the tool default
horizontal_alignstroptional — None = the tool default
vertical_alignstroptional — None = the tool default
planeOptional[PlaneLike]optional — None = the tool default