Skip to content

Fix cameraForBounds not accounting for asymmetrical padding in center result #13647

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
ragini-pandey wants to merge 1 commit into
base: main
Choose a base branch
from
+43 −14
Open

Fix cameraForBounds not accounting for asymmetrical padding in center result #13647

Show file tree
Hide file tree
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
11 changes: 4 additions & 7 deletions src/ui/camera.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,13 +782,10 @@ class Camera extends Evented<MapEvents> {
const padB = options.padding.bottom || 0;
const padT = options.padding.top || 0;

const halfScreenPadX = (padL + padR) * 0.5;
const halfScreenPadY = (padT + padB) * 0.5;

const top = halfScreenPadY;
const left = halfScreenPadX;
const right = halfScreenPadX;
const bottom = halfScreenPadY;
const top = padT;
const left = padL;
const right = padR;
const bottom = padB;

const width = tr.width - (left + right);
const height = tr.height - (top + bottom);
Expand Down
46 changes: 39 additions & 7 deletions test/unit/ui/camera.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,39 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const transform = camera.cameraForBounds(bb, {padding: {top: 10, right: 75, bottom: 50, left: 25}, duration: 0});
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -100.5, lat: 34.7171});
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -96.5558, lat: 32.0833});
});

test('asymmetrical left padding shifts center', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const camera = createCamera();
const bb = [[-133, 16], [-68, 50]];

// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const noPadding = camera.cameraForBounds(bb, {padding: {top: 0, right: 0, bottom: 0, left: 0}});
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const leftPadding = camera.cameraForBounds(bb, {padding: {top: 0, right: 0, bottom: 0, left: 100}});

// With left padding, the center shifts left (more negative lng) to offset the bounds
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
expect(leftPadding.center.lng).toBeLessThan(noPadding.center.lng);
// Zoom should decrease to accommodate the padding
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
expect(leftPadding.zoom).toBeLessThan(noPadding.zoom);
});

test('symmetric padding does not shift center', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const camera = createCamera();
const bb = [[-133, 16], [-68, 50]];

// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const noPadding = camera.cameraForBounds(bb);
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const symPadding = camera.cameraForBounds(bb, {padding: {top: 50, right: 50, bottom: 50, left: 50}});

// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(noPadding.center, 4)).toEqual(fixedLngLat(symPadding.center, 4));
});

test('bearing and asymmetrical padding', () => {
Expand All @@ -1115,7 +1147,7 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const transform = camera.cameraForBounds(bb, {bearing: 90, padding: {top: 10, right: 75, bottom: 50, left: 25}, duration: 0});
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -100.5, lat: 34.7171});
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -103.3761, lat: 31.7099});
});

test(
Expand All @@ -1130,7 +1162,7 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const transform = camera.cameraForBounds(bb, {bearing: 90, padding: {top: 10, right: 75, bottom: 50, left: 25}, duration: 0});
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -100.5, lat: 34.7171});
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -103.3761, lat: 31.7099});
}
);

Expand Down Expand Up @@ -1164,7 +1196,7 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const transform = camera.cameraForBounds(bb, {padding: {top: 10, right: 75, bottom: 50, left: 25}, offset: [0, 100]});
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -100.5, lat: 46.6292});
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -96.5558, lat: 44.4189});
});

test('bearing, asymmetrical padding, and offset', () => {
Expand All @@ -1175,7 +1207,7 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
const transform = camera.cameraForBounds(bb, {bearing: 90, padding: {top: 10, right: 75, bottom: 50, left: 25}, offset: [0, 100], duration: 0});
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -100.5, lat: 45.6619});
expect(fixedLngLat(transform.center, 4)).toEqual({lng: -103.3761, lat: 43.0929});
});

test('unable to fit', () => {
Expand Down Expand Up @@ -1441,7 +1473,7 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
camera.fitBounds(bb, {padding: {top: 10, right: 75, bottom: 50, left: 25}, duration: 0});
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(camera.getCenter(), 4)).toEqual({lng: -100.5, lat: 34.7171});
expect(fixedLngLat(camera.getCenter(), 4)).toEqual({lng: -96.5558, lat: 32.0833});
});

test('padding object with pitch', () => {
Expand All @@ -1452,7 +1484,7 @@ describe('camera', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
camera.fitBounds(bb, {padding: {top: 10, right: 75, bottom: 50, left: 25}, duration: 0, pitch: 30});
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
expect(fixedLngLat(camera.getCenter(), 4)).toEqual({lng: -100.5, lat: 34.7171});
expect(fixedLngLat(camera.getCenter(), 4)).toEqual({lng: -96.5558, lat: 32.4408});
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
expect(camera.getPitch()).toEqual(30);
});
Expand Down
Loading