// luma.gl // SPDX-License-Identifier: MIT // SPDX-FileCopyrightText: Copyright (c) vis.gl contributors import {CompositeLayer, type Color, type LayerContext, type UpdateParameters} from '@deck.gl/core'; import {GPUScatterplotLayer, type GPUScatterplotLayerProps} from './gpu-scatterplot-layer'; import type {GPUVector} from '@luma.gl/graph/gpu-data'; import {DataType, Table, Vector, type FixedSizeList, type Float32, type Uint8} from 'apache-arrow'; import { createLayerGPUVectors, destroyLayerGPUVectors, makeLayerGPUVectorFromArrow, type ArrowGPUVectorColumnSelector, type ArrowGPUVectorLayerData } from './arrow-gpu-layer-utils'; type PositionType = FixedSizeList; type ColorType = FixedSizeList; type ScalarAccessor = number | ArrowGPUVectorColumnSelector; type ColorAccessor = Color | ArrowGPUVectorColumnSelector; /** Arrow adapter props retaining deck's standard Scatterplot accessor names. */ export type ArrowScatterplotLayerProps = Omit< GPUScatterplotLayerProps, 'getPosition' | 'getRadius' | 'getFillColor' > & { data: ArrowGPUVectorLayerData; getPosition: ArrowGPUVectorColumnSelector; getRadius?: ScalarAccessor; getFillColor?: ColorAccessor; }; type ArrowScatterplotLayerState = { positions?: GPUVector<'float32x2'>; radii?: GPUVector<'float32'>; fillColors?: GPUVector<'unorm8x4'>; }; /** Converts Arrow columns to owned GPUVectors, then delegates to GPUScatterplotLayer. */ export class ArrowScatterplotLayer extends CompositeLayer { static override layerName = 'ArrowScatterplotLayer'; override initializeState(): void { this.setState({} satisfies ArrowScatterplotLayerState); } override updateState({props, oldProps, changeFlags}: UpdateParameters): void { if ( changeFlags.dataChanged || props.getPosition !== oldProps.getPosition || props.getRadius !== oldProps.getRadius || props.getFillColor !== oldProps.getFillColor || !(this.state as ArrowScatterplotLayerState).positions ) { const vectors = this.makeVectors(props); this.destroyVectors(); this.setState(vectors); } } override renderLayers(): GPUScatterplotLayer | null { const state = this.state as ArrowScatterplotLayerState; if (!state.positions) return null; const {data, getPosition, getRadius, getFillColor, ...props} = this.props; return new GPUScatterplotLayer({ ...props, id: `${this.props.id}-gpu`, getPosition: state.positions, getRadius: state.radii ?? (typeof getRadius === 'number' ? getRadius : undefined), getFillColor: state.fillColors ?? (isColor(getFillColor) ? getFillColor : undefined) }); } override finalizeState(context: LayerContext): void { this.destroyVectors(); super.finalizeState(context); } private makeVectors(props: ArrowScatterplotLayerProps): ArrowScatterplotLayerState { const positionFormat = getPositionFormat(props.data, props.getPosition, 'getPosition'); return createLayerGPUVectors({ positions: () => makeLayerGPUVectorFromArrow(this.context.device, props.data, props.getPosition, { name: 'positions', id: `${this.id}-positions`, format: positionFormat }), radii: () => makeOptionalVector(this, props.data, props.getRadius, 'radii', 'float32'), fillColors: () => makeOptionalVector(this, props.data, props.getFillColor, 'fill-colors', 'unorm8x4') }); } private destroyVectors(): void { destroyLayerGPUVectors(Object.values(this.state as ArrowScatterplotLayerState)); } } function makeOptionalVector( layer: ArrowScatterplotLayer, data: ArrowGPUVectorLayerData, selector: number | Color | ArrowGPUVectorColumnSelector | undefined, name: string, format: FormatT ): GPUVector | undefined { if (!isSelector(selector)) return undefined; return makeLayerGPUVectorFromArrow(layer.context.device, data, selector, { name, id: `${layer.id}-${name}`, format }); } function getPositionFormat( data: ArrowGPUVectorLayerData, selector: ArrowGPUVectorColumnSelector, inputName: string ): 'float32x2' { const vector = selector instanceof Vector ? selector : (data instanceof Table ? data : new Table([data])).getChild(selector); if (!vector || !DataType.isFixedSizeList(vector.type) || vector.type.listSize !== 2) { throw new Error(`ArrowScatterplotLayer ${inputName} must be FixedSizeList[2]`); } return 'float32x2'; } function isSelector(value: unknown): value is ArrowGPUVectorColumnSelector { return typeof value === 'string' || value instanceof Vector; } function isColor(value: unknown): value is Color { return Array.isArray(value) || ArrayBuffer.isView(value); }