API Reference

The Scripting API lives in the ArtisanPlugin.Scripting namespace. Facades are grouped by what they work on:

• File SearchInstant search over your indexed design files.
• DocumentOpen, save and export — plus mode, metals, ring size and describe.
• GemsCreate, query and edit stones — plus utilities and undo.
• BooleansUnion, difference, intersection and split — editable Artisan booleans.
• ShanksEvery ring body: classic, cathedral, eternity, bypass, split, pave and more.
• GemsetsEvery setting: bezels to halos, pavé to channels — and their cutters.
• AccessoriesBails, bangles, beads, charms, chains and friends.
• Curves & TextRing rails, text on curve, image tracing.
• AssetsThe profile library the parametric tools build from.
• TransformScale by weight or dimensions, deform, mirror, place on surfaces.
• Relief2.5D height-field reliefs: creators, the project stack, heightmaps.
• AnalysisWall thickness and metal weights.
• DraftingReports, gems maps, cost tables, auto-dimensions.
• ManufacturingRepair, printability, sprues, resizing, decimation.
• PricingThe Breakdown engine — totals, line detail, cost settings.
• RenderThe Realtime Render viewer, materials and batch rendering.
• ViewsViewport cameras, named views and captures.
• IntegrationsNivoda certified-diamond sourcing.

Everything at a glance

The complete exported surface, one row per facade. Bold methods modify the document.

Facade	Methods
GemApi	Shapes, Materials, All, Find, Count, Selected, ByLayer, ByMaterial, Collisions, Create
IGem handle	Id, Shape, Material, CaratWeight, SizeX/Y/Z, Position, Plane, LayerName · SetMaterial, SetCaratWeight, SetSize, Scale, Move, SetPlane, Rotate, Flip, Copy, Delete, Select
CutterApi	All, Find, Count, Selected, ByLayer, ForGem, Create
BooleanApi	Union, Difference, Intersection, Split
BezelApi	All, Find, Count, Selected, ByLayer, ForGem, Create · handle: SetHeight, SetWidth, SetGirdleHeight, SetGirdleWidth, SetGemInside
PegheadApi	All, Find, Count, Selected, ByLayer, ForGem, Create · handle: SetProngs, SetHeight, SetThickness, SetGirdleWidth, SetOverGirdleHeight, SetGemInside
BasketApi	All, Find, Count, Selected, ByLayer, ByGemMaterial, ForGem, Create · handle: SetProngCount, SetProngDiameter, SetProngHeight
HaloApi	All, Find, Count, Selected, ByLayer, ForGem, Create · handle: SetStoneSize, SetStoneDistance
ClassicApi	All, Find, Count, Selected, ByLayer, Create · handle: SetWidth, SetHeight + full section views (TopProfile, MidProfile, BottomProfile, ExternalProfile, Advanced, Gems)
CathedralApi	All, Find, Count, Selected, ByLayer, Create · handle: SetTopWidth, SetTopHeight, SetBottomWidth, SetBottomHeight + section views (Shank, Gems)
EternityApi	All, Find, Count, Selected, ByLayer, Create · handle: section views (Gems, Prongs, Bezels, Shank)
AdvancedCathedralApi, BypassApi, SplitShankApi, GraduatedApi, PaveShankApi, TwoRowsShankApi, MatchingShankApi, SignetRingApi, AdvancedSignetRingApi, WeddingApi, WeddingBandApi	All, Find, Count, Selected, ByLayer (+ForRing on MatchingShank) · fully editable handles — see Handles
GemsOnCurveApi	All, Find, Count, Selected, ByLayer, ForCurve, Create
GemsByNetworkApi	All, Find, Count, Selected, ByLayer, ForCurve
ClusterApi	All, Find, Count, Selected, ByLayer, ForGem, Create
HiddenHaloApi, TulipApi, MartiniApi, TrellisGemsetApi	All, Find, Count, Selected, ByLayer, ForGem, Create · handles with 2 parametric setters each
AdvancedBezelApi, CabochonApi, PearlApi	All, Find, Count, Selected, ByLayer (+ForGem on AdvancedBezel), Create
AdvancedBasketApi	All, Find, Count, Selected, ByLayer, ForGem, Create · handle: SetProngCount, SetProngDiameter, SetProngHeight, SetRailCount
GemToolsApi	Centers, AddCenterPoints, CenterBetweenGems, CurveFromGems, ExtractGemCurves, OffsetGemCurves, CopyByGems, ColorBySize, RotateGems, AlignGems, AddTags, RecoverGems
MicroSettingApi	All, Find, Count, Selected, ByLayer, Create
ChannelApi	Create
PaveApi	OnSurface
ToiEtMoiApi	Create
RingCurveApi	CreateClosed, CreateOpen, CreateBypass, CreateShape
TextOnCurveApi	Create
RasterToVectorApi	Create
AssetsApi	Types, List, GetDefault
BailApi, BangleApi, BeadApi, CharmApi, LinkApi, NamedPendantApi, HingeApi, MilgrainApi, RopeApi, VoronoiApi, HoneyCombApi, Texture3DApi, ChainApi, HuggieApi, PatternApi, ProfileSweepApi, EngravingApi	Create (one per component)
UserElementApi	List, Create
DocumentApi	GetComputationMode, GetMetals, GetRingSize, RingSizeRegions, GetPath, IsModified, ReportPdf, Glb, Stl, SetComputationMode, SetMetal, SetRingSize, SetRingSizeByDiameter, Open, Save, New
ViewApi	Describe, SetCamera, RestoreNamedView, SetDisplayMode, ZoomExtents, SaveNamedView, ImportNamedViews, Capture
TransformApi	ScaleByWeight, ScaleToDimensions, CopyOnObjects, MoveOnObjects, MoveByNormal, MirrorQuad, MirrorOpposite, Bend, Twist, Taper
ReliefApi	GetProject, Operations, ProfileNames, ExportHeightmap, CreateFromImage, CreateFromCurves, CreateFromGeometry, SetupProject, AddProfile, AddExtrude, AddImage, AddTexture, AddGeometry, AddSculpt, AddSmooth, SetOperationEnabled, SetOperationCombine, MoveOperation, RemoveOperation, ClearProject, Bake
MeshApi	Decimate, DecimateToTolerance
AnalyzeApi	ThicknessAt, ThicknessAtPoints, GlobalThickness
WeightApi	Metals, Calculate, CalculateForObjects, CalculateForSelection, CalculateByArea, CalculateSelectionByArea
DraftingApi	ReportTemplates, ExportGemsList, CreateReport, CreateReportFromTemplate, CreateGemsMap, CreateGemsTable, CreateMetalsTable, CreateBreakdownTable, GenerateDimensions, GenerateDimensionsFromRing, GenerateDimensionsByBox, GenerateDimensionsFromBangle
ManufacturingApi	AutomaticRepair, AddIdentifier, SprueSingle, SprueInnerTree, SprueInnerBranches, SprueExternalTree, SprueMultipleCopies, SprueCurve, SprueExternalFrames, SprueTree, SprueClusterTree, SprueHelix, SprueSpiral, ResizeRing, QuickCheck
PricingApi	Calculate, CalculateDetailed, GetSettingsJson, ShowPanel, SetSetting
RenderApi	ShowRealtimeRender, UpdateRender, SetViewerCameraPreset, SetViewerCamera, ViewerZoomExtents, GetViewerItems, SetViewerMaterial, ViewerScreenshot, CreatePair, LieOnGround, ApplyDesignMaterials, ApplyRenderMaterials, BatchRender
RenderStudioApi	ListEnvironments, ListMaterialFamilies, ListMaterials, ApplyEnvironment, ApplyMaterial, RenderStill, RenderTurntable
NivodaApi	Search, ClearCache
FileSearchApi	Search, Count, Reindex
SemanticsApi	DescribeDocument
Transaction	Begin