Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚧Add resize capture in scenes #954

Closed
9 tasks done
CalvinWilkinson opened this issue Apr 24, 2024 · 1 comment · Fixed by #968
Closed
9 tasks done

🚧Add resize capture in scenes #954

CalvinWilkinson opened this issue Apr 24, 2024 · 1 comment · Fixed by #968
Assignees
Labels
medium-priority Medium Priority ✨new-feature New feature that does not exist preview Done while in preview

Comments

@CalvinWilkinson
Copy link
Member

CalvinWilkinson commented Apr 24, 2024

Complete The Item Below

  • I have updated the title without removing the 🚧 emoji.

Description

Add the ability to get updates on when the window size has changed in the scene system.

This will allow users to know when the window size has changed in a scene. This will involve adding a new virtual method to the SceneBase class, which will implement the new method that will be added to the IScene interface.

Also, this will need to be added to the ISceneManager interface.

  1. Add a new method to the IScene interface named Resize(SizeU size)
    • Code Docs
      /// <summary>
      /// Updates the <see cref="WindowSize"/>.
      /// </summary>
      /// <param name="size">The new size.</param>
  2. Add a new virtual method implementation to the SceneBase class
    • This is what will get invoked by the internal SceneManager class
    • This will use /// <inheritdoc/> for the code docs
  3. Add a new method to the ISceneManager interface named Resize(SizeU size)
    • Code docs
      /// <summary>
      /// Updates the size of the window for each scene.
      /// </summary>
      /// <param name="size">The new size.</param>
  4. Add the new method implementation with the name Resize(SizeU size) to the internal SceneManager class.
    • This method will be invoked by the Window class in the protected virtual void OnResize(SizeU size) method
    • This will use /// <inheritdoc/> for the code docs
  5. Update the scene guide on the main docs (This will be done by @CalvinWilkinson once this issue is complete)

Note

Coding Standards:

  1. Make sure to use expression bodied methods when there is only a single statement for methods.

Acceptance Criteria

The items to complete to satisfy the Definition of Done.

Preview Give feedback

ToDo Items

The items to complete to satisfy the Definition of Done.

Preview Give feedback

Issue Dependencies

No response

Related Work

No response

Additional Information:

Unit Tests

Reasons for local unit test execution:

  • Unit tests might pass locally but not in the CI environment during the status check process or vice-versa.
  • Tests might pass on the developer's machine but not necessarily on the code reviewer's machine.
  • If you notice that the test status check has passed but the test failed locally, please notify a project maintainer!

💡Warning💡
If the unit tests pass remotely and are not executed locally, this means we could be letting a bug slip into production.
Though bugs will always exist in some capacity, we should all do our part to help prevent them from happening.

Change Type Labels

Change Type Label
Bug Fixes 🐛bug
Breaking Changes 🧨breaking changes
New Feature ✨new feature
CICD Changes ♻️cicd
Config Changes ⚙️config
Performance Improvements 🏎️performance
Code Doc Changes 🗒️documentation/code
Product Doc Changes 📝documentation/product

Priority Type Labels

Priority Type Label
Low Priority low priority
Medium Priority medium priority
High Priority high priority

Code of Conduct

  • I agree to follow this project's Code of Conduct.
@CalvinWilkinson CalvinWilkinson added ✨new-feature New feature that does not exist medium-priority Medium Priority preview Done while in preview labels Apr 24, 2024
@CalvinWilkinson CalvinWilkinson added this to the v1.0.0-preview.36 milestone Apr 24, 2024
@github-project-automation github-project-automation bot moved this to ⚪Not Set in KD-Team Apr 24, 2024
@AndreBonda
Copy link
Contributor

I can take it.

@CalvinWilkinson CalvinWilkinson moved this from ⚪Not Set to 🏗️In Development in KD-Team May 15, 2024
AndreBonda added a commit to AndreBonda/Velaptor that referenced this issue May 17, 2024
CalvinWilkinson pushed a commit that referenced this issue May 18, 2024
* Start work for issue #954

* Add Resize method declaration to IScene interface and the implementation to SceneBase class.

* Add Resize method declaration to ISceneManager interface and the implementation to SceneManager class.

* OnResize method in Window class invokes Resize method.
@github-project-automation github-project-automation bot moved this from 🏗️In Development to ✅Done in KD-Team May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
medium-priority Medium Priority ✨new-feature New feature that does not exist preview Done while in preview
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants