@giro3d/giro3d/src/gui/PointCloudSourceInspector.ts

A JS/WebGL framework for 3D geospatial data visualization

/*
 * Copyright (c) 2015-2018, IGN France.
 * Copyright (c) 2018-2026, Giro3D team.
 * SPDX-License-Identifier: MIT
 */

import type GUI from 'lil-gui';

import type Instance from '../core/Instance';
import type { PointCloudSource } from '../sources/PointCloudSource';

import { aggregateMemoryUsage, format, type GetMemoryUsageContext } from '../core/MemoryUsage';
import { isAggregatePointCloudSource } from '../sources/AggregatePointCloudSource';
import { isCOPCSource } from '../sources/COPCSource';
import Panel from './Panel';

export default class PointCloudSourceInspector extends Panel {
    public readonly source: PointCloudSource;
    public readonly memoryUsage = { cpuMemory: '', gpuMemory: '' };

    public constructor(parent: GUI, instance: Instance, source: PointCloudSource) {
        super(parent, instance, 'Source');

        this.source = source;

        source.initialize().then(s => this.populate(s));
    }

    private populate(source: PointCloudSource): void {
        this.addController(source, 'id');
        this.addController(source, 'type');
        this.addController(source, 'progress').decimals(2);
        this.addController(this.memoryUsage, 'cpuMemory');
        this.addController(this.memoryUsage, 'gpuMemory');

        if (isAggregatePointCloudSource(source)) {
            this.addController(source.sources, 'length');
        } else if (isCOPCSource(source)) {
            source.getMetadata().then(metadata => {
                if (metadata.crs && typeof metadata.crs.srid !== 'undefined') {
                    const sridObj = { srid: metadata.crs.srid.toString() };
                    this.addController(sridObj, 'srid').name('CRS');
                }
                this.addController(metadata.attributes, 'length').name('Attributes');
            });
        }
    }

    public override updateValues(): void {
        if (!this.source.ready) {
            return;
        }

        const context: GetMemoryUsageContext = {
            renderer: this.instance.renderer,
            objects: new Map(),
        };
        this.source.getMemoryUsage(context);

        const report = aggregateMemoryUsage(context);
        this.memoryUsage.cpuMemory = format(report.cpuMemory);
        this.memoryUsage.gpuMemory = format(report.gpuMemory);
    }
}