Scripting API
Render
from ArtisanPlugin.Scripting import RenderApi as render, RenderStudioApi as studio
Two rendering surfaces, and knowing which one you want is most of the battle. Each part has its own page.
Realtime viewerOpen, update, camera, materials and screenshots.
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 viewer | Render Studio | |
|---|---|---|
| What it is | An external live viewer window you drive interactively | An offline photoreal renderer |
| Pages | Realtime viewer | Catalogs, Scene, Stills, Turntables |
| Output | Screenshots of the live window | Rendered image files |
| Use it for | Quick looks, client previews, material try-ons | 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.
Viewer calls fail quietly
Only two of the viewer methods wait for an answer: GetViewerItems and ViewerScreenshot, which can time out. The rest queue JavaScript into the viewer window and never report a page-side failure, so an unknown part uuid or material name simply does nothing. See Realtime viewer.
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. Anything that changes object materials or adds geometry mutates the document and belongs inside a Transaction; driving the viewer window does not.