Scripting API
Render
from ArtisanPlugin.Scripting import RenderApi as render, RenderStudioApi as studio
Document-side rendering: everything on these pages changes the Rhino document or drives Rhino’s own renderer. The live web viewer is a separate surface with its own facade — see Realtime Render.
StagingEarring pairs and lay-flat-on-the-ground.
Design materialsBack to the viewport design look, document-wide.
Render materialsPhotoreal materials on every visible object.
Batch renderRender every 3dm in a folder, image next to each file.
Studio catalogsDiscover environments, material families and materials.
Studio sceneApply an environment and studio materials.
Studio stillsOne photoreal image, at your resolution and sample count.
Studio turntablesA full rotation, frame by frame.
Which surface do you want?
| Realtime Render | Render Studio (this section) | |
|---|---|---|
| What it is | An external live viewer window you drive interactively | An offline photoreal renderer |
| Output | Screenshots, multi-view sets and video of the live window | Rendered image files and turntable MP4s |
| Touches the document | Never | Yes — materials, render settings |
| Use it for | Quick looks, client previews, material try-ons, product shots | Final imagery |
Batch render is separate again: it walks a folder of .3dm files and renders each one unattended.
Materials come in two sets
Design materials and Render materials are two halves of one switch — the flat working look you model in, and the photoreal look you render. Flip to render materials before rendering, and back afterwards if you want the viewport readable again.
Render Studio’s materials are a third, separate catalog — see Studio catalogs for how to discover the exact names it accepts.
Conventions
0 keeps the tool default for Render Studio resolutions and sample counts — but not across the rest of this facade: batch render’s width/height must be a real size, and the staging helpers take literal millimetres and degrees. Everything on these pages changes object materials, adds geometry or writes render settings, so it mutates the document — wrap it in a Transaction when you want one-step undo.