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

Check for and return null for non-planar and/or open curves #44

Merged

Conversation

IsakNaslundBh
Copy link
Contributor

@IsakNaslundBh IsakNaslundBh commented Sep 16, 2022

Issues addressed by this PR

Closes #43

Checks that the input curve is closed and/or planar, and returns null if found, as method was returning non-sensical results for those cases.

Adding tolerance input with default value to allow to control the checks for closedness as well as planarity.

Test files

Alpha test script:

https://burohappold.sharepoint.com/:f:/s/BHoM/EjCPW4vnq01MpH8Hd1LH7yEBS8rQTHYsPDoTOKXxHUA2iw?e=54PEjT

Script testing closed/non-planar curve errors:

https://burohappold.sharepoint.com/:f:/s/BHoM/EqxYAD6Hl09DpkVDdgf_Z3sBlbSHUCT6sCzApgwWCd4jyQ?e=KLduTh

Changelog

Additional comments

@tg359 @jamesramsden-bh , I think this method is used in BEnv toolkits, so great if one of you can confirm that you are happy with this, and make sure your workflows still function.

@IsakNaslundBh IsakNaslundBh added the type:bug Error or unexpected behaviour label Sep 16, 2022
@IsakNaslundBh IsakNaslundBh self-assigned this Sep 16, 2022
@IsakNaslundBh
Copy link
Contributor Author

@BHoMBot check compliance

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

There are 1 requests in the queue ahead of you.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

There are 7 requests in the queue ahead of you.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check branch-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check copyright-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh fix requested for project compliance.

The errors with the CSProject (.csproj) files have been recorded as annotations on the checks tab.

I will apply the fixes to every case detailed on the checks tab with the exception of any references to the target framework. I am unable to provide fixes to the Target Framework automatically, these will need to be performed manually. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix project file ref. 8387982549

1 similar comment
@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh fix requested for project compliance.

The errors with the CSProject (.csproj) files have been recorded as annotations on the checks tab.

I will apply the fixes to every case detailed on the checks tab with the exception of any references to the target framework. I am unable to provide fixes to the Target Framework automatically, these will need to be performed manually. If you want to perform the fixes in a different manner please resolve this manually and rerun the check.

If you are happy for me to go ahead and perform this action, please reply with:

@BHoMBot fix project file ref. 8387982549

@IsakNaslundBh
Copy link
Contributor Author

@BHoMBot fix project file ref. 8387982549

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh I have queued up your request to fix the csproj file(s). There are 4 requests in the queue ahead of you.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh I have queued up your request to fix the csproj file(s). There are 5 requests in the queue ahead of you.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh I am now going to fix the project compliance in accordance with the annotations previously made.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh to confirm I have now resolved the project compliance issues and pushed a commit to this Pull Request.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh I am now going to fix the project compliance in accordance with the annotations previously made.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@IsakNaslundBh to confirm I have now resolved the project compliance issues and pushed a commit to this Pull Request.

@FraserGreenroyd
Copy link

@BHoMBot check versioning

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@FraserGreenroyd to confirm, the following actions are now queued:

  • check versioning

There are 12 requests in the queue ahead of you.

Copy link
Contributor

@tg359 tg359 left a comment

Choose a reason for hiding this comment

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

Tested and the checks work. I couldn't find any references in the TK's I thought they'd be in - but non-planar offsets wouldn't be possible in any workflows I know off, so approving.

@FraserGreenroyd
Copy link

@BHoMBot check compliance
@BHoMBot check required
@BHoMBot check ready-to-merge

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@FraserGreenroyd to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance
  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check core
  • check null-handling
  • check serialisation
  • check versioning
  • check installer
  • check ready-to-merge

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check project-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check versioning has already been run previously and recorded as a successful check. This check has not been run again at this time.

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

The check installer has already been run previously and recorded as a successful check. This check has not been run again at this time.

@FraserGreenroyd
Copy link

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: dataset-compliance

@bhombot-ci
Copy link

bhombot-ci bot commented Sep 16, 2022

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.

@FraserGreenroyd FraserGreenroyd merged commit 769e3a3 into main Sep 16, 2022
@FraserGreenroyd FraserGreenroyd deleted the Clipper_Toolkit-#43-AddChecksForCLosednessAndPlanarity branch September 16, 2022 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug Error or unexpected behaviour
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Open and Non-planar curves treated as planar closed curves, with no warning or error
4 participants