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

Remove broken debug depth options in Scene.js #9965

Merged
merged 5 commits into from
Dec 8, 2021
Merged

Conversation

ebogo1
Copy link
Contributor

@ebogo1 ebogo1 commented Dec 7, 2021

This PR removes some code that's been broken for a while: #6763. If we ever fix this code these commits can be reverted, but for now it's helpful to simplify Scene.js, GlobeDepth.js, and PickDepth.js so the Framebuffer code can be refactored.

  • Removes debugGlobeDepthViewportCommand in GlobeDepth
  • Removes debugPickDepthViewportCommand in PickDepth
  • Removes debugShowGlobeDepth and debugShowPickDepth (which was only set through the inspector) options from Scene
  • Removes debugGlobeDepths array in View
  • Removes globe depth and pick depth toggles in the CesiumInspector widget and view model
  • Removes a test testing debug globe depth in SceneSpec

@ebogo1 ebogo1 requested a review from lilleyse December 7, 2021 18:34
@cesium-concierge
Copy link

Thanks for the pull request @ebogo1!

  • ✔️ Signed CLA found.
  • CHANGES.md was not updated.
    • If this change updates the public API in any way, please add a bullet point to CHANGES.md.

Reviewers, don't forget to make sure that:

  • Cesium Viewer works.
  • Works in 2D/CV.

@ebogo1 ebogo1 mentioned this pull request Dec 7, 2021
2 tasks
Source/Scene/GlobeDepth.js Show resolved Hide resolved
Source/Scene/PickDepth.js Show resolved Hide resolved
*
* @default false
*/
this.debugShowGlobeDepth = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this property is part of the public API removing it counts as a breaking change and should be mentioned in CHANGES.md. I don't think we need a deprecation period since it is for debugging only and has been broken for a while now.

Comment on lines -159 to -172
/**
* Gets or sets the show globe depth state. This property is observable.
* @type {Boolean}
* @default false
*/
this.globeDepth = false;

/**
* Gets or sets the show pick depth state. This property is observable.
* @type {Boolean}
* @default false
*/
this.pickDepth = false;

Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment about mentioning both of these in the breaking changes section.

@ebogo1
Copy link
Contributor Author

ebogo1 commented Dec 8, 2021

@lilleyse I made the changes above. Should the CHANGES.md entry have any more info? The original issue says the debug depths may have been broken since 1.45, but usually any extra info in the Breaking section is for alternative APIs to use after deprecation.

@lilleyse
Copy link
Contributor

lilleyse commented Dec 8, 2021

That should be fine. Thanks @ebogo1.

@lilleyse lilleyse merged commit fd6b7ae into main Dec 8, 2021
@lilleyse lilleyse deleted the remove-debug-depths branch December 8, 2021 21:39
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.

3 participants