babylonbridge 0.1.0

package/README.md

@@ -0,0 +1,72 @@
+<div align="center">
+
+# Babylonbridge
+
+### A small, explicit bridge from portable 3D descriptions to Babylon.js.
+
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178c6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![Module](https://img.shields.io/badge/module-ESM-f7df1e?logo=javascript&logoColor=111827)](package.json) [![Babylon.js peer](https://img.shields.io/badge/Babylon.js-peer-BB464B?logo=babylondotjs&logoColor=white)](https://www.babylonjs.com/) [![Status](https://img.shields.io/badge/status-pre--alpha-f5a623)](https://shaderlab.dev)
+
+[shaderlab.dev](https://shaderlab.dev)
+
+</div>
+
+Babylonbridge materializes Web3D Kit descriptors as Babylon.js runtime objects.
+It keeps scene descriptions portable while leaving rendering, asset loading, and
+resource ownership explicit.
+
+## Install
+
+```sh
+npm install @babylonjs/core babylonbridge web3d-kit
+```
+
+`@babylonjs/core` is a peer dependency: applications choose and own their
+Babylon.js version. `babylonbridge` does not bundle it.
+
+```ts
+import { mesh, planeGeometry, shaderMaterial } from "web3d-kit";
+import { createBabylonObject } from "babylonbridge";
+
+const object = createBabylonObject(
+  mesh({
+    geometry: planeGeometry({ width: 2, height: 2 }),
+    material: shaderMaterial({ vertexShader, fragmentShader }),
+  }),
+  babylonScene,
+);
+```
+
+## Architecture
+
+```text
+shader-runtime        webgl-kit
+      │                  │
+      └─────────┬────────┘
+                ▼
+            web3d-kit
+                │
+                ▼
+          babylonbridge
+                │
+                ▼
+           Babylon.js
+```
+
+`shader-runtime` owns shared animation scheduling and `webgl-kit` owns
+low-level WebGL plumbing. `web3d-kit` owns portable descriptions;
+`babylonbridge` materializes them as Babylon.js objects without taking
+ownership of shader source or asset loading.
+
+## Supported conversions
+
+- vectors, transforms, bounds, scenes, groups, meshes, and cameras
+- plane, box, sphere, and simple position/index buffer geometry
+- basic, standard/PBR, and shader materials
+- scalar and vector shader uniforms
+- caller-owned URL textures, with explicit wrapping/filter options
+
+## Lifecycle
+
+Use `disposeGeometry`, `disposeMaterial`, `disposeTexture`, or
+`disposeObjectTree` explicitly. `disposeObjectTree` disposes mesh geometry and
+materials; textures remain caller-owned because they are commonly shared.

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import { AbstractMesh, Engine, FreeCamera, Mesh, PBRMaterial, Scene, ShaderMaterial, StandardMaterial, Texture, TransformNode, Vector2, Vector3, Vector4 } from "@babylonjs/core";
+import type { Bounds3D, CameraDescriptor, GeometryDescriptor, MaterialDescriptor, SceneDescriptor, SceneNode, TextureDescriptor, Transform3D, UniformMap, Vec2, Vec3, Vec4 } from "web3d-kit";
+export declare function toBabylonVector2(value: Vec2): Vector2;
+export declare function toBabylonVector3(value: Vec3): Vector3;
+export declare function toBabylonVector4(value: Vec4): Vector4;
+type BabylonTransformTarget = {
+    position: Vector3;
+    rotation: Vector3;
+    scaling?: Vector3;
+};
+export declare function applyBabylonTransform<T extends BabylonTransformTarget>(target: T, transform: Transform3D | undefined): T;
+export declare function toBabylonBounds(bounds: Bounds3D): {
+    min: Vector3;
+    max: Vector3;
+};
+export declare function toBabylonGeometry(descriptor: GeometryDescriptor, scene?: Scene | null): Mesh;
+export declare function toBabylonUniforms(uniforms?: UniformMap): UniformMap;
+export declare function toBabylonMaterial(descriptor: MaterialDescriptor, scene: Scene): StandardMaterial | PBRMaterial | ShaderMaterial;
+/** Creates an unbound Babylon texture; callers own image loading and disposal. */
+export declare function toBabylonTexture(descriptor: TextureDescriptor, scene?: Scene | null, source?: string): Texture;
+export declare function createBabylonObject(descriptor: SceneNode, scene: Scene): TransformNode | Mesh;
+export declare function toBabylonScene(descriptor: SceneDescriptor, engine: Engine): Scene;
+export declare function toBabylonCamera(descriptor: CameraDescriptor, scene: Scene): FreeCamera;
+export declare function disposeGeometry(mesh: AbstractMesh): void;
+export declare function disposeMaterial(material: StandardMaterial | PBRMaterial | ShaderMaterial | readonly (StandardMaterial | PBRMaterial | ShaderMaterial)[]): void;
+export declare function disposeTexture(texture: Texture): void;
+/** Disposes mesh geometry and materials in a tree; textures remain caller-owned. */
+export declare function disposeObjectTree(root: TransformNode): void;
+export {};

package/dist/index.js

@@ -0,0 +1 @@
+import{Camera as b,Color3 as l,Constants as s,FreeCamera as g,Mesh as u,MeshBuilder as h,PBRMaterial as w,Scene as M,ShaderMaterial as c,StandardMaterial as R,Texture as S,TransformNode as p,Vector2 as T,Vector3 as y,Vector4 as C,VertexData as A}from"@babylonjs/core";function B(e){return new T(e[0],e[1])}function i(e){return new y(e[0],e[1],e[2])}function O(e){return new C(e[0],e[1],e[2],e[3])}function r(e,n){return n&&(n.position&&(e.position=i(n.position)),n.rotation&&(e.rotation=i(n.rotation)),n.scale&&e.scaling&&(e.scaling=i(n.scale))),e}function I(e){return{min:i(e.min),max:i(e.max)}}function D(e,n=null){switch(e.type){case"plane":return h.CreatePlane("plane",{width:e.width,height:e.height},n??void 0);case"box":return h.CreateBox("box",{width:e.width,height:e.height,depth:e.depth},n??void 0);case"sphere":return h.CreateSphere("sphere",{diameter:e.radius*2,segments:Math.max(e.widthSegments??32,e.heightSegments??16)},n??void 0);case"buffer":{const t=new u("buffer",n),a=new A;return a.positions=e.positions.flatMap(o=>[...o]),e.indices&&(a.indices=[...e.indices]),a.applyToMesh(t),t}}}function d(e){if(e!==void 0)return typeof e=="string"?l.FromHexString(e):typeof e=="number"?l.FromInts(e>>16&255,e>>8&255,e&255):new l(e[0],e[1],e[2])}function m(e,n){n.opacity!==void 0&&(e.alpha=n.opacity),n.transparent!==void 0?e.transparencyMode=n.transparent?2:0:n.opacity!==void 0&&n.opacity<1&&(e.transparencyMode=2),n.side==="back"&&(e.backFaceCulling=!1,e.sideOrientation=u.BACKSIDE),n.side==="double"&&(e.backFaceCulling=!1),n.side==="front"&&(e.backFaceCulling=!0,e.sideOrientation=u.FRONTSIDE)}function V(e,n,t){typeof t=="boolean"?e.setInt(n,t?1:0):typeof t=="number"?e.setFloat(n,t):t.length===2?e.setVector2(n,B(t)):t.length===3?e.setVector3(n,i(t)):e.setVector4(n,O(t))}function U(e={}){return{...e}}function _(e,n){if(e.type==="shader"){const o=new c("shader",n,{vertex:e.vertexShader,fragment:e.fragmentShader},{attributes:["position","normal","uv"],uniforms:Object.keys(e.uniforms??{})});for(const[f,E]of Object.entries(e.uniforms??{}))V(o,f,E);return m(o,e),o}if(e.type==="standard"){const o=d(e.color),f=new w("standard",n??void 0);return o&&(f.albedoColor=o),e.roughness!==void 0&&(f.roughness=e.roughness),e.metalness!==void 0&&(f.metallic=e.metalness),m(f,e),f}const t=d(e.color),a=new R("basic",n??void 0);return t&&(a.diffuseColor=t),m(a,e),a}function P(e,n=null,t){const a=new S(t??"",n??void 0,void 0,!1);return a.hasAlpha=e.flipY===!0,a.vScale=e.flipY===!1?1:-1,a.wrapU=e.wrap==="repeat"?s.TEXTURE_WRAP_ADDRESSMODE:e.wrap==="mirror"?s.TEXTURE_MIRROR_ADDRESSMODE:s.TEXTURE_CLAMP_ADDRESSMODE,a.wrapV=a.wrapU,a.updateSamplingMode(e.minFilter==="nearest"||e.magFilter==="nearest"?s.TEXTURE_NEAREST_SAMPLINGMODE:s.TEXTURE_LINEAR_LINEAR),a}function x(e,n){if(e.type==="group"){const a=new p(e.name??"group",n);e.visible!==void 0&&a.setEnabled(e.visible),e.metadata&&(a.metadata={...e.metadata}),r(a,e.transform);for(const o of e.children??[])x(o,n).parent=a;return a}const t=D(e.geometry,n);return t.name=e.name??t.name,t.material=_(e.material,n),e.visible!==void 0&&t.setEnabled(e.visible),e.metadata&&(t.metadata={...e.metadata}),r(t,e.transform),t}function N(e,n){const t=new M(n);e.metadata&&(t.metadata={...e.metadata});for(const a of e.children??[])x(a,t);return t}function k(e,n){const t=new g("camera",y.Zero(),n);return t.mode=e.type==="orthographic"?b.ORTHOGRAPHIC_CAMERA:b.PERSPECTIVE_CAMERA,t.minZ=e.near,t.maxZ=e.far,e.type==="perspective"?t.fov=e.fov:(t.orthoLeft=e.left,t.orthoRight=e.right,t.orthoTop=e.top,t.orthoBottom=e.bottom),r(t,e.transform)}function L(e){e.dispose(!1,!1)}function X(e){for(const n of Array.isArray(e)?e:[e])n.dispose()}function j(e){e.dispose()}function G(e){for(const n of e.getChildMeshes(!1)){const t=n.material;n.dispose(!1,!1),t&&t.dispose()}e.dispose(!1,!1)}export{r as applyBabylonTransform,x as createBabylonObject,L as disposeGeometry,X as disposeMaterial,G as disposeObjectTree,j as disposeTexture,I as toBabylonBounds,k as toBabylonCamera,D as toBabylonGeometry,_ as toBabylonMaterial,N as toBabylonScene,P as toBabylonTexture,U as toBabylonUniforms,B as toBabylonVector2,i as toBabylonVector3,O as toBabylonVector4};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "babylonbridge",
+  "version": "0.1.0",
+  "description": "Small adapters between Mosa WebGL / 3D primitives and Babylon.js.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "postbuild": "npm run dist --prefix \"$npm_config_local_prefix\" -- \"$PWD\"",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run build",
+    "pretest": "npm run build",
+    "test": "node --test test/*.test.mjs"
+  },
+  "keywords": [
+    "babylonjs",
+    "webgl",
+    "3d",
+    "shaderlab"
+  ],
+  "homepage": "https://shaderlab.dev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mosanic/mosa-platform.git",
+    "directory": "packages/babylonbridge"
+  },
+  "author": "Mosanic <dev@mosanic.io>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "web3d-kit": "^0.1.0"
+  },
+  "peerDependencies": {
+    "@babylonjs/core": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@babylonjs/core": "^8.0.0",
+    "typescript": "^5.9.3"
+  }
+}