break(objects): adds new convert to native displayable bindings #2846
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlanRynne
approved these changes
Aug 14, 2023
teocomi
approved these changes
Aug 14, 2023
AlanRynne
changed the title
AlanRynne
added
core
AlanRynne
reviewed
Aug 15, 2023
Core/Core/Kits/ISpeckleConverter.cs
Outdated
Comment on lines
58
to
76
| /// <summary> | ||
| /// Converts a Speckle object to a native displayable one | ||
| /// </summary> | ||
| /// <param name="object">Speckle object to convert</param> | ||
| /// <returns></returns> | ||
| public object ConvertToNativeDisplayable(Base @object); | ||
|
|
||
| /// <summary> | ||
| /// Checks if it can convert a Speckle object to a native one | ||
| /// </summary> | ||
| /// <param name="object">Speckle object to convert</param> | ||
| /// <returns></returns> | ||
| public bool CanConvertToNative(Base @object); | ||
|
|
||
| /// <summary> | ||
| /// Checks if it can convert a Speckle object to a native displayable one | ||
| /// </summary> | ||
| /// <param name="object">Speckle object to convert</param> | ||
| /// <returns></returns> |
There was a problem hiding this comment.
Regarding the xml docs: Maybe we should be more thorough on the explanation of what this is intended for, to prevent misusage in the near future by us or others.
Current one seems rather vague. It also seems it's not correctly defined for me:
What this does is convert a "displayable Speckle Object" into native; rather than convert a "generic speckle object" into "native displayable".
|
Updated branch from |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description & motivation
Adds new
ConvertToNativeDisplayable()andCanConvertToNativeDisplayable()bindings to ourISpeckleConverterinterface.These bindings are a prerequisite to pr #2841 and part of #2777
Changes:
Converters
Checklist: