Skip to content
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.

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

fix(react-components): Fixes bug where ground plane scale is stored as xz instead of xy #4743

Conversation

anders-hopland
Copy link
Contributor

Type of change

Bug

Description 📝

Fixes bug where starting August 1 2024, groundplanes in scene is stored with scale in XZ instead of XY. Checking updatedAtto check which format ground plane scale has been written in

How has this been tested? 🔍

Test instructions ℹ️

Checklist ☑️

  • I am proud of this feature.
  • I have performed a self-review of my own code.
  • I have added PR type (Feat, Bug, Chore, Test, Docs, Style, Refactor) to the PR title.
  • I have manually tested this for different scenarios (different models, formats, devices, browsers).
  • I have commented my code in hard-to-understand areas.
  • I have made corresponding changes to the public documentation.
  • I have added unit and visuals tests to prove that my feature works to the best of my ability.
  • I have refactored the code for readability to the best of my ability.
  • I have checked that my changes do not introduce regressions in the public documentation.
  • I have outlined any known defects / lacking capabilities in the contents of this PR.
  • I have listed any remaining work that should follow this PR in the description or jira/miro/etc.
  • I have added TSDoc to any public facing changes.
  • I have added "developer documentation" in any package README.md that is related / applicable to this PR.
  • I have noted down and am currently tracking any technical debt introduced in this PR.
  • I have thoroughly thought about the architecture of this implementation.
  • I have asked peers to test this feature.

Comment on lines 80 to 84
// New scale format was introduced as a bug in the Scenebuilder
// on August 1st, 2024. This is a temporary fix to handle both formats.
// This should be removed when we upgrade the Scene Data Model to a new version
const groundPlaneUsesNewScaleFormat = groundPlaneUseNewScaleFormat(
scene.sceneConfiguration.updatedAt
Copy link
Contributor

Choose a reason for hiding this comment

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

Remember to write this down in your document, so that we remember to actually remove this 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed!

const scaleX = groundPlane.scaleX;
const scaleY = groundPlaneUsesNewScaleFormat ? groundPlane.scaleZ : groundPlane.scaleY;

const geometry = new PlaneGeometry(10000 * scaleX, 10000 * scaleY);
Copy link
Contributor

Choose a reason for hiding this comment

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

Still a bit weird to have this random scaling factor here 😅 Should it be in a variable?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed, fixed in 60db811

@haakonflatval-cognite
Copy link
Contributor

Title should be fix(...): ...

Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@anders-hopland anders-hopland changed the title bug(react-components): Fixes bug where ground plane scale is stored as xz instead of xy fix(react-components): Fixes bug where ground plane scale is stored as xz instead of xy Sep 6, 2024
@anders-hopland anders-hopland enabled auto-merge (squash) September 6, 2024 09:31
@anders-hopland anders-hopland merged commit f860ce1 into master Sep 6, 2024
14 checks passed
@anders-hopland anders-hopland deleted the amh/react-components-fix-bug-with-wrong-scene-ground-plane-scale branch September 6, 2024 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants