@giro3d/giro3d/src/renderer/pointcloudmaterial/slots/ColorSlot.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 { HasDefines } from '../../MaterialUtils';

import MaterialUtils from '../../MaterialUtils';
import { AttributeSlot } from './AttributeSlot';

export interface ColorPropertiesUniform {
    weight: number;
}

export interface ColorSlotState {
    weight: number;
}

type SlotIndex = 0 | 1 | 2;
const slotNames: Record<SlotIndex, string> = {
    0: 'color',
    1: 'color_1',
    2: 'color_2',
};

export class ColorSlot extends AttributeSlot {
    public static getAttributeName(index: SlotIndex): string {
        return slotNames[index];
    }

    public readonly uniform: ColorPropertiesUniform;

    private readonly _material: HasDefines;
    private readonly _flagDefine: string | null;

    public constructor(material: HasDefines, index: SlotIndex) {
        super(ColorSlot.getAttributeName(index));

        this.uniform = {
            weight: 0,
        };

        this._material = material;

        if (index === 0) {
            // first color is always present
            this._flagDefine = null;
        } else {
            this._flagDefine = `COLOR_${index}`;
        }
    }

    public override get hasAttribute(): boolean {
        if (this._flagDefine === null) {
            return true;
        }
        return typeof this._material.defines[this._flagDefine] !== 'undefined';
    }

    public set hasAttribute(value: boolean) {
        if (this._flagDefine === null) {
            throw new Error('Color slot 0 is always present');
        }
        MaterialUtils.setDefine(this._material, this._flagDefine, value);
    }

    public get state(): ColorSlotState {
        return {
            weight: this.weight,
        };
    }

    public set state(state: Partial<ColorSlotState>) {
        if (typeof state.weight !== 'undefined') {
            this.weight = state.weight;
        }
    }
}