.NET API

Every facade of ArtisanPlugin.Scripting — API 0.9.0, RhinoArtisan 7.0.0.10 — with the exact C# signature of each method, its parameters and defaults, and the handles, sections and results it hands back. This reference is generated from the plugin itself, so it always matches the version it names. For walkthroughs and examples, see the API reference guides; for Python 3, the rhinoartisan package.

Conventions: millimetres everywhere; an optional number left at 0 keeps the default (the user’s saved defaults for that element, else the tool’s); a Guid list left null or empty uses the current selection; every mutating call needs a valid license; wrap changes in a Transaction so they land as one undo step.

• Core types — Transaction, ScriptingInfo, LicenseGate and the exceptions a script can catch.
• Results — the read-only records methods return (prices, weights, exports…).
• Other interfaces — the shared bases of the handles (IParametricObject, IGemSetting…).

Gems

Facade
AdvancedGemsOnCurveApi	Runs of stones along a curve with per-stone sizes, shapes and rotations.
GemApi	Create, query and edit stones: shapes, materials, carats, placement, copies, collisions.
GemOrientationApi	Fix the orientation plane of stones without moving them.
GemSizeApi	Stones by millimetre size instead of carats.
GemToolsApi	Utilities over existing stones: centers, tags, alignment, curves from gems, copy by gems, colors by size.
GemsByNetworkApi	Stones over a network of intersecting curves, sized to meet at the nodes.
GemsFromCircleApi	Turn circles into round stones of the matching size.
GemsOn2CurvesApi	Stones fitted between two rails, sized to the gap.
GemsOnCurveApi	A run of stones along one curve, with prongs and cutters, editable afterwards.
TaperedBaguettesApi	Tapered baguettes between two curves.
ThreeStonesApi	The classic three-stone layout.
ToiEtMoiApi	Two stones facing each other.
TrilogyApi	Three-stone families: trellis, halo, individual, bezel set, east-west.

Settings

Facade
AdvancedBasketApi	Baskets with independent prong and rail profiles.
AdvancedBezelApi	Bezels with a custom profile.
BasketApi	Basket settings: prongs, upper and base rails.
BasketUpdateApi	Basket settings: prongs, upper and base rails.
BezelApi	Bezel settings with support, cutter and air-gap sections.
CabochonApi	Cabochon stones and their settings.
ChannelApi	Channel settings along a curve.
ClusterApi	Cluster settings around a centre stone.
CutterApi	The cutters that carve the seat of a stone into the metal.
HaloApi	A halo of small stones around a centre stone.
HiddenHaloApi	A hidden halo under the centre stone.
MartiniApi	Martini settings.
MicroSettingApi	Micro settings (micro-pave heads).
PearlApi	Pearls and their cups.
PegheadApi	Peghead seats under a stone: prongs, height, thickness.
TrellisGemsetApi	Trellis settings.
TulipApi	Tulip settings.

Shanks and rings

Facade
AdvancedCathedralApi	Cathedral shanks with station-by-station control.
AdvancedRingApi	Rings built from positioned sections along the finger curve.
AdvancedSignetRingApi	Signet rings with independent top and side profiles.
BypassApi	Bypass shanks whose arms cross past each other.
CathedralApi	Cathedral shanks: arms rising toward the setting.
ClassRingApi	Class rings.
ClassicApi	Classic ring shanks: comfort-fit bands at the document finger size, optionally with a stone row.
EternityApi	Eternity bands with stones all around.
GraduatedApi	Graduated shanks: a run of stones shrinking away from the centre.
MatchingShankApi	Matching shanks fitted against an engagement ring.
MatchingShankBuilderApi	Matching shanks fitted against an engagement ring.
PaveShankApi	Pave shanks: rows of stones along the band.
PaveShankBuilderApi	Pave shanks: rows of stones along the band.
RingCurveApi	Ring rail curves at the document finger size (closed, open, bypass, shaped).
RingExtrudeApi	Rings extruded from a frontal profile.
RingToolsApi	Utilities on ring geometry: cut by ring size, estimate size, rail helpers.
ScoopRingApi	Scoop rings.
SignetRingApi	Signet rings with a shaped top face.
SplitShankApi	Split shanks.
TwoRowsShankApi	Two-row shanks.
TwoRowsShankBuilderApi	Two-row shanks.
WeddingApi	Wedding sets (band pairs) built as one editable object.
WeddingBandApi	Single wedding bands.
WeddingBuilderApi	Wedding sets (band pairs) built as one editable object.

Pave and prongs

Facade
AutomaticPaveApi	Relaxed multi-size pave fill with symmetry.
AzureApi	Azure cutters under a pave: the openwork underneath.
PaveAlongSurfaceApi	Pave rows following a surface direction.
PaveApi	Automatic pave over surfaces: one size in a regular grid, with prongs and cutters.
ProngApi	Prongs: dynamic (between stones), automatic, custom and axis-aligned.

Components

Facade
BailApi	Pendant bails.
BangleApi	Bangles.
BeadApi	Beads.
ChainApi	Chains along a curve.
CharmApi	Charms.
EngravingApi	Ring engravings.
HingeApi	Hinges.
HoneyCombApi	Honeycomb patterns over surfaces.
HuggieApi	Huggie earrings.
LinkApi	Chain links.
MilgrainApi	Milgrain beading along curves.
NamedPendantApi	Name pendants from text.
PatternApi	Repeated patterns over surfaces.
ProfileSweepApi	Sweeps of a profile along rails.
RopeApi	Rope twists.
SmartComponentApi	Edit bails, named pendants, bangles, beads, charms, links, milgrain, ropes, 3D textures and ring engravings after creation (their model as JSON).
TextOnCurveApi	Text laid along a curve.
Texture3DApi	3D textures applied to surfaces.
UserElementApi	User-defined elements.
VoronoiApi	Voronoi patterns over surfaces.

Solids, curves and transforms

Facade
BooleanApi	Artisan booleans that keep the pieces editable: union, difference, intersection, split, update.
BooleanUpdateApi	Artisan booleans that keep the pieces editable: union, difference, intersection, split, update.
CurveApi	Curve helpers for jewelry layouts.
MeshApi	Mesh decimation.
RasterToVectorApi	Trace an image into curves.
RelationsApi	Parent/child relations between parametric objects.
ReliefApi	2.5D reliefs: creators, the operation stack, sculpt/smooth by points, bake, heightmaps.
SmartProfileApi	Smart Profiles: profile sections swept along a curve, varying along the way.
SolidApi	Solid modelling helpers: caps, shells, sweeps, offsets.
TransformApi	Move, rotate, scale, mirror, arrays, deformations (bend, twist, taper), flow, placement on objects.

Analysis and pricing

Facade
AnalyzeApi	Wall thickness: at points and globally.
PricingApi	Prices and cost breakdowns, markup and taxes profiles.
PricingExtraApi	Prices and cost breakdowns, markup and taxes profiles.
WeightApi	Metal weights: per layer, per selection, by area.

Production

Facade
FileApi	File utilities: standardize, elements import/export, layer exports.
ManufacturingApi	Production: repair, printability checks, identifiers, sprues, resizing, exports.

Drafting

Facade
DraftingApi	Reports, gems maps, cost tables, dimensions.
DraftingExtraApi	Reports, gems maps, cost tables, dimensions.

Render and views

Facade
RealtimeRenderApi	The web Realtime Render viewer: open, update, camera, materials, screenshots.
RenderApi	Render materials, staging and batch rendering.
RenderStudioApi	Render Studio: environments, materials, stills and turntables.
ViewApi	Viewport cameras, display modes, named views and captures.

Document and library

Facade
AssetsApi	The profile library the parametric tools build from.
DocumentApi	The document: open/save/new, computation mode, metals, ring size, STL/PDF/GLB exports.
ElementsApi	Saved element presets: build from them, apply them, save objects as new ones, organize the library.
PanelsApi	The open Artisan command panel: which one it is, and closing it without applying.
SemanticsApi	Semantic descriptions of the design.

Integrations

Facade
FileSearchApi	Instant search over indexed design files.
NivodaApi	Nivoda certified-diamond search.

Other

Facade
AiImageApi	AI images with fal.ai, the engine of Generative AI Studio and of the Assistant’s generate_image: a photoreal render of the viewport, an edit of an image file, or an image from a prompt alone.
BoutiqueApi	The Boutique: ready-made designs (solitaires, trilogies, halos, bands, earrings…) grouped in collections that are downloaded from the RhinoArtisan catalog to this computer and imported into the document like the Boutique window does.
TimeTrackingApi	The time tracker’s records (the ArtisanTimeTracker panel), read-only: how long each saved file has been worked on, per day.