Major API changes

[ciscorn]

Closes #3

Summary by CodeRabbit

• New Features
  • Added a new utility for projecting 3D polygons into 2D space, enhancing the triangulation process.
• Documentation
  • Updated the README with information on the new 3D to 2D projection utility.
• Refactor
  • Simplified data handling in benchmarking and testing by using array references and improving data structure consistency.
  • Enhanced the clarity and efficiency of 3D to 2D projection operations in the utility module.
  • Adjusted function calls and signatures across examples, library core, and tests to align with updated data handling practices.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.54%. Comparing base (0303da0) to head (6e5b651).

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #5      +/-   ##
==========================================
- Coverage   99.56%   99.54%   -0.02%     
==========================================
  Files           2        2              
  Lines         910      881      -29     
==========================================
- Hits          906      877      -29     
  Misses          4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 9849f07 and a82f001.

Files selected for processing (2)

• examples/example.rs (2 hunks)
• src/utils3d.rs (4 hunks)

Files skipped from review as they are similar to previous changes (2)

• examples/example.rs
• src/utils3d.rs

[coderabbitai]

Walkthrough

The recent changes across the codebase introduce a more efficient and ergonomic approach to handling 3D to 2D projections and polygon triangulation by leveraging const generics. This shift allows for the use of array slices with dimensions defined as const generics, enhancing code readability and performance. The modifications span across documentation, benchmarking, examples, library source, and tests, ensuring a comprehensive update that aligns with modern Rust practices.

Changes

Files	Short Summary
README.md	Added utils3d utility documentation and example image.
.../benchmark.rs, tests/...	Updated function signatures to return a tuple/vector of arrays; simplified data vector creation.
examples/example.rs, src/...	Adjusted function calls and parameters for better data handling and alignment with Rust generics.
src/lib.rs, src/utils3d.rs	Modified macros, structs, and methods for efficient 3D to 2D projection and polygon triangulation.

Assessment against linked issues

Objective	Addressed	Explanation
Use const generics (#3)	✅

Poem

In the realm of code, where logic intertwines,
A rabbit hopped through, refining lines.
With const generics, arrays took their place,
A leap towards efficiency, with elegance and grace.
🐇💻✨
From 3D to 2D, through spaces we weave,
A tale of polygons, in Rust, we believe.

---

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0303da0 and 6e5b651.

Files ignored due to path filters (2)

• Cargo.toml is excluded by: !**/*.toml
• docs/image.png is excluded by: !**/*.png

Files selected for processing (7)

• README.md (1 hunks)
• benches/benchmark.rs (2 hunks)
• examples/example.rs (2 hunks)
• src/lib.rs (38 hunks)
• src/utils3d.rs (3 hunks)
• tests/fixture.rs (2 hunks)
• tests/simple.rs (1 hunks)

Files skipped from review as they are similar to previous changes (5)

• benches/benchmark.rs
• examples/example.rs
• src/utils3d.rs
• tests/fixture.rs
• tests/simple.rs

Additional comments: 5

README.md (1)

• 9-14: The documentation updates, including the addition of utils3d and the inclusion of an image, are clear and relevant to the PR's objectives. Ensure the image is properly hosted and accessible to all intended readers.

src/lib.rs (4)

• 41-45: The use of unsafe blocks in macros for unchecked access to nodes is a critical area that can lead to undefined behavior if not used carefully. Please ensure that the indices are guaranteed to be valid and consider adding comments explaining the rationale behind using unsafe.

Also applies to: 50-54

• 96-96: The addition of the data field to the Earcut struct aligns with the PR's objectives. Please ensure this field is properly documented to clarify its purpose and usage within the library.
• 121-128: The updates to the earcut method signature, leveraging const generics and accepting slices of arrays, are a significant improvement. Ensure that these changes are consistently applied and thoroughly tested across the library.
• 118-178: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [121-892]

The updates to the logic within the Earcut implementation are extensive and aim to improve performance and usability. It's crucial to thoroughly test these changes to ensure they do not introduce regressions or unintended behavior.