Added Three Different Cases for Adding a New Instance

7174Andy commented 2 months ago

Description

Ctrl + I should create instances slightly away from the copied instance
Ctrl + V should create instances exactly on top of the instances it's copying from
Right click and click "Default" to create instance should make the instance based on the location of the click

Types of changes

[ ] Bugfix
[x] New feature
[ ] Refactor / Code style update (no logical changes)
[ ] Build / CI changes
[ ] Documentation Update
[ ] Other (explain)

Does this address any currently open issues?

This PR is an expansion of PR #1816.

Outside contributors checklist

[x] Review the guidelines for contributing to this repository
[x] Read and sign the CLA and add yourself to the authors list
[x] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
[x] Add tests that prove your fix is effective or that your feature works
[x] Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

New Features
- Introduced the ability to specify a location for node positions, enhancing control over instance initialization and visibility settings.
- Updated the contextual menu in the video widget to support initializing new instances with a specific location.

coderabbitai[bot] commented 2 months ago

Walkthrough

The modifications enhance the create_new_instance and set_visible_nodes functions by introducing init_method and location parameters. This allows for precise adjustments of node positions based on a specified reference point. The show_contextual_menu method in the VideoWidget class was also updated to utilize these parameters, improving the accuracy and flexibility of placements during user interactions.

Changes

File	Change Summary
`sleap/gui/commands.py`	Added `init_method` and `location` parameters to `create_new_instance` and `set_visible_nodes` functions for improved control over node positioning.
`sleap/gui/widgets/video.py`	Updated `show_contextual_menu` method to include `location` in calls to `newInstance`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VideoWidget
    participant ContextMenu
    participant Command

    User ->> VideoWidget: Right-click for context menu
    VideoWidget ->> ContextMenu: Display options
    ContextMenu ->> User: Show "Default" option
    User ->> ContextMenu: Select "Default"
    ContextMenu ->> VideoWidget: Trigger newInstance(init_method="best", location=scene_pos)
    VideoWidget ->> Command: create_new_instance(location=scene_pos)
    Command ->> Command: Adjust node positions based on location

Poem

In fields of code, nodes find their place,
Guided by points in virtual space.
With location set, they now align,
A dance of logic, pure design.
Context menus lead the way,
To precise positions, come what may. 🌟

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.

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 70.58824% with 10 lines in your changes missing coverage. Please review.

Project coverage is 74.34%. Comparing base (7ed1229) to head (6d7943a). Report is 24 commits behind head on develop.

Files	Patch %	Lines
sleap/gui/commands.py	72.72%	9 Missing :warning:
sleap/gui/widgets/video.py	0.00%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #1859 +/- ## =========================================== + Coverage 73.30% 74.34% +1.03% =========================================== Files 134 135 +1 Lines 24087 24755 +668 =========================================== + Hits 17658 18405 +747 + Misses 6429 6350 -79 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

talmolab / sleap