Allowed editing in single shape annotation mode

bsekachev commented 3 months ago

Motivation and context

How has this been tested?

Checklist

[x] I submit my changes into the develop branch
[ ] I have created a changelog fragment
[ ] I have updated the documentation accordingly
[ ] I have added tests to cover my changes
[ ] I have linked related issues (see GitHub docs)
[ ] I have increased versions of npm packages if it is necessary (cvat-canvas, cvat-core, cvat-data and cvat-ui)

License

[x] I submit my code changes under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

New Features
- Introduced a new workspace type Workspace.SINGLE_SHAPE for more flexible annotation options.
- Added functionality to move to the next frame within the single-shape workspace.
Refactor
- Renamed CSS class for better clarity in the single-shape workspace sidebar.
Documentation
- Updated the Single Shape annotation mode guide with improved hints for using the interface.
Tests
- Updated end-to-end tests to reflect the new button action from 'Skip' to 'Next' in the single-shape annotation process.

coderabbitai[bot] commented 3 months ago

[!IMPORTANT]

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update introduces a new workspace type, Workspace.SINGLE_SHAPE, to the CanvasWrapperComponent class, enhancing its functionality. Changes in the single-shape workspace include new action types, refactored event handlers, and UI adjustments. The styles have been updated to reflect these changes, and documentation and tests have been modified to align with the new workflow.

Changes

File Path	Summary
`cvat-ui/src/components/annotation-page/canvas/views/canvas2d/...`	Added `Workspace.SINGLE_SHAPE` to condition checks in `CanvasWrapperComponent`.
`cvat-ui/src/components/annotation-page/single-shape-workspace/...`	Added `SET_NEXT_FRAME` action, refactored event handlers, and updated UI interactions.
`cvat-ui/src/components/annotation-page/single-shape-workspace/styles.scss`	Renamed class `.cvat-single-shape-annotation-sidebar-skip-wrapper` to `.cvat-single-shape-annotation-sidebar-finish-frame-wrapper`.
`site/content/en/docs/manual/advanced/single-shape.md`	Updated `List of Hints` section to reflect new interface usage and undo functionality.
`tests/cypress/e2e/features/single_object_annotation.js`	Updated button action from 'Skip' to 'Next' and modified control flow in tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI as Annotation UI
    participant Canvas as CanvasWrapperComponent
    participant Sidebar as SingleShapeSidebar

    User->>UI: Select SINGLE_SHAPE workspace
    UI->>Canvas: Initialize with SINGLE_SHAPE
    Canvas->>Sidebar: Notify workspace change
    User->>Sidebar: Annotate shape
    Sidebar->>Canvas: Update annotation
    Sidebar->>Sidebar: Handle SET_NEXT_FRAME action
    Sidebar->>Canvas: Finish frame and move to next
    Canvas->>UI: Update display
    UI->>User: Show next frame

Poem

In the realm of shapes, a new type's found,
SINGLE_SHAPE workspace, where annotations abound.
With actions refined and frames to skip,
The sidebar's ready for a smoother trip.
Next frame awaits, the journey's bright,
Annotate with ease, from day to night.
🎨✨🐇

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 Configration 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-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.52%. Comparing base (5d36d10) to head (1a2b56a). Report is 3 commits behind head on develop.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #8017 +/- ## =========================================== - Coverage 83.54% 83.52% -0.03% =========================================== Files 384 384 Lines 40377 40377 Branches 3771 3771 =========================================== - Hits 33734 33724 -10 - Misses 6643 6653 +10 ``` | [Components](https://app.codecov.io/gh/cvat-ai/cvat/pull/8017/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cvat-ai) | Coverage Δ | | |---|---|---| | [cvat-ui](https://app.codecov.io/gh/cvat-ai/cvat/pull/8017/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cvat-ai) | `79.33% <100.00%> (-0.05%)` | :arrow_down: | | [cvat-server](https://app.codecov.io/gh/cvat-ai/cvat/pull/8017/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cvat-ai) | `87.33% <ø> (-0.01%)` | :arrow_down: |