Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
import {
AltiumExtensionResolver,
PcbScene3dBuilder as AltiumScene3dBuilder,
PcbScene3dModelRegistry as AltiumScene3dModelRegistry,
PcbScene3dScenePreparator as AltiumScene3dScenePreparator
} from 'altium-toolkit/extensions'
import {
PcbScene3dBuilder as KicadScene3dBuilder,
KicadScene3dModelRegistryAdapter,
KicadScene3dSilkscreenSmoothingAdapter,
PcbScene3dScenePreparator as KicadScene3dScenePreparator
} from 'kicad-toolkit/extensions'
import {
PcbScene3dBuilder as GerberScene3dBuilder,
PcbScene3dScenePreparator as GerberScene3dScenePreparator
} from 'gerber-toolkit/extensions'
import { PcbScene3dCircuitJsonAdapter } from 'pcb-scene3d-viewer/scene3d'
import { EcadCircuitJsonContext } from './EcadCircuitJsonContext.mjs'
import { EcadFormatRegistry } from './EcadFormatRegistry.mjs'
import { EcadGerberFabrication } from './EcadGerberFabrication.mjs'
/**
* Chooses format-specific 3D scene builders.
*/
export class EcadScene3dService {
/**
* Builds a scene description.
* @param {object} documentModel Document model.
* @param {object} [options] Scene options.
* @returns {object}
*/
static build(documentModel, options = {}) {
const altiumDocument =
AltiumExtensionResolver.nativeModel(documentModel)
if (altiumDocument) {
return AltiumScene3dBuilder.build(altiumDocument, options)
}
const gerberDocument =
EcadGerberFabrication.nativeDocument(documentModel)
if (gerberDocument) {
return KicadScene3dSilkscreenSmoothingAdapter.applyScene(
GerberScene3dBuilder.build(gerberDocument, options)
)
}
if (EcadScene3dService.#isCircuitJson(documentModel)) {
return EcadScene3dService.#buildCircuitJsonScene(
documentModel,
options
)
}
if (EcadScene3dService.#isGerber(documentModel)) {
return KicadScene3dSilkscreenSmoothingAdapter.applyScene(
GerberScene3dBuilder.build(documentModel, options)
)
}
if (EcadScene3dService.#isKiCad(documentModel)) {
return KicadScene3dBuilder.build(
documentModel,
EcadScene3dService.#kicadSceneOptions(options)
)
}
return AltiumScene3dBuilder.build(documentModel, options)
}
/**
* Prepares a scene description asynchronously.
* @param {object} documentModel Document model.
* @param {object} [options] Scene options.
* @returns {Promise<object>}
*/
static async prepare(documentModel, options = {}) {
const altiumDocument =
AltiumExtensionResolver.nativeModel(documentModel)
if (altiumDocument) {
return AltiumScene3dScenePreparator.prepare(altiumDocument, options)
}
const gerberDocument =
EcadGerberFabrication.nativeDocument(documentModel)
if (gerberDocument) {
return KicadScene3dSilkscreenSmoothingAdapter.applyScene(
await GerberScene3dScenePreparator.prepare(
gerberDocument,
options
)
)
}
if (EcadScene3dService.#isCircuitJson(documentModel)) {
return EcadScene3dService.#buildCircuitJsonScene(
documentModel,
options
)
}
if (EcadScene3dService.#isGerber(documentModel)) {
return KicadScene3dSilkscreenSmoothingAdapter.applyScene(
await GerberScene3dScenePreparator.prepare(
documentModel,
options
)
)
}
if (EcadScene3dService.#isKiCad(documentModel)) {
return KicadScene3dScenePreparator.prepare(
documentModel,
EcadScene3dService.#kicadSceneOptions(options)
)
}
return AltiumScene3dScenePreparator.prepare(documentModel, options)
}
/**
* Creates the model registry expected by the chosen scene builder.
* @param {object} documentModel Document model.
* @param {object[]} sessionAssets Session assets.
* @returns {object}
*/
static createModelRegistry(documentModel, sessionAssets) {
const altiumDocument =
AltiumExtensionResolver.nativeModel(documentModel)
if (altiumDocument) {
return AltiumScene3dModelRegistry.create(
sessionAssets || [],
Array.isArray(altiumDocument?.pcb?.embeddedModels)
? altiumDocument.pcb.embeddedModels
: []
)
}
if (EcadScene3dService.#isCircuitJson(documentModel)) {
return null
}
if (EcadScene3dService.#isGerber(documentModel)) {
return null
}
if (EcadScene3dService.#isKiCad(documentModel)) {
return new KicadScene3dModelRegistryAdapter(sessionAssets || [])
}
return AltiumScene3dModelRegistry.create(
sessionAssets || [],
Array.isArray(documentModel?.pcb?.embeddedModels)
? documentModel.pcb.embeddedModels
: []
)
}
/**
* Returns true for KiCad document models.
* @param {object} documentModel Document model.
* @returns {boolean}
*/
static #isKiCad(documentModel) {
return (
EcadFormatRegistry.sourceFormatForDocument(documentModel) ===
'kicad'
)
}
/**
* Builds KiCad scene options with the app's stricter model registry.
* @param {object} options Scene options.
* @returns {object}
*/
static #kicadSceneOptions(options) {
return {
...options,
modelRegistry:
options?.modelRegistry ||
new KicadScene3dModelRegistryAdapter(
options?.sessionAssets || []
)
}
}
/**
* Builds a 3D scene for standards-native element arrays.
* @param {object | object[]} documentModel Document model.
* @param {object} options Scene options.
* @returns {object}
*/
static #buildCircuitJsonScene(documentModel, options) {
const sourceContext = EcadCircuitJsonContext.prepare(documentModel, {
indexes: ['elements']
})
if (!EcadScene3dService.#hasCircuitJsonSceneGeometry(sourceContext)) {
return documentModel
}
return PcbScene3dCircuitJsonAdapter.build(sourceContext, options)
}
/**
* Returns true when the element array contains 3D-relevant PCB rows.
* @param {object | object[]} documentModel Document model.
* @returns {boolean}
*/
static #hasCircuitJsonSceneGeometry(documentModel) {
return EcadScene3dService.#circuitJsonElements(documentModel).some(
(element) =>
[
'cad_component',
'pcb_board',
'pcb_component',
'pcb_cutout',
'pcb_hole',
'pcb_panel',
'pcb_plated_hole',
'pcb_smtpad',
'pcb_trace',
'pcb_via'
].includes(String(element?.type || ''))
)
}
/**
* Returns element rows from an array or wrapper object.
* @param {object | object[]} documentModel Document model.
* @returns {object[]}
*/
static #circuitJsonElements(documentModel) {
return EcadFormatRegistry.circuitJsonElementsForDocument(documentModel)
}
/**
* Returns true for standards-native CircuitJSON document models.
* @param {object | object[]} documentModel Document model.
* @returns {boolean}
*/
static #isCircuitJson(documentModel) {
return EcadFormatRegistry.isCircuitJsonDocument(documentModel)
}
/**
* Returns true for Gerber fabrication document models.
* @param {object} documentModel Document model.
* @returns {boolean}
*/
static #isGerber(documentModel) {
return (
EcadFormatRegistry.sourceFormatForDocument(documentModel) ===
'gerber'
)
}
}
5f635a4c0This file is pinned to the selected release. Download the original to open it in your design tool.