extrudo

API docs

Point

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

One feature of the timeline, in the construct category. Its name follows the app's (Point1, then Point2, …); 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
at GeomRef | GeomRef[] (point, vertex, edge, face) optional What it starts from: a vertex, a point, a circular edge (its centre) or a face (its centre). Without one, the origin.
x string | number | ParameterHandle default 0 How far it moves along the world X axis; a length.
y string | number | ParameterHandle default 0 How far it moves along the world Y axis; a length.
z string | number | ParameterHandle default 0 How far it moves along the world Z axis; a length.

Faces

This feature makes no face of its own, so handle.face(role) has no role to take. Its result keeps the names of the bodies it worked on, so a reference to one of those still resolves.

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';

// Point.
d.constructionPoint({ x: '10 mm', y: '20 mm', z: '5 mm' });

See also