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

Code Quality - Added StorageBar and StorageRing Controls #16001

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

mdtauk
Copy link
Contributor

@mdtauk mdtauk commented Aug 12, 2024

Resolved / Related Issues
This adds StorageBar and StorageRing controls to the Files.App.Controls project for future use, as well as a test page in the UITests app for testing behaviour.

image

image

image

I am no expert when it comes to coding let alone making Controls, so I would appreciate these be given a thorough review to ensure there are no edge cases I have not anticipated, as well as general changes to improve the code by those with the expertise and experience. I will call out @yaira2 and @0x5bfa who have been seeing my progress via Discord as I was working on them. But also anyone with control and or mathematics experience who can ensure I am using the most optimal calculations for the angles and size calculations. @marcelwgn has contributed to the Community Toolkit so will be able to make some comments on my properties and general code quality.

I also want to indicate I took great inspiration from the RadialGuage control in the Toolkit, as well as the blogposts and sample code from Diederik Krols and his blog posts.

As well as Co-Pilot for maths queries and interpolation code suggestions, here are other posts I found helpful

@mdtauk
Copy link
Contributor Author

mdtauk commented Aug 12, 2024

A final round of cleaning up or adding comments to parts of the controls can be done soon, but I wanted to get the functional code in after working on it on and off outside of the repo and adding it to the repo over the past week or so

@mdtauk
Copy link
Contributor Author

mdtauk commented Aug 15, 2024

A final round of cleaning up or adding comments to parts of the controls can be done soon, but I wanted to get the functional code in after working on it on and off outside of the repo and adding it to the repo over the past week or so

This is done now

/// <summary>
/// Updates the RingShape path
/// </summary>
private void UpdatePath()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method should be split into multiple smaller functions. Also, I think the comment is kind of redundant and can be left out.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am breaking this up into smaller functions and updated comments

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think now is good?

var result = number % divider;

// Ensure the result is positive or zero
result = result < 0 ? result + divider : result;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, this only works if number > -divider

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0x5bfa How do you suggest I change the method to ensure it works correctly?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're ensuring it be positive or zero, can't it be 'result < 0 ? 0 : result'?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What kind of modulus is this?

//var easedT = EaseInOutFunction(t);
var easedT = EaseOutCubic(t);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume one of those two lines with the accompanying functions will be cleaned up?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was testing the two easing functions, we can remove the commented out one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will remove the comment, but keep the other easing method in case we can use it later. Unless you think we should remove the method even if it is unused in the short term?

src/Files.App.Controls/Storage/StorageRing/StorageRing.cs Outdated Show resolved Hide resolved
src/Files.App.Controls/Storage/StorageRing/StorageRing.cs Outdated Show resolved Hide resolved
/// <param name="minValue">The minimum value of the input range.</param>
/// <param name="maxValue">The maximum value of the input range.</param>
/// <returns>The percentage value (between 0 and 100).</returns>
private double DoubleToPercentage(double value, double minValue, double maxValue)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should introduce a separate Math util file given we have multiple math "add-ons" across controls.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will do this in a future commit. @0x5bfa If you can help me go through the various calculation methods, and separate them into their own code file, I would greatly appreciate it.

src/Files.App.Controls/Storage/StorageRing/StorageRing.cs Outdated Show resolved Hide resolved
Grid.Row="0"
HorizontalAlignment="Center"
VerticalAlignment="Center"
Text="Customised" />

This comment was marked as resolved.

Grid.Row="0"
HorizontalAlignment="Center"
VerticalAlignment="Center"
Text="Customised" />

This comment was marked as resolved.

Lamparter

This comment was marked as resolved.

Lamparter

This comment was marked as duplicate.

@yaira2 yaira2 marked this pull request as draft November 4, 2024 16:15
@0x5bfa 0x5bfa self-assigned this Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants