Skip to content

WasmGPU | Documentation

createScene#getBounds

createScene#getBounds¶

Summary¶

createScene#getBounds computes an aggregate bounding volume from meshes, point clouds, glyph fields, node links, splat fields, and lattice spaces. By default it only considers visible objects. The result includes box and sphere bounds plus empty/partial flags.

Syntax¶

Scene.getBounds(options?: SceneBoundsOptions): Bounds3
const bounds = scene.getBounds(options);

Parameters¶

Name	Type	Required	Description
`options`	`SceneBoundsOptions`	No	Controls whether hidden objects are included in the aggregation.

Returns¶

Bounds3 - Aggregated world-space bounds for the selected object subset.

partial is propagated when one or more selected contributors cannot provide complete bounds, even if other objects supply finite bounds. An entirely empty selection returns empty: true.

Type Details¶

SceneBoundsOptions¶

type SceneBoundsOptions = {
    visibleOnly?: boolean;
};

SceneBoundsOptions Fields¶

Name	Type	Required	Description
`visibleOnly`	`boolean`	No	When true (default), ignore hidden objects across every renderable family.

Vec3¶

type Vec3 = [number, number, number];

Bounds3¶

type Bounds3 = {
    boxMin: Vec3;
    boxMax: Vec3;
    sphereCenter: Vec3;
    sphereRadius: number;
    empty: boolean;
    partial: boolean;
};

Example¶

const canvas = document.querySelector("canvas");
const wgpu = await WasmGPU.create(canvas);

const scene = wgpu.createScene();
scene.add(wgpu.createNodeLink({
    nodePositions: new Float32Array([
        -1.0, 0.0, 0.0,
         0.0, 1.0, 0.0,
         1.0, 0.0, 0.0
    ]),
    edges: new Uint16Array([
        0, 1,
        1, 2
    ])
}));
const visibleBounds = scene.getBounds();
const allBounds = scene.getBounds({ visibleOnly: false });
console.log(visibleBounds, allBounds);

See Also¶