Skip to content

fix(editable-layers): correct SelectionLayer polygon picking for elongated lassos #635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
llamington wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(editable-layers): correct SelectionLayer polygon picking for elongated lassos #635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 54 additions & 82 deletions modules/editable-layers/src/editable-layers/selection-layer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,15 @@

/* eslint-env browser */

import type {CompositeLayerProps, DefaultProps} from '@deck.gl/core';
import type {CompositeLayerProps, DefaultProps, Layer, PickingInfo} from '@deck.gl/core';
import {CompositeLayer} from '@deck.gl/core';
import {PolygonLayer} from '@deck.gl/layers';
import {featureCollection, polygon} from '@turf/helpers';
import turfBuffer from '@turf/buffer';
import turfDifference from '@turf/difference';
import booleanPointInPolygon from '@turf/boolean-point-in-polygon';
import {point, polygon} from '@turf/helpers';

import {EditableGeoJsonLayer} from './editable-geojson-layer';
import {DrawRectangleMode} from '../edit-modes/draw-rectangle-mode';
import {DrawPolygonMode} from '../edit-modes/draw-polygon-mode';
import {DrawRectangleMode} from '../edit-modes/draw-rectangle-mode';
import {ViewMode} from '../edit-modes/view-mode';
import {EditableGeoJsonLayer} from './editable-geojson-layer';

export const SELECTION_TYPE = {
NONE: null,
Expand Down Expand Up @@ -49,9 +47,7 @@ const EMPTY_DATA = {
features: []
};

const EXPANSION_KM = 50;
const LAYER_ID_GEOJSON = 'selection-geojson';
const LAYER_ID_BLOCKER = 'selection-blocker';

const PASS_THROUGH_PROPS = [
'lineWidthScale',
Expand All @@ -75,18 +71,13 @@ const PASS_THROUGH_PROPS = [
'getTentativeFillColor',
'getTentativeLineWidth'
];

export class SelectionLayer<DataT, ExtraPropsT> extends CompositeLayer<
ExtraPropsT & Required<SelectionLayerProps<DataT>>
> {
static layerName = 'SelectionLayer';
static defaultProps = defaultProps;

state: {
pendingPolygonSelection: {
bigPolygon: ReturnType<typeof turfDifference>;
};
} = undefined!;

_selectRectangleObjects(coordinates: any) {
const {layerIds, onSelect} = this.props;
const [x1, y1] = this.context.viewport.project(coordinates[0][0]);
Expand All @@ -104,57 +95,26 @@ export class SelectionLayer<DataT, ExtraPropsT> extends CompositeLayer<

_selectPolygonObjects(coordinates: any) {
const {layerIds, onSelect} = this.props;
const mousePoints = coordinates[0].map(c => this.context.viewport.project(c));

const allX = mousePoints.map(mousePoint => mousePoint[0]);
const allY = mousePoints.map(mousePoint => mousePoint[1]);
const x = Math.min(...allX);
const y = Math.min(...allY);
const maxX = Math.max(...allX);
const maxY = Math.max(...allY);

// Use a polygon to hide the outside, because pickObjects()
// does not support polygons
const landPointsPoly = polygon(coordinates);
const bigBuffer = turfBuffer(landPointsPoly, EXPANSION_KM);
let bigPolygon;
try {
// turfDifference throws an exception if the polygon
// intersects with itself (TODO: check if true in all versions)
bigPolygon = turfDifference(featureCollection([bigBuffer, landPointsPoly]));
} catch (e) {
// invalid selection polygon
console.log('turfDifference() error', e); // eslint-disable-line
return;
}

this.setState({
pendingPolygonSelection: {
bigPolygon
}
});

const blockerId = `${this.props.id}-${LAYER_ID_BLOCKER}`;

// HACK, find a better way
setTimeout(() => {
const pickingInfos = this.context.deck.pickObjects({
x,
y,
width: maxX - x,
height: maxY - y,
layerIds: [blockerId, ...layerIds]
const selectionPolygon = polygon(coordinates);

const pickingInfos: SelectionPickingInfo[] = this.context.layerManager
.getLayers()
.filter(layer => layerIds.includes(layer.id))
.flatMap(layer => {
const data = layer.props.data;
if (!Array.isArray(data)) return [];
return data.flatMap((object, index): SelectionPickingInfo[] => {
const position = extractPosition(layer, object, index, data);
if (position === null) return [];
if (!booleanPointInPolygon(point(position), selectionPolygon)) return [];

@charlieforward9 charlieforward9 May 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

non-geo may not all pass this conditional check

This works better than the current approach, so its not blocking, but these instances of turf should be triaged under a more careful pass - which may have been the original intention of the GPU-based selections?

CC @eKerney

return [{object, layer, index}];
});
});

onSelect({
pickingInfos: pickingInfos.filter(item => item.layer.id !== this.props.id)
});
}, 250);
onSelect({pickingInfos});
}

renderLayers() {
const {pendingPolygonSelection} = this.state;

const mode = MODE_MAP[this.props.selectionType] || ViewMode;
const modeConfig = MODE_CONFIG_MAP[this.props.selectionType];

Expand All @@ -163,7 +123,7 @@ export class SelectionLayer<DataT, ExtraPropsT> extends CompositeLayer<
if (this.props[p] !== undefined) inheritedProps[p] = this.props[p];
});

const layers: any[] = [
return [
new EditableGeoJsonLayer(
this.getSubLayerProps({
id: LAYER_ID_GEOJSON,
Expand All @@ -187,29 +147,41 @@ export class SelectionLayer<DataT, ExtraPropsT> extends CompositeLayer<
})
)
];

if (pendingPolygonSelection) {
const {bigPolygon} = pendingPolygonSelection as any;
layers.push(
new PolygonLayer(
this.getSubLayerProps({
id: LAYER_ID_BLOCKER,
pickable: true,
stroked: false,
opacity: 1.0,
data: [bigPolygon],
getLineColor: _obj => [0, 0, 0, 1],
getFillColor: _obj => [0, 0, 0, 1],
getPolygon: o => o.geometry.coordinates
})
)
);
}

return layers;
}

shouldUpdateState({changeFlags: {stateChanged, propsOrDataChanged}}: Record<string, any>) {
return stateChanged || propsOrDataChanged;
}
}

type SelectionPickingInfo = Pick<PickingInfo, 'object' | 'layer' | 'index'>;

function extractPosition(

@charlieforward9 charlieforward9 May 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would we want to extract a 3D position here for any reason? @felixpalmer

layer: Layer,
object: unknown,
index: number,
data: unknown
): [number, number] | null {
const props = layer.props;
if ('getPosition' in props && typeof props.getPosition === 'function') {
const result = props.getPosition(object, {index, data, target: []});
if (Array.isArray(result) && typeof result[0] === 'number' && typeof result[1] === 'number') {
return [result[0], result[1]];
}
}
if (typeof object === 'object' && object !== null) {
if ('position' in object) {
const p = object.position;
if (Array.isArray(p) && typeof p[0] === 'number' && typeof p[1] === 'number') {
return [p[0], p[1]];
}
}
if ('coordinates' in object) {
const c = object.coordinates;
if (Array.isArray(c) && typeof c[0] === 'number' && typeof c[1] === 'number') {
return [c[0], c[1]];
}
}
}
return null;
}
Loading