Making it easier to integrate PlanetsLib into existing planets with vanilla-style orbit information #40
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.
I have added an additional step to PlanetsLib:extend that reduces the amount of work needed to integrate a planet into PlanetsLib. In the current version of PlanetsLib, all PlanetsLib planets must have a fully defined orbit field, so this change will not break compatibility with any planets currently using PlanetsLib.
If config.distance and config.orientation exist, but config.orbit is undefined, this code concludes that its orbit should go around the sun like all non-PlanetsLib planets, and generates an orbit field with that assumption, deleting config.distance and config.orientation.
This change will make it easier to integrate PlanetsLib into existing planets by eliminating the need to learn how the orbit field must be defined. With this change, only bodies that have an unusual orbit will need to have a fully-defined orbit according to PlanetsLib conventions.