engine-toolkit icon indicating copy to clipboard operation
engine-toolkit copied to clipboard

Improve gizmo api

Open gz65555 opened this issue 1 year ago • 3 comments

This pull request introduces serveral changes:

  1. add constructor parameters of gizmo
  2. use the group of gizmo, while not pass the group
  3. abandon gizmo.init function
  4. remove _initialize property
  5. update gizmo README.md

Force the developer to set camera while add the gizmo component:

const gizmo = gizmoEntity.addComponent(Gizmo, { camera, state: State.translate });

Invoking gizmo.init(camera, group) to create a gizmo is a disconnect in the process.

gz65555 avatar Dec 09 '24 10:12 gz65555

Walkthrough

The pull request introduces modifications to the Gizmo package, specifically updating the README.md and Gizmo.ts files. The README now features a new URL for examples and a streamlined initialization method for the Gizmo component. In Gizmo.ts, a public group property replaces a private one, and the constructor has been updated to accept additional parameters for initialization. The control flow has been simplified by removing certain properties and methods, enhancing the overall structure while retaining core functionality.

Changes

File Path Change Summary
packages/gizmo/README.md Updated example URL, streamlined Gizmo initialization method, and updated documentation links.
packages/gizmo/src/Gizmo.ts Added public group property, updated constructor to accept new parameters, simplified control flow.

Possibly related PRs

  • #283: Modifies the Gizmo.ts file, specifically in handling hover events, indicating a connection in functionality.
  • #284: Introduces new methods and properties in Gizmo.ts that relate to the overall functionality of the Gizmo class.
  • #285: Optimizes Gizmo.ts, including changes to properties and methods that are directly related to the modifications made in the main PR.

Suggested labels

enhancement

Suggested reviewers

  • cptbtptpbcptdtptp

Poem

🐰 In the land of code, where gizmos play,
A new path emerges, brightening the way.
With simpler starts and links so new,
Our Gizmo shines, with a clearer view!
Hops of joy as we code and create,
Together we build, it's never too late! 🌟


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.

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.

coderabbitai[bot] avatar Dec 09 '24 10:12 coderabbitai[bot]

Because it involves API changes, this PR changes base to dev/1.4

cptbtptpbcptdtptp avatar Dec 11 '24 07:12 cptbtptpbcptdtptp

@cptbtptpbcptdtptp When do you migrate framebuffer picker to raycast?

gz65555 avatar Dec 11 '24 07:12 gz65555