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.

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

Jump to bottom

Enhacement: Show scene limits through debug panel (#1873) #2023

Merged
merged 10 commits into from
Sep 12, 2024
Merged

Enhacement: Show scene limits through debug panel (#1873) #2023

merged 10 commits into from
Sep 12, 2024

Conversation

QThund
Copy link
Contributor

@QThund QThund commented Sep 11, 2024 •
edited by coderabbitai bot
Loading

What does this PR change?

How to test the changes?

  1. Launch the explorer using --debug
  2. Open the Current Scene in the panel at the right side.
  3. Move the avatar and visit different scenes (goerli world recommended).

The panel should show information about the current scene (name, parcels and height). If you enable the "Show scene bounds" checkbox, a red box should surround the scene.
If there is no scene info, "" should be displayed, and the box should not be visible.

Recording.2024-09-11.170211.mp4

Summary by CodeRabbit

  • New Features

    • Introduced a new constant CURRENT_SCENE for better categorization in debugging.
    • Enhanced scene debugging capabilities with new UI bindings for scene properties.

  • Bug Fixes

    • Restructured diagnostic categories by removing and reintroducing the "ASSET_BUNDLES" category, improving reporting accuracy.

  • Documentation

    • Updated the ISceneFacade interface for clarity by repositioning the IsEmpty property.

  • Chores

    • Updated the subproject commit reference for unity-shared-dependencies to track the latest version.

@QThund
chore: Show scene limits through debug panel (#1873)
8c0479e 
It shows the name, the number of parcels and the height of the current scene in the debug panel.
@QThund
Added an option to visualize the boundaries of the scene as a red box
c45f31d 
The box is not visible when the avatar visits zones that are not properly set as scenes.
@QThund
Merge branch 'main' into chore/show-scene-limits-through-debug-panel
fb8525c
@QThund
Pending changes from the merge from main
a942078
@QThund
Fixed a problem with the material and another related to the debug co…
91a8f4c 
…ntainer builder

Now the cube uses the Scene shader.
Added a null check to prevent the build to crash when not using --debug.
@QThund
Reverted a change in ReportsHandlingSettings made by mistake
00f7864
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 11, 2024 •
edited
Loading

badge

Windows and Mac build successfull in Unity Cloud! You can find a link to the downloadable artifact below.

Name Link
Commit f31a2cd
Logs https://github.com/decentraland/unity-explorer/actions/runs/10833240141
Download Windows https://github.com/decentraland/unity-explorer/suites/28312648942/artifacts/1925631952
Download Mac https://github.com/decentraland/unity-explorer/suites/28312648942/artifacts/1925764551
Built on 2024-09-12T16:12:09Z

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Sep 11, 2024 •
edited
Loading

Walkthrough

The pull request introduces several changes across multiple files, primarily enhancing debugging capabilities within the scene management system. Key modifications include the addition of a new constant for current scene categorization, adjustments to diagnostic settings, and updates to the UpdateCurrentSceneSystem class to incorporate debugging features. Additionally, the ISceneFacade interface has been reorganized for clarity, and a subproject commit reference has been updated to track a new version of dependencies.

Changes

File Change Summary
Explorer/Assets/DCL/PerformanceAndDiagnostics/DebugUtilities/Builders/IDebugContainerBuilder.cs Added a new constant CURRENT_SCENE to the Categories class.
Explorer/Assets/DCL/PerformanceAndDiagnostics/Diagnostics/ReportsHandling/ReportsHandlingSettingsDevelopment.asset Removed and reintroduced the "ASSET_BUNDLES" category with severity levels 0 and 4, restructuring its handling in diagnostics.
Explorer/Assets/Scripts/ECS/SceneLifeCycle/Systems/UpdateCurrentSceneSystem.cs Updated constructor and methods to include debugging parameters and bindings for scene properties; added methods for managing and displaying debug information.
Explorer/Assets/Scripts/Global/Dynamic/GlobalWorldFactory.cs Modified the InjectToWorld method signature to include a new debugContainerBuilder parameter.
Explorer/Assets/Scripts/SceneRunner/Scene/ISceneFacade.cs Repositioned the IsEmpty property within the ISceneFacade interface.
Explorer/Assets/git-submodules/unity-shared-dependencies Updated subproject commit reference to a new identifier.

Possibly related PRs

Suggested labels

no QA needed

Poem

🐰 In the burrow deep, where the code does creep,
New constants hop in, making debugging a leap.
With scenes now bright, and diagnostics tight,
We celebrate changes, oh what a delight!
So let’s bound and cheer, for the code is clear! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@QThund QThund requested review from dalkia and removed request for mikhail-dcl September 11, 2024 15:05
Ludmilafantaniella
Ludmilafantaniella approved these changes Sep 11, 2024
View reviewed changes
Copy link

@Ludmilafantaniella Ludmilafantaniella left a comment

Choose a reason for hiding this comment

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

QA testing for this ticket is complete, and the feature works as expected. Here are two observations:

  1. The scene name displays as a sequence of letters rather than something more recognizable (e.g., "dollhouse").
  2. When the "Show scene bounds" checkbox is enabled, there is a visual glitch on the scene's floor. This issue only occurs when the checkbox is selected and does not affect functionality (e.g., second scene visited in the video --> seed).

Is this expected? @QThund

🟢 Everything else is functioning correctly. Approved by QA!

Explorer.2024-09-11.15-52-58.mp4

@QThund
Copy link
Contributor Author

QThund commented Sep 12, 2024

QA testing for this ticket is complete, and the feature works as expected. Here are two observations:

1. The scene name displays as a sequence of letters rather than something more recognizable (e.g., "dollhouse").

2. When the "Show scene bounds" checkbox is enabled, there is a visual glitch on the scene's floor. This issue only occurs when the checkbox is selected and does not affect functionality (e.g., second scene visited in the video --> seed).

Is this expected? @QThund

🟢 Everything else is functioning correctly. Approved by QA!
Explorer.2024-09-11.15-52-58.mp4

Yes it is. The glitch happens due to z-fighting between the base of the red box and the ground of the scene. It can be easily fixed if needed. About the name, I didn't find an easy way to get a "prettier" name. That name may be useful to search for the scene in the Unity scene hierarchy.

@m3taphysics m3taphysics merged commit 3111760 into main Sep 12, 2024
5 checks passed
@m3taphysics m3taphysics deleted the chore/show-scene-limits-through-debug-panel branch September 12, 2024 16:53
This was referenced Sep 12, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m3taphysics m3taphysics m3taphysics approved these changes

@Ludmilafantaniella Ludmilafantaniella Ludmilafantaniella approved these changes

@pravusjif pravusjif Awaiting requested review from pravusjif

@dalkia dalkia Awaiting requested review from dalkia

Assignees

@QThund QThund

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@QThund @m3taphysics @Ludmilafantaniella @lorux0