Results
Plain records with read-only meaning: the methods that return them fill them in.
AdvancedGemsOnCurveResult
What AdvancedGemsOnCurveApi.Create hands back: the parametric group id (the Unique of its RaObjectUserData, what ArtisanEdit uses) and the gems.
| Property | Type | |
|---|
Carats | double | |
Count | int | |
GemIds | IReadOnlyList<Guid> | |
Unique | Guid | |
AiImageResult
An image generated with fal.ai.
| Property | Type | |
|---|
Mode | string | Generative AI Studio mode the prompt was tuned for |
Model | string | fal.ai model used (Options > Assistant: Image / Text-to-image model) |
Path | string | The image file written |
Source | string | What the image was made from: “viewport”, “prompt” or the source file |
AllInOneExport
| Property | Type | |
|---|
AllPrintable | bool | false = some objects had errors |
Faces | int | triangles in the STL |
NonPrintableIds | IReadOnlyList<Guid> | |
ObjectCount | int | objects merged |
Path | string | STL written |
AssetInfo
| Property | Type | |
|---|
Id | int | |
IsDefault | bool | True for the asset the Create methods use when no profile is given. |
Name | string | |
PointCount | int | Control points of the half profile (a rough complexity hint). |
Semantic | string | |
Type | string | TypeOfAssetBackend name |
AzureResult
What AzureApi.Create baked: the carved solid (boolean on) or the loose cutters (boolean off), plus the thinnest metal wall left between two neighbouring holes (-1 when there is a single hole).
| Property | Type | |
|---|
CutterIds | IReadOnlyList<Guid> | cutter ids (empty when boolean is on) |
Holes | int | azure holes generated (one per gem that projected onto the solid) |
MinWallDistance | double | mm between the two closest holes; -1 with fewer than two holes |
ResultId | Guid | carved solid id (Guid.Empty when boolean is off) |
BalanceReport
| Property | Type | |
|---|
Applied | bool | true = the corrected copies were added |
BasePoint | Point3d | center of the base object’s bounding box (the hook) |
Centroid | Point3d | volume centroid of the hanging geometry |
IsBalanced | bool | TiltDegrees below tolerance |
NewIds | IReadOnlyList<Guid> | the rotated copies when applied |
TiltDegrees | double | angle between the hang line and straight down; 0 = balanced |
BatchRenderResult
| Property | Type | |
|---|
Failed | IReadOnlyList<string> | file NAMES whose image was not produced |
OutputFiles | IReadOnlyList<string> | full paths of the images written |
Processed | int | .3dm files opened and attempted |
BoutiqueCatalogDesign
A design of an installed Boutique collection.
| Property | Type | |
|---|
Available | bool | Whether the design’s file is on this computer (Insert needs it) |
Collection | string | Collection name, e.g. “Solitaires” |
CollectionFolder | string | Collection folder name (stable; use it to disambiguate) |
Currency | string | Currency of the prices |
Description | string | Design description |
Id | string | Design id within its collection |
Name | string | Design name |
Preview | string | Preview image file (empty when there is none) |
RegularPrice | string | Retail price as the collection lists it (text, may be empty) |
SalePrice | string | Sale price as the collection lists it (text, may be empty) |
Sku | string | Design SKU |
BoutiqueKit
A kit of the online Boutique catalog.
| Property | Type | |
|---|
Date | string | Publication date |
Folder | string | Folder it installs into |
Installed | bool | Whether its folder is on this computer |
Name | string | Kit name |
Type | string | ”collections” or “components” |
UpToDate | bool | Installed and not updated in the catalog since |
CutByRingSizeResult
| Property | Type | |
|---|
CutCount | int | objects cut |
Diameter | double | cylinder diameter used, mm |
FailedCount | int | objects the boolean could not cut |
FailedIds | IReadOnlyList<Guid> | untouched originals |
ObjectIds | IReadOnlyList<Guid> | the new (cut) objects |
DecimateResult
| Property | Type | |
|---|
FacesAfter | int | |
FacesBefore | int | |
MeshesDecimated | int | |
DecimateToleranceResult
| Property | Type | |
|---|
MaxDeviationMm | double | Largest deviation across every decimated mesh, in mm. |
MeshesDecimated | int | |
MeshesUnchanged | int | |
TrianglesAfter | int | |
TrianglesBefore | int | In TRIANGLES: the reducer triangulates quads, so a quad mesh’s Faces.Count is not comparable with the result’s. |
DimensionValueReport
Result of DraftingExtraApi.ReduceDimensions().
| Property | Type | |
|---|
Changed | int | |
Percentage | double | |
Skipped | int | |
DismantledBoolean
One dismantled boolean, as listed by ListDismantled.
| Property | Type | |
|---|
CutterIds | IReadOnlyList<Guid> | |
Id | Guid | |
MissingIds | IReadOnlyList<Guid> | |
Operation | string | |
TargetIds | IReadOnlyList<Guid> | |
ElementInfo
One saved element in the user’s library.
| Property | Type | |
|---|
Favorite | bool | |
Id | Guid | |
Name | string | |
Type | string | |
ElementsExport
| Property | Type | |
|---|
Count | int | elements in the file |
Path | string | JSON written |
Type | string | library type exported (store name, e.g. “BEZEL”) |
ElementsImport
| Property | Type | |
|---|
Duplicates | int | elements that already existed (skipped) |
Imported | int | new elements added to the library |
Names | IReadOnlyList<string> | names of the imported elements |
Path | string | |
GemsOn2CurvesResult
What GemsOn2CurvesApi.Create hands back: the parametric group id (the Unique of its RaObjectUserData, what ArtisanEdit uses), the gem ids and the prong ids (empty unless prongs was requested).
| Property | Type | |
|---|
Carats | double | |
Count | int | |
GemIds | IReadOnlyList<Guid> | |
ProngIds | IReadOnlyList<Guid> | |
Unique | Guid | |
GlbBatchItem
One file of a GLB batch.
| Property | Type | |
|---|
Error | string | Why it failed (empty otherwise) |
Glb | string | The .glb next to it |
Source | string | The .3dm read |
Status | string | ”exported”, “skipped” (the GLB was already there) or “failed” |
GlobalThicknessResult
| Property | Type | |
|---|
AverageMm | double | mean over measurable samples |
MaxMm | double | thickest measured wall |
MeshId | Guid | colorized mesh when colorize=true, else Guid.Empty |
MinMm | double | thinnest measured wall |
SampleCount | int | vertices with a valid measurement |
ThinPercentage | double | % of measurable samples below the threshold — the figure the command prints on the command line |
ThinSpots | IReadOnlyList<ThinSpot> | |
UnmeasurableCount | int | vertices where no wall was found |
LayerExport
| Property | Type | |
|---|
Faces | int | triangles written |
Layer | string | layer name (= file name) |
Path | string | STL written, or the existing file when skipped |
Skipped | bool | true = file existed and overwrite was false |
LayerImport
| Property | Type | |
|---|
FilePath | string | STL imported |
Ids | IReadOnlyList<Guid> | |
Layer | string | layer it went to (file name without extension) |
ObjectCount | int | objects the file brought in |
MeshCheckResult
| Property | Type | |
|---|
Id | Guid | |
IsClosed | bool | |
IsManifold | bool | |
IsValid | bool | |
Printable | bool | valid, closed AND manifold/oriented — the same green/red verdict the tool paints (QuickCheckCommand.IsPrintable) |
One metal position of the document (or an ad-hoc object set).
| Property | Type | |
|---|
Grams | double | cast weight |
Layer | string | e.g. “Metal 01” (or “Metal 01+02+03” when the doc uses one metal) |
Metal | string | Metal enum name, e.g. “GOLD_YELLOW_18” |
ProcessedGrams | double | after the configured finishing loss % |
Volume | double | model units^3 (mm3 in a mm document) |
WaxGrams | double | wax model weight at the configured wax density |
NonPrintableReport
| Property | Type | |
|---|
BadObjects | IReadOnlyList<Guid> | Rhino’s SelBadObjects |
Count | int | objects flagged (now selected) |
Duplicates | IReadOnlyList<Guid> | SelDup |
OpenPolysurfaces | IReadOnlyList<Guid> | SelOpenPolysrf |
OpenSurfaces | IReadOnlyList<Guid> | SelOpenSrf |
PaveResult
Everything one pavé run created, split by kind.
| Property | Type | |
|---|
All | IReadOnlyList<Guid> | Gems + prongs + cutters, for “select everything I just built”. |
Cutters | IReadOnlyList<Guid> | |
Gems | IReadOnlyList<Guid> | |
Prongs | IReadOnlyList<Guid> | |
PriceBreakdownDetails
Result of PricingApi.CalculateDetailed(): the panel’s line-level detail. All costs in the manufacturer’s currency; weights in grams; sizes in mm.
PriceDiamondLine
| Property | Type | |
|---|
Carats | double | |
CertificateId | string | |
Dealer | string | |
LabGrown | bool | |
Price | double | |
Quoted | bool | false = no live Nivoda quote (offline, quoteCertified = false, or no match): the stone counts in the carat totals but prices as 0. |
Shape | string | |
PriceGemLine
| Property | Type | |
|---|
Carats | double | |
Cost | double | |
Count | int | |
PricePerCarat | double | |
SettingType | string | |
Shape | string | |
Sieve | string | |
SizeMm | double | |
| Property | Type | |
|---|
Cost | double | |
Metal | string | |
PricePerGram | double | |
TotalWeightGrams | double | |
Waste | double | |
WeightGrams | double | |
| Property | Type | |
|---|
CastFinishPolishCost | double | |
FinishingCost | double | |
Metal | string | |
PrintingCost | double | |
PrintingSize | string | |
RhodiumCost | double | |
PriceNamedCost
| Property | Type | |
|---|
Cost | double | |
Name | string | |
PriceResult
Result of PricingApi.Calculate(): the grand total plus the per-category breakdown, in the active manufacturer’s currency. TotalFormatted is the total already rendered with the currency symbol (e.g. “1,234.00 €”).
| Property | Type | |
|---|
Currency | string | |
Diamonds | double | |
Extras | double | |
Gems | double | |
Metal | double | |
Processes | double | |
Total | double | |
TotalFormatted | string | |
PriceSettingProcessLine
| Property | Type | |
|---|
Cost | double | |
Count | int | |
SettingType | string | |
ReduceThicknessResult
| Property | Type | |
|---|
FinalGrams | double | weight after |
GramsSaved | double | |
MaskedNearGems | int | vertices protected around gems |
MeshId | Guid | the hollowed mesh (replaces the original) |
OriginalGrams | double | weight before, first document metal (0 = open mesh) |
ThinVertices | int | vertices that ended below the target thickness |
ReliefOperationInfo
| Property | Type | |
|---|
CombineMode | string | |
Enabled | bool | |
Id | Guid | |
Index | int | Position in the stack, 0 = first applied. |
MissingReferences | bool | True when a referenced curve/object no longer resolves or a referenced image/texture file is missing; the operation is skipped. |
Name | string | |
Type | string | ”profile”, “extrude”, “image”, “texture”, “geometry”, “carbon”, “sculpt” or “smooth”. |
ReliefProjectInfo
| Property | Type | |
|---|
CapDistance | double | |
DeleteBase | bool | |
Exists | bool | False when the document has no saved relief project. |
OperationCount | int | |
OutputType | string | ”Mesh” (open relief) or “Thickness” (closed solid). |
Resolution | int | |
WorldHeight | double | |
WorldWidth | double | |
RepairResult
| Property | Type | |
|---|
IsClosed | bool | true = watertight, printable |
MeshId | Guid | the repaired watertight mesh added to the doc |
NakedEdges | int | remaining open edges (0 is what you want) |
Shells | int | number of separate shells in the result |
ResizedRing
| Property | Type | |
|---|
Diameter | double | target inner diameter (mm) |
Name | string | size label, also the child layer suffix |
RingId | Guid | the resized ring mesh |
RingSizeEstimate
| Property | Type | |
|---|
InnerDiameter | double | measured gap along X at Z=0, mm |
InnerHeight | double | measured gap along Z at X=0, mm (0 = open/unknown) |
IsRing | bool | enough ring-like features found |
Probability | double | 0..100 score |
Region | string | sizing region used for the lookup |
RingCurveId | Guid | inserted ring curve (addRingCurve), else Empty |
Size | string | closest catalog size label |
SizeDiameter | double | catalog diameter of that size, mm |
RingSizeInfo
| Property | Type | |
|---|
Diameter | double | inner diameter, mm |
Region | string | e.g. “EU”, “US” |
Size | string | e.g. “54”, “7” |
StandardizeResult
| Property | Type | |
|---|
BlocksExploded | int | block definitions the document had |
MaterialsLeft | int | materials Rhino refused to remove (0 normally) |
MaterialsRemoved | int | render materials purged |
SweepResult
What the rail sweeps bake: the oriented profile curves (plus the inner curves of the CLOSE / COMFORT / THICKNESS modes) and, when sweep is true, the swept breps.
| Property | Type | |
|---|
BrepIds | IReadOnlyList<Guid> | |
CurveIds | IReadOnlyList<Guid> | |
TaxRegion
One entry of PricingExtraApi.TaxRegions(): the code to pass as region and its display name.
| Property | Type | |
|---|
Code | string | |
Name | string | |
TechnicalChartGem
| Property | Type | |
|---|
Carats | double | |
Count | int | |
SettingType | string | |
Shape | string | |
Sieve | string | |
SizeMm | double | |
| Property | Type | |
|---|
AreaMm2 | double | |
Metal | string | |
TotalWeightGrams | double | |
VolumeMm3 | double | |
WasteGrams | double | |
WaxWeightGrams | double | |
WeightGrams | double | |
| Property | Type | |
|---|
InvalidSize | bool | |
Metal | string | |
PrintSizeName | string | |
PrintingSize | string | |
TechnicalChartResult
Result of DraftingExtraApi.CreateTechnicalChart(): the breakdown without prices. Weights in grams, sizes in mm, volume in mm3, area in mm2.
TechnicalChartSettingProcess
| Property | Type | |
|---|
Count | int | |
SettingType | string | |
ThinSpot
| Property | Type | |
|---|
Point | Point3d | vertex position on the analysis mesh |
ThicknessMm | double | wall thickness measured there |
TimeTrackingDay
Time on every file on one day.
| Property | Type | |
|---|
Date | string | ”yyyy-MM-dd” (local day) |
Hours | double | Same, in hours |
Seconds | int | Seconds worked that day |
TimeTrackingFile
Time on one file within the report’s period.
| Property | Type | |
|---|
Days | int | Days with time on it |
Hours | double | Same, in hours |
LastDate | string | Last day with time on it, “yyyy-MM-dd” |
Name | string | File name, e.g. “Solitaire.3dm” (the panel groups by it) |
Path | string | Full path where it was last worked on |
Seconds | int | Seconds worked in the period |
TimeTrackingReport
A time report over a period of days.
| Property | Type | |
|---|
Daily | IReadOnlyList<TimeTrackingDay> | Per day, oldest first |
Enabled | bool | Whether the tracker is counting time now (Options) |
Files | IReadOnlyList<TimeTrackingFile> | Per file, most worked first |
From | string | First day of the period, “yyyy-MM-dd” (empty for ALL) |
IdleThresholdMinutes | int | Minutes without keyboard or mouse after which time stops counting |
Period | string | ALL, TODAY, WEEK (since Monday) or MONTH |
To | string | Today, “yyyy-MM-dd” |
TotalHours | double | Same, in hours |
TotalSeconds | int | Seconds on every file in the period |
TrilogyResult
What a Trilogy setting call baked: the three stones it was built on (existing ids, never rebaked), the ring curve it was measured against (the Three Stones finger circle when the set came from ArtisanThreeStones) and the new metal / stone objects, all grouped under GroupName with Unique as the editable object’s identity.
| Property | Type | |
|---|
CenterGemId | Guid | |
GroupName | string | |
MetalIds | IReadOnlyList<Guid> | |
RingCurveId | Guid | |
SideAGemId | Guid | |
SideBGemId | Guid | |
StoneIds | IReadOnlyList<Guid> | |
Style | string | |
Unique | Guid | |
UpdateResult
Outcome of UpdateAll / Update.
| Property | Type | |
|---|
Found | int | |
Messages | IReadOnlyList<string> | |
Rebuilt | int | |
ResultIds | IReadOnlyList<Guid> | |
Skipped | int | |