Skip to content

Scripting API

Relief

from ArtisanPlugin.Scripting import ReliefApi as relief

A relief is a 2.5D height field — a flat area given depth, the way an engraved crest or a cameo sits proud of its background. Artisan builds it as a stack of ordered operations evaluated onto a grid, which you can either produce in one call or assemble step by step. Each part has its own page.

Two routes to a relief

RoutePagesWhen
One shotFrom image, From curves, From geometryYou know the whole relief up front — set it up and produce it in a single call
Step by stepProject stack → Operations → Edit the stack → BakeYou are composing several layers, or want to reorder and re-combine before committing

The step-by-step route is the same machine underneath: the one-shot creators set up a project and run it for you.

Operation ids are not object ids

The Add* operations return the id of an operation inside the project, not a document object. Every method on Edit the stack takes exactly that id. Only Bake puts geometry in the document.

Conventions

Millimetres, and mutations belong inside a Transaction for one-step undo. Profile names come from ProfileNames() — see The project stack.

Not scriptable yet

Only the purely interactive layer remains UI-only: painting with the mouse, the live preview gizmos and the graphical profile editor. The brush operations themselves ARE scriptable — Sculpt and Smooth dab programmatically from a list of points.