Cloner System for Babylon.js

Based on Cloner System extension https://github.com/androdlang/Extensions/tree/master/ClonerSystem by https://github.com/androdlang

More info and docs here - https://doc.babylonjs.com/communityExtensions/clonerSystem

Definitions:

• Cloners: given one or several meshes, either clones or instances will distributed in a specific manner. If more than one mesh is provided, the meshes are distributed alternatively. Additionally, cloners can be nested, so it is possible to clone cloners. Each cloner can have several Effectors (in particular order) to influence the Scale/Position/Rotation parameter of a clone (or cloner). A sensitivity parameter controls this influence for a cloner. Following Objects are designated:
• RadialCloner: radial distribution where following parameters are recognized: input-meshlist, count, radius, offset, startangle, endangle, Effector-sensitivity for Position, Scale and Rotation, alignment-flag, orientation.
• LinearCloner: linear distribution where following parameters are recognized: input-meshlist, count, offset, growth, Effector-sensitivity for Position, Scale and Rotation. An interpolation-mode-flag  determines, if the clone -parameters (Scale/Position/Rotation) are interpreted as "step" or "end"-values.
• MatrixCloner: distribution in 3D space where following parameters are recognized: input-meshlist, mcount, size.
• ObjectCloner: distribution over faces of a mesh where following parameters are recognized: input-meshlist, reference-mesh.
• RandomEffector: influences Scale/Position/Rotation of a clone with repeatable random values, controlled with an overall "strength" parameter.

Demo

The demo with all cloners (animated) - https://clonersystem.babylonpress.org/ (the default example scene for this repo)
The demo with all cloners (static) - https://babylonpress.org/cloner/
Extensive old version documentation - https://doc.babylonjs.com/communityExtensions/clonerSystem

Playground demos

https://playground.babylonjs.com/#1MYQ3T#47
https://playground.babylonjs.com/#1WRUHY#2
https://www.babylonjs-playground.com/#1NYYEQ#5
https://www.babylonjs-playground.com/#1NYYEQ#6
https://www.babylonjs-playground.com/#1NYYEQ#7
https://playground.babylonjs.com/#JWETXJ#0

Import and Usage

Import is done through src/clonersystem/index.ts. You may import the whole ClonerSystem and then use like ClonerSystem.MatrixCloner etc. Or, for better tree shaking, import them like

import { RandomEffector } from "../clonersystem";
import { MatrixCloner } from "../clonersystem"

Then use like

        const mc = new MatrixCloner([capsule, box, sphere], scene, {
            mcount: { x: 5, y: 5, z: 5 },
        });

        mc.root!.position = new Vector3(-10, 0, 15);
		const rr = new RandomEffector();
        rr.strength = 1;
        rr.position = { x: 2, y: 0, z: 2 };
        rr.rotation = { x: 70, y: 30, z: 0 };
        mc.addEffector(rr, 1);

Getting started

This is a Babylon.js project using typescript, latest babylon.js es6 core module, webpack 4 with webpack dev server, hot loading, eslint, vscode support and more.

To run the basic Cloner System scene (with some animations):

1. Clone / download this repository
2. run npm install to install the needed dependencies.
3. run npm start
4. A new window should open in your default browser. if it doesn't, open http://localhost:8080

Running npm start will start the webpack dev server with hot-reloading turned on.

Loading different examples

The ./src/scenes directory contains one example of the scene that can be loaded. To load a different scene change the import in ./src/createScene.ts to the scene you want to load.

WebGPU Support

Open the URL in a webgpu-enabled browser and add "?engine=webgpu" to the URL. http://localhost:8080/?engine=webgpu. Example: https://clonersystem.babylonpress.org/?engine=webgpu

TypeDoc Support

To generate documentation use

npx typedoc --out docs src/clonersystem/index.ts