Whet user guide, chapter 3, 2026-10-09
Assemblies
An assembly places several parts and joins them. Whet solves the joints with FreeCAD's assembly solver, then writes the result as a STEP file, a FreeCAD document and an assembly record. The same record feeds the parts list, the interference check and, if you ask, a motion rig.
An assembly in Whet is simple on purpose. A joint ties two parts by a point you type on each, not by a face or an edge you click. That keeps it stable when a part is rebuilt. The limits section says what that costs.
Before you start
You need the parts as files in your project: solids you exported, or standard parts you built. In the Content browser, select the two files you want to join. The New Joint form opens on those two.
Make a joint
Choose Assembly > New Joint.... The form has these rows.
| Row | What it is |
|---|---|
| Assembly name | The name of the assembly file the form writes |
| First part, Second part | The two part files |
| Placed as | The name each part gets in the assembly |
| Held still | Which part is grounded, so the other moves to meet it |
| Kind | The joint kind |
| Leaves free | What the joint still lets move, in words, after it is solved |
| Joint at | Where the joint sits, as x, y, z in millimetres |
| First anchor, Second anchor | A point on each part, in that part's own frame |
| First face, Second face | For the four face joints, a side of each part |
| Distance, Angle | For the face joints that need one |
| Pitch | For a screw or a rack and pinion |
| First radius, Second radius | For gears and belts |
| Measure overlap | Also check whether the two solids overlap |
| Overlap allowed | The volume of overlap you accept, 1 mm3 by default |
A row the chosen kind does not use is greyed and says why. A revolute joint has no pitch, for example, and no radii.
A line at the bottom of the form shows the assembly file as it will be written. Press Assemble to write it and solve it.
Joint kinds
Assembly > Joints lists all thirteen kinds. Each opens the same form on that kind.
| Kind | What the second part can still do |
|---|---|
| Fixed | Nothing. The two anchor frames are held together. |
| Revolute | Turn about the anchor's z axis |
| Cylindrical | Turn about and slide along the z axis |
| Slider | Slide along the z axis |
| Ball | Turn about the anchor point in any direction |
| Rack and Pinion | The pinion turns and the rack travels by the pitch |
| Screw | Turn about its axis and travel along it by the pitch |
| Gears | Each wheel turns about its own anchor, coupled by the two radii |
| Belt | Each pulley turns about its own anchor, coupled by the two radii |
| Distance | Slide in the first face's plane and turn about its normal, with the second face held parallel at the distance |
| Parallel | Move anywhere and turn about the first face's normal |
| Perpendicular | Move anywhere and turn so the two normals stay square |
| Angle | Move anywhere and turn so the angle between the two normals holds |
The first five place a part. Rack and Pinion, Screw, Gears and Belt tie the motion of two parts together. They do not move the part on their own. A gear ratio is two measured radii, not a typed ratio. A screw without a pitch is refused, because without a pitch it is a hole and not a screw.
The four face joints take a side of each part, such as top, bottom, +x or -x. The form lists the sides first and adds the part's own flat faces once the kernel has listed them.
An anchor is typed, not picked
Whet cannot yet turn a picked face into an anchor frame. You type the point. For two boxes, a big one 60 by 40 by 10 mm and a small one 20 by 20 by 10 mm, a revolute joint with the first anchor at 20, 10, 10 on the big box's top face assembles into a tree of the big box, the joint and the small box. The solve measures 2 parts, 1 joint and 28000 mm3, which is 24000 plus 4000, with no overlap.
If you leave both anchors at their parts' own origins, the small box sits inside the big one. The overlap check reports 4000 mm3 shared, which is 20 by 20 by 10. That is the check doing its job.
Assemble
Assembly > Assemble... (Command-Shift-B on macOS, Control-Shift-B elsewhere) solves an assembly file you already have. Assemble with Rig... does the same and also writes a motion rig. Stop Assembling stops a run in progress.
The run writes the assembly as a STEP file and a FreeCAD document, and an assembly record. The Model Tree then shows the assembly as a tree, for example "stack / big / revolute joint #1 / small".
An assembly can hold other assemblies. A part used many times is built once, and a sub-assembly used many times is solved once, which makes large assemblies faster. A large assembly still takes time. A 211-part engine took 171 seconds on an Apple M2 in the last measurement.
The rig
With a rig, each part becomes a body at its solved position. It takes its density from its material card for mass. The grounded part is welded to the world. Fixed becomes a weld, Revolute a hinge and Slider a slide. Motion runs it.
The rig is written only when every part qualifies. If the assembly has other joint kinds, a part with no material, or a part placed as a bare STEP file, no rig is written, and the record names what was left out. A rig starts with a welded base, no drive and no limit. Motion > Drives and Limits... frees, lifts and drives it.
Interference
Tick Measure overlap in the New Joint form. Whet then checks every pair of placed solids for shared volume above the tolerance you gave. A pair that shares volume is named with the amount.
An empty result means every pair was checked and none overlapped. Without the tick, no pair is checked, and the report says so.
Standard parts
Part > Standard Part... builds fasteners, nuts, washers and bearings from a standard's figures. Choose a Family, a Size and a Length, or type a Designation such as ISO 4762 M8x30, ISO 4032 M8, ISO 7089 M8 or 6002. Name the part and press Build. The page shows every figure and the standard it came from.
There is no thread: the shank is a plain cylinder at the nominal major diameter. There is no fillet under the head and no chamfer at the end. The solid is the heaviest the standard allows.
Use a standard part for clearance and for the space it takes, not for engagement. Whet does not claim any clause number of a standard.
The parts list
Assembly > Bill of Materials... opens the parts list of a solved assembly. Nothing is measured again. It reads the records the build already wrote.
There is one row per distinct item, with its level (1 for placed directly, 2 for inside a sub-assembly, and so on), count, standard, file, material, density, mass each and mass total. Two placements of one file are one item with a count of 2.
The list gives two masses side by side. The rolled-up mass adds the level 1 rows from each part's own build. The measured mass weighs the same parts from the volume of the assembled document. They agree to a rounding unit. A difference past that is shown as a mismatch.
What the list cannot say:
- A part with no material has no mass, and the total says how many rows were left unweighed. It is not shown as zero.
- A purchased part has no mass, because a standard gives a shape and not a material.
- A part built from two specs of two names is counted twice. Whet does not guess that they are the same.
- There is no price, currency, lead time, vendor or part number anywhere in the list.
Assembly > Wire Route... opens a page for routing wires. This guide does not cover it (to be checked).
Limits
- Tool reach is not on the form. Whet can test whether a tool reaches a fastener, but only when you write it in the assembly file. The test uses a declared cylinder along the fastener's axis. It is not a model of a tool. It has no swing and no hand around it.
- Explode is not available. Parts sit only where their joints hold them.
- A joint cannot name a picked face or edge for its anchors. Anchors are typed. The four face joints take a side or a flat face from a list.
- The BOM holds no pricing and does not appear on a drawing sheet. Drawings have no parts list yet. See Drawings and measuring.
More are listed in Known limits.