Class ShellGenerator

Convenience generator for building shell meshes from scene objects.

The class holds no mutable generation state; create one long-lived instance per caller or call generateShellFromSceneObjects directly.

Generated positions are local to the returned ShellGeneratorResult.center. This keeps large-coordinate source geometry numerically stable and lets runtime code place one shell mesh at the returned center.

Example

import {ShellGenerator} from "@xeokit/sdk/model/lod";

const generator = new ShellGenerator();
const shell = generator.generate(objects, {
  shellResolution: 64,
  extraction: "voxelFaces"
});

Index

Constructors

constructor

Methods

generate

Constructors

constructor

new ShellGenerator(): ShellGenerator
Returns ShellGenerator

Methods

generate

generate(
sceneObjects: readonly SceneObject[],
params?: ShellGenerationParams,
): ShellGeneratorResult
Generates one shell mesh from the given scene objects.
Parameters
- sceneObjects: readonly SceneObject[]
  Source scene objects to approximate.
- params: ShellGenerationParams = {}
  Shell generation options.
Returns ShellGeneratorResult
Generated shell geometry, placement data and metrics. Returned positions are relative to the returned center.
- Defined in packages/sdk/src/model/lod/ShellGenerator.ts:221

Class ShellGenerator

Example

Index

Constructors

Methods

Constructors

constructor

Returns ShellGenerator

Methods

generate

Parameters

Returns ShellGeneratorResult

Settings

On This Page