Merge origin/main into origin/dev

[yiiqii]

Summary by CodeRabbit

• Bug Fixes

  • Resolved rendering issues related to the differential algorithm.

• Documentation

  • Enhanced the Chinese README with images and a new header.
  • Updated the main README with new visual elements.

• New Features

  • Improved handling of visual effects in the core composition module.

• Refactor

  • Optimized conditional logic in the sprite rendering process.
  • Streamlined the initialization process in the demo application.

[coderabbitai]

Walkthrough

The recent updates encompass bug fixes in the rendering process, documentation enhancements with visual content, and codebase optimizations in the effects core and web demo components. The changes streamline the handling of masks in compositions, improve conditional logic in sprite mesh management, and simplify the demo's player creation process.

Changes

File Path	Summary
CHANGELOG.md	Fixed rendering bugs caused by the diff algorithm and pre-comp. Associated with pull request #53.
README*.md	Added visual content such as images and headers to enhance visual appeal.
packages/effects-core/src/composition-source-manager.ts packages/effects-core/src/plugins/sprite/sprite-mesh.ts	Refactored mask handling and conditional logic.
web-packages/demo/src/single.ts	Streamlined player creation and temporarily disabled env property.

🐇✨
To the code that we mend and mesh,
A rabbit's paw makes it fresh.
With each commit, we leap and dash,
In the digital fields, our dreams we stash. 🌟🌿

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 X ?

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• You can reply to a review comment made by CodeRabbit.
• You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
• You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

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

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between e493738 and 0e2d537.

Files ignored due to filter (12)

• package.json
• packages/effects-core/package.json
• packages/effects-helper/package.json
• packages/effects-threejs/package.json
• packages/effects-webgl/package.json
• packages/effects/package.json
• plugin-packages/alipay-downgrade/package.json
• plugin-packages/editor-gizmo/package.json
• plugin-packages/model/package.json
• plugin-packages/orientation-transformer/package.json
• plugin-packages/spine/package.json
• pnpm-lock.yaml

Files selected for processing (6)

• CHANGELOG.md (1 hunks)
• README-zh_CN.md (1 hunks)
• README.md (1 hunks)
• packages/effects-core/src/composition-source-manager.ts (6 hunks)
• packages/effects-core/src/plugins/sprite/sprite-mesh.ts (1 hunks)
• web-packages/demo/src/single.ts (2 hunks)

Files skipped from review due to trivial changes (2)

• README-zh_CN.md
• README.md

Additional comments: 6

CHANGELOG.md (1)

• 10-14: The CHANGELOG.md update correctly documents the fix for the rendering bugs associated with the diff algorithm and pre-compilation, referencing PR fix: render bugs caused by diff algorithm and pre-comp #53. The date format is consistent with previous entries.

packages/effects-core/src/composition-source-manager.ts (2)

• 42-42: Initialization of the mask property in the constructor is a good practice to avoid it being undefined at any point in the class lifecycle.

• 242-250: The processMask method correctly sets the mask on the renderer based on the maskMode. This is a logical way to handle conditional masking.

packages/effects-core/src/plugins/sprite/sprite-mesh.ts (1)

• 200-210: The reorganization of the conditional logic in updateItem improves readability and makes the early return pattern clearer when selfData.visible is false and init is not set.

web-packages/demo/src/single.ts (2)

• 13-13: Directly awaiting player.loadScene(json) without an intermediate variable simplifies the code and maintains readability.

• 24-24: Verify if the commenting out of the env property is intentional. If this property is no longer needed, consider removing the line entirely to avoid commented-out code lingering in the codebase.

[coderabbitai]

Consider incrementing mask after the isNaN check to ensure it's only incremented when it has a valid number value.

- let mask = this.mask++;
+ let mask = this.mask;
  if (isNaN(mask)) {
    mask = 0;
  } else {
+   this.mask++;
  }

---

Committable suggestion

❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	let mask = this.mask++;
	if (isNaN(mask)) {
	mask = 0;
	let mask = this.mask;
	if (isNaN(mask)) {
	mask = 0;
	} else {
	this.mask++;
	}

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 0e2d537 and dae9252.

Files selected for processing (1)

• web-packages/demo/src/single.ts (2 hunks)

Additional comments: 2

web-packages/demo/src/single.ts (2)

• 10-16: The introduction of await for player.loadScene(json) within the async IIFE and the error handling with console.error are correctly implemented.

• 24-24: Verify that commenting out the env property in the createPlayer function's configuration object is intentional and does not affect the expected behavior of the player.