galacean / effects-runtime

It can load and render cool animation effects
https://galacean.antgroup.com/effects/
MIT License
324 stars 8 forks source link

perf: opt lifetime function performance #578

Closed wumaolinmaoan closed 1 month ago

wumaolinmaoan commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes across multiple files primarily involve renaming several lifecycle methods in various classes. The methods start, update, and lateUpdate have been consistently renamed to onStart, onUpdate, and onLateUpdate, respectively. Additionally, new properties and methods have been introduced in several classes to enhance component state management, aligning with architectural patterns and encapsulating functionality related to enabling and disabling components.

Changes

File(s) Change Summary
packages/effects-core/src/comp-vfx-item.ts Renamed methods in CompositionComponent: start to onStart, update to onUpdate.
packages/effects-core/src/components/component.ts Standardized lifecycle method names by renaming awake, start, update, lateUpdate. Added isEnableCalled property and modified enabled logic.
packages/effects-core/src/components/post-process-volume.ts Renamed start to onStart in PostProcessVolume class.
packages/effects-core/src/composition.ts Introduced SceneTicking class for managing update cycles and methods, renamed start to onStart.
packages/effects-core/src/composition/scene-ticking.ts New file with SceneTicking, TickData, UpdateTickData, LateUpdateTickData classes and methods for behavior management.
packages/effects-core/src/plugins/cal/timeline-asset.ts Removed local isAncestor function, replaced with VFXItem.isAncestor static method call in compareTracks.
packages/effects-core/src/plugins/camera/camera-controller-node.ts Renamed update to onUpdate in CameraController.
packages/effects-core/src/plugins/interact/interact-item.ts Added early return in update method to check if component is active and enabled.
packages/effects-core/src/vfx-item.ts Added isEnabled property and methods (onActiveChanged, onEnable, onDisable). Modified setVisible to call onActiveChanged.
plugin-packages/model/src/plugin/model-item.ts Renamed start and update methods to onStart and onUpdate in ModelLightComponent, ModelCameraComponent, AnimationComponent.
plugin-packages/model/src/plugin/model-plugin.ts Renamed lateUpdate to onLateUpdate in ModelPluginComponent.
plugin-packages/model/src/plugin/model-tree-item.ts Renamed start and update methods to onStart and onUpdate in ModelTreeComponent.
plugin-packages/orientation-transformer/src/orientation-component.ts Renamed start and update methods to onStart and onUpdate in OrientationComponent.
plugin-packages/stats/src/stats-component.ts Renamed start and update methods to onStart and onUpdate in StatsComponent.

Sequence Diagram(s)

sequenceDiagram
    participant Composition
    participant SceneTicking
    participant Behaviour

    Composition->>SceneTicking: initializeSceneTicking()
    SceneTicking->>Behaviour: addBehaviour(item)
    SceneTicking->>Behaviour: update()
    SceneTicking->>Behaviour: lateUpdate()

🐰 In the code, we hop and play,
Renamed methods lead the way!
From start to onStart, so bright,
With update dancing in the light.
Changes weave a joyful tune,
As we code beneath the moon! πŸŒ™


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.