@code3d/core 0.0.1-alpha.11 → 0.0.1-alpha.13

package/README.md

@@ -4,57 +4,71 @@ The TypeScript modeling runtime used by Code3D. Compose solids, profiles, curves
 points, and editable sketches; inspect their geometry and reuse the same models
 in the App or a supported Node.js runtime.
 
-Model constructors define the initial origin; derived operations inherit their main
-input frame. `group`, `union`, and `intersect` use the first member or operand,
-`cut` uses the stock, and `loft` uses the first section. See the
-[default origin rules](docs/local-coordinates.md#default-origin-rules)
-for all constructors and explicit origin operations.
-
-## Start with a model
+## Installation
 
 ```sh
 npm install @code3d/core
 ```
 
+The App includes Core in its built-in modeling runtime. If a project declares
+its own `@code3d/core`, the App uses that project's installed packages
+and declarations instead. See [project package installation](../web/src/content/docs/docs/getting-started/files.md#install-packages-in-browser-storage).
+
+## Example
+
+Place a part on a base, offset it, and rotate it around a chosen pivot.
+
 ```ts
-import {box, cylinder, group} from '@code3d/core';
+import {box, group, offset, pivot} from '@code3d/core';
 
-const base = box(40, 4, 24).fillet(1);
-const post = cylinder(3, 18).relate(self => self.on(base.up));
+const base = box(40, 8, 30);
+const part = box(14, 20, 12).relate(self => [
+  self.on(base.up), // Touch the base.
+  offset(6, 0, 0),
+  pivot([0, -10, 0]).rotate(0, 0, 25),
+]);
 
-export default group([base, post]);
+export default group([base, part]);
 ```
 
-Open this source in Code3D and select an expression to inspect its value. Node
-loads the modeling kernel through the package's Node entry automatically; normal
-model authors do not initialize it or manage evaluation caches themselves.
-
-The App includes Core, [Materials](../materials/README.md), and
-[Screws](../screws/README.md) for zero-install projects. When the active model's
-package scope or an ancestor `package.json` declares `@code3d/core`, the App uses that project's installed
-packages and declarations exclusively. Missing dependencies are errors. See
-[project package installation](../web/src/content/docs/docs/getting-started/files.md#install-packages-in-browser-storage)
-and the [agent file workflow](../../docs/agents/files.md).
-
-## Find the modeling API
-
-| Task                                                                            | Start here                                                                         |
-| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| Solids, planar profiles, curves, points, Boolean operations, extrusion and loft | [Modeling reference](docs/api.md)                                                  |
-| Place parts with bounds, align geometry or match coordinate frames              | [Relations](docs/relations.mdx)                                                    |
-| Change origins and rotate parts                                                 | [Origins and rotation](docs/origins-and-rotation.mdx)                              |
-| Hollow a solid or choose openings                                               | [Shells](docs/shells.mdx)                                                          |
-| Select vertices, edges and surfaces, or expose named elements                   | [Topology](docs/topology.md)                                                       |
-| Build reusable model functions                                                  | [Reusable models](../web/src/content/docs/docs/guides/reusable-models.mdx)         |
-| Give functions editing tools and example arguments                              | [Model tools](../web/src/content/docs/docs/guides/model-tools.mdx)                 |
-| Customize parameter and call inspection                                         | [Source inspection](docs/runtime.md#source-inspection)                             |
-| Extend the runtime with Replicad geometry                                       | [Custom primitives](docs/custom-primitives.mdx)                                    |
-| Known boundaries                                                                | [Current limitations](../web/src/content/docs/docs/getting-started/limitations.md) |
-
-See also [model values and measurements](docs/values.md), [editable sketches](docs/sketches.md),
-[text and fonts](docs/text.md), and [runtime integration](docs/runtime.md).
+![The relation example in the App, with a rotation gizmo on the tilted part and its rotation parameter panel open.](../web/src/assets/models/core-relate-tools.png)
+
+The part is rotated 25° around Z. In the App, select `rotate(0, 0, 25)` to show
+the rotation gizmo and parameter panel. Drag a ring or edit an angle to update
+the code.
+
+Complete example: [part placement and rotation](../app/examples/constraints/relate.ts).
+
+## Usage notes
+
+- Dimensions are in millimetres and angles are in degrees.
+- Models have local coordinate frames. Constructors choose the initial origin;
+  derived operations inherit their main input frame. See [local coordinates](docs/local-coordinates.md).
+- Modeling operations return new values. Measurements such as `.length`, `.area`
+  and `.volume` return numbers; select an expression in the App to inspect it.
+- Node loads the modeling kernel automatically. Model authors do not initialize
+  it or manage evaluation caches. See [runtime integration](docs/runtime.md).
+
+## Documentation
+
+- [Modeling API](docs/api.md): primitives, operations, materials and measurements.
+- [Model values](docs/values.md): immutable values and geometry measurements.
+- [Local coordinates](docs/local-coordinates.md): frames, origins and placement conventions.
+- [Relations](docs/relations.mdx): position parts using bounds, geometry and frames.
+- [Origins and rotation](docs/origins-and-rotation.mdx): choose a pivot and adjust a part.
+- [Shells](docs/shells.mdx): hollow solids and choose openings.
+- [Topology](docs/topology.md): select vertices, edges and faces and expose named elements.
+- [Editable sketches](docs/sketches.md): draw and constrain planar geometry.
+- [Text and fonts](docs/text.md): build geometry from text.
+- [Reusable models](../web/src/content/docs/docs/guides/reusable-models.mdx): compose model functions.
+- [Model tools](../web/src/content/docs/docs/guides/model-tools.mdx): add editing tools and argument presets.
+- [Custom primitives](docs/custom-primitives.mdx): extend modeling with Replicad geometry.
+- [Runtime integration](docs/runtime.md): resources, materials and source inspection.
+- [Current limitations](../web/src/content/docs/docs/getting-started/limitations.md): supported workflows and known boundaries.
 
 ## Source and development
 
-Start with the [public API](src/library/index.ts), [runtime tests](test/), and
-[development and integration notes](docs/runtime.md#source-and-development).
+- [Public API](src/library/index.ts): exported constructors and model interfaces.
+- [Runtime tests](test/): geometry, value semantics and integration coverage.
+- [Runtime development](docs/runtime.md#source-and-development): kernel integration and resource ownership.
+- [Development guide](../../.agents/docs/development.md): repository setup and test commands.

package/bld/chunks/{chunk-HZRQUHM2.js → chunk-776Q5P2L.js}

@@ -2,7 +2,7 @@ import {
   __name,
   castOwnedShape,
   primitiveConstructor
-} from "./chunk-JBVIAMJ6.js";
+} from "./chunk-VINZNODV.js";
 
 // packages/core/src/library/replicad.ts
 import * as replicadModule from "replicad";
@@ -27,4 +27,4 @@ export {
   replicad,
   definePrimitive
 };
-//# sourceMappingURL=chunk-HZRQUHM2.js.map
+//# sourceMappingURL=chunk-776Q5P2L.js.map

package/bld/chunks/{chunk-QK6ZET47.js → chunk-N7JJWNVL.js}

@@ -1,12 +1,12 @@
 import {
   installOpenCascade
-} from "./chunk-CL3E2DE4.js";
+} from "./chunk-VFPWXSFD.js";
 import {
   __name,
   installFontEngine,
   installModelResourceReader,
   installSketchSolver
-} from "./chunk-JBVIAMJ6.js";
+} from "./chunk-VINZNODV.js";
 
 // packages/core/src/node/index.ts
 import initOpenCascade from "@code3d/opencascade";
@@ -28,4 +28,4 @@ installSketchSolver(
     ), "locateFile")
   })
 );
-//# sourceMappingURL=chunk-QK6ZET47.js.map
+//# sourceMappingURL=chunk-N7JJWNVL.js.map

package/bld/chunks/{chunk-CL3E2DE4.js → chunk-VFPWXSFD.js}

@@ -2,7 +2,7 @@ import {
   __name,
   clearKernelOperationCache,
   setKernelNativeMemoryCounter
-} from "./chunk-JBVIAMJ6.js";
+} from "./chunk-VINZNODV.js";
 
 // packages/core/src/library/open-cascade.ts
 import { setOC } from "replicad";
@@ -16,4 +16,4 @@ __name(installOpenCascade, "installOpenCascade");
 export {
   installOpenCascade
 };
-//# sourceMappingURL=chunk-CL3E2DE4.js.map
+//# sourceMappingURL=chunk-VFPWXSFD.js.map