Skip to main content

Module structure

Module structure 

Source
Expand description

Product structure: parts, assemblies, instances with placements.

A Document owns a [Model] and a table of products over it. A part is a product with a shape; an assembly is a product with instances, each naming a product and carrying a placement. Instancing leans directly on the location chain (docs/DATA_MODEL.md §2): every instance’s placement is a datum in the model’s own store, an occurrence of a part is the part’s shape moved by the chain of placements above it, and ten thousand identical fasteners are ten thousand chains over one node.

Appearance and naming ride alongside: a colour or a name attaches to a product or to a topology node (a whole part or one face of it), and resolution walks from the most specific to the least.

Structs§

Colour
An RGBA colour, each channel in [0, 1].
Document
A model with product structure, appearance and names over it.
Instance
One use of a product inside an assembly: which product, where, and what this particular occurrence is called.
Occurrence
A placed part: the flattening of an assembly tree into shapes.
Product
One product: a name, an optional colour, and what it is.
ProductId
A product in a document: a part or an assembly.

Enums§

ProductKind
What a product is: geometry, or uses of other products.