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(web): 3d tiles' style cannot be reset #1262

Merged
merged 3 commits into from
Nov 19, 2024
Merged

Conversation

airslice
Copy link
Contributor

@airslice airslice commented Nov 19, 2024

Overview

After you assign a style to 3dtiles and reset, the style can't be reset properly on map. That's due to the '3dtiles' property is undefined. We should give a default empty object {} as the default 3dtiles style.

What I've done

What I haven't done

How I tested

Which point I want you to review particularly

Memo

Summary by CodeRabbit

  • New Features
    • Enhanced styling capabilities for 3D tiles, including new properties for dynamic color assignment and rendering options.
    • Updated visibility settings for marker and polygon styles.
  • Improvements
    • Added support for additional properties in style definitions, improving customization options.

Copy link

coderabbitai bot commented Nov 19, 2024

Walkthrough

The changes in this pull request enhance the styling capabilities for 3D tiles within the layer style definitions. Key modifications include the addition of a new empty object for the "3dtiles" property in the defaultStyle export, updates to the professionalStyle to include visibility settings, and the introduction of dynamic color assignments. Additionally, new properties related to rendering options for 3D tiles have been defined, reflecting a comprehensive update to the styling structure.

Changes

File Path Change Summary
web/src/beta/features/Editor/Map/LayerStylePanel/PresetLayerStyle/presetLayerStyles.ts - Added empty object for "3dtiles" in defaultStyle
- Added hideIndicator: true in professionalStyle.marker and professionalStyle.polygon
- Updated selectedFeatureColor in professionalStyle.polygon to include an expression
- Added shadows: "disabled" in colorBuildingsByHeight
- Defined threeDTilesStyle with properties color, colorBlendMode, and pbr

Possibly related PRs

Suggested labels

web

Suggested reviewers

  • mkumbobeaty
  • pyshx

🐰 In the meadow where styles bloom,
A new layer dances, dispelling the gloom.
With colors that shift and shadows that play,
Our 3D tiles shine brighter today!
Hooray for the changes, let joy take flight,
In the world of design, everything feels right! 🌼


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

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.

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for reearth-web ready!

Name Link
🔨 Latest commit 89d57af
🔍 Latest deploy log https://app.netlify.com/sites/reearth-web/deploys/673c6413a4a91f0008bbfd8a
😎 Deploy Preview https://deploy-preview-1262--reearth-web.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot requested a review from m-abe-dev November 19, 2024 07:24
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
web/src/beta/features/Editor/Map/LayerStylePanel/PresetLayerStyle/presetLayerStyles.ts (2)

Line range hint 146-152: Consider adding JSDoc comments to document the 3D tiles style properties.

While the implementation is correct, adding documentation would help other developers understand the purpose and impact of each property (color, colorBlendMode, pbr).

+/**
+ * Default style for 3D tiles visualization
+ * @property color - The base color for 3D tiles
+ * @property colorBlendMode - Determines how colors are blended ("highlight" shows original textures)
+ * @property pbr - Enables/disables physically-based rendering
+ */
 export const threeDTilesStyle = {
   "3dtiles": {
     color: "#FFFFFF",
     colorBlendMode: "highlight",
     pbr: false
   }
 };

Line range hint 154-177: Consider internationalizing the height property name.

The style uses a Japanese property name 計測高さ in conditions. Consider using English property names or implementing a localization system for consistent maintenance.

 conditions: [
-  ["${計測高さ}>=180", "color('#F9FD4C')"],
-  ["${計測高さ}>=120", "color('#F6CD3D')"],
-  ["${計測高さ}>=60", "color('#EBD384')"],
-  ["${計測高さ}>=31", "color('#9E79BA')"],
-  ["${計測高さ}>=12", "color('#5230C2')"],
+  ["${height}>=180", "color('#F9FD4C')"],
+  ["${height}>=120", "color('#F6CD3D')"],
+  ["${height}>=60", "color('#EBD384')"],
+  ["${height}>=31", "color('#9E79BA')"],
+  ["${height}>=12", "color('#5230C2')"],
   ["true", "color('#362C52')"]
 ]

Good performance consideration with disabled shadows.

The shadows: "disabled" setting is appropriate for buildings colored by height, as it can improve rendering performance when dealing with multiple 3D tiles.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 43a131d and 1346b11.

📒 Files selected for processing (1)
  • web/src/beta/features/Editor/Map/LayerStylePanel/PresetLayerStyle/presetLayerStyles.ts (1 hunks)
🔇 Additional comments (1)
web/src/beta/features/Editor/Map/LayerStylePanel/PresetLayerStyle/presetLayerStyles.ts (1)

21-22: LGTM! The empty 3dtiles object addition fixes the style reset issue.

Adding a default empty object for 3dtiles is the correct approach to handle style resets, as it prevents the undefined property issue mentioned in the PR objectives.

Let's verify that this is the only place where default styles are defined:

✅ Verification successful

The empty 3dtiles object addition in defaultStyle is correct and sufficient

After reviewing the codebase, I can confirm that:

  1. The defaultStyle in presetLayerStyles.ts is the only default style definition that needs the empty "3dtiles" object
  2. Other style presets like threeDTilesStyle and colorBuildingsByHeight define specific 3dtiles styles but don't need to handle the reset case
  3. The types in types.ts confirm that "3dtiles" is a valid AppearanceType
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other potential default style definitions that might need the same fix
ast-grep --pattern 'export const $name = {
  $$$
  "3dtiles": $$$
  $$$
}'

Length of output: 76


Script:

#!/bin/bash
# Let's try a broader search for style definitions and 3dtiles
rg -l "3dtiles" --type ts

# Then let's look for any default style or preset definitions
rg "export const.*Style.*=.*{" --type ts -A 5

Length of output: 788


Script:

#!/bin/bash
# Fix the regex and search for style definitions
rg "export const.*Style.*=" --type ts -A 5

# Also check the specific files we found that mention 3dtiles
cat "web/src/beta/features/Editor/Map/LayerStylePanel/PresetLayerStyle/presetLayerStyles.ts"
cat "web/src/beta/features/Editor/Map/LayerStylePanel/Editor/StyleInterface/types.ts"

Length of output: 55541

Copy link
Contributor

@mulengawilfred mulengawilfred left a comment

Choose a reason for hiding this comment

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

Thanks for the fix for this! Works as expected

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 18.25%. Comparing base (e518108) to head (89d57af).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...erStylePanel/PresetLayerStyle/presetLayerStyles.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1262      +/-   ##
==========================================
- Coverage   18.25%   18.25%   -0.01%     
==========================================
  Files         623      623              
  Lines       67338    67339       +1     
  Branches      622      622              
==========================================
  Hits        12295    12295              
- Misses      55043    55044       +1     
Flag Coverage Δ
web 18.25% <0.00%> (-0.01%) ⬇️
web-beta 18.25% <0.00%> (-0.01%) ⬇️
web-classic 18.25% <0.00%> (-0.01%) ⬇️
web-utils 18.25% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...erStylePanel/PresetLayerStyle/presetLayerStyles.ts 0.00% <0.00%> (ø)
---- 🚨 Try these New Features:

@airslice airslice merged commit c29f8a0 into main Nov 19, 2024
16 checks passed
@airslice airslice deleted the fix/default-3dtiles-style branch November 19, 2024 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants