extrudo

API docs

Import

d.import(inputs, options?): FeatureHandle<'import'>

One feature of the timeline, in the create category. Its name follows the app's (Import1, then Import2, …); options.name gives it another, options.id its ID and options.index its place in the timeline. Inputs the table calls optional keep the default it names, so a call with none of them still makes a valid feature.

Inputs

Input Type Required or default What it does
file string (an attachment ID) required The file to import: an attachment of this design with a model/* media type (a STEP solid or a mesh).
units 'auto' | 'mm' | 'cm' | 'm' | 'in' default auto Meshes only: what unit the file's numbers are in (auto takes a 3MF's own). STEP converts its own units.
up 'z' | 'y' default z The file's up axis; y turns it +90° about X (Y-up to Z-up).

Faces

Role What it is
face:<n> A face of the imported solid, in the order the file's B-rep has them.
mesh A mesh body's one face: a mesh is a single face of triangles (ADR-0066 §3).

handle.face(role) builds a reference to one of them and handle.faceName(role) its persistent name. A <…> is what varies: a side:<sketch curve> is the wall of the curve you pass, and a role of a face that no face carries takes that part out. A role this feature never names is a lost reference — a visible error, never a silent guess.

Example

import { Design, type LineHandle } from '@extrudo/api';

const d = Design.create({ name: 'My part' });

// Two solids to point faces, edges and bodies at.
const plate = d.box({ length: '40 mm', width: '20 mm', height: '10 mm' });
const shaft = d.cylinder({ diameter: '20 mm', height: '20 mm' });

// A sketch with two closed profiles, a hole and a guide line beside them.
let guide!: LineHandle;
const s = d.sketch(d.origin.xy, (k) => {
  k.rectangle([0, 0], [40, 20]);
  k.circle([10, 10], '3 mm');
  k.rectangle([50, 0], [60, 10]);
  guide = k.line([-5, 30], [45, 30]);
});

const profile = s.profileAt([1, 1]);
const sections = s.profiles();
const line = guide.ref();
const face = plate.face('side:front');
const edge = plate.edge([plate.faceName('side:front'), plate.faceName('side:right')]);
const vertex = plate.vertex([plate.faceName('side:front'), plate.faceName('side:right')]);
const corner = plate.vertex([plate.faceName('side:front'), plate.faceName('side:left')]);
const body = plate.body();
const step = 'att-part.step'; // an attachment of the design
const plan = 'att-plan.png';

// Import.
d.import({ file: step });

See also