Interface ShellGenerationStats

Generation metrics returned with a ShellGeneratorResult.

These values are useful for choosing shell resolution, simplification settings and LOD thresholds for a model family.

interface ShellGenerationStats {
    generationTimeMs: number;
    gridDimensions: [number, number, number];
    occupiedVoxelCount: number;
    shellTriangleCount: number;
    shellVertexCount: number;
    sourceObjectCount: number;
    sourceTriangleCount: number;
    sourceVertexCount: number;
    triangleReductionRatio: number;
    voxelCount: number;
}

Properties

generationTimeMs gridDimensions occupiedVoxelCount shellTriangleCount shellVertexCount sourceObjectCount sourceTriangleCount sourceVertexCount triangleReductionRatio voxelCount

Properties

generationTimeMs

generationTimeMs: number

Time spent generating the shell, in milliseconds.

gridDimensions

gridDimensions: [number, number, number]

Voxel grid dimensions as [x, y, z].

occupiedVoxelCount

occupiedVoxelCount: number

Number of voxels intersected by source triangles.

shellTriangleCount

shellTriangleCount: number

Number of triangles in the generated shell.

shellVertexCount

shellVertexCount: number

Number of vertices in the generated shell.

sourceObjectCount

sourceObjectCount: number

Number of source SceneObjects passed to the shell generator.

sourceTriangleCount

sourceTriangleCount: number

Number of source triangles visited while collecting input geometry.

sourceVertexCount

sourceVertexCount: number

Number of source vertices visited while collecting input geometry.

triangleReductionRatio

triangleReductionRatio: number

Ratio of source triangles to shell triangles.

A value of 10 means the source had roughly ten times as many triangles as the generated shell. Empty shells report 0.

voxelCount

voxelCount: number

Total number of voxels in the grid.

Settings

Member Visibility

On This Page

Properties