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

Scripting API, what is a substitution for StelSkyDrawer.setBortleScaleIndex? #3390

Closed
andrey-nakin opened this issue Sep 5, 2023 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation question Just a question, no change in code needed
Projects
Milestone

Comments

@andrey-nakin
Copy link

Hello!

StelSkyDrawer no longer has setBortleScaleIndex method in Scripting API.

What can be used as a substitution for it?

@10110111
Copy link
Contributor

10110111 commented Sep 5, 2023

Looking at the code I can't confirm that there's no such method. How did you conclude this?

@andrey-nakin andrey-nakin changed the title Scripting API, what is a substitute for StelSkyDrawer.setBortleScaleIndex? Scripting API, what is a substitution for StelSkyDrawer.setBortleScaleIndex? Sep 5, 2023
@andrey-nakin
Copy link
Author

The setBortleScaleIndex method is not listed on documentation page: https://stellarium.org/doc/23.0/classStelSkyDrawer.html

Also, my script fails when attempting to execute StelSkyDrawer.setBortleScaleIndex method.

@alex-w
Copy link
Member

alex-w commented Sep 5, 2023

See http://stellarium.org/doc/23.0/classStelSkyDrawer.html#a4e4405fbd4a1a36c4d8b89d5de4abf50

@alex-w alex-w added this to Needs triage in Scripting via automation Sep 5, 2023
@10110111
Copy link
Contributor

10110111 commented Sep 5, 2023

@alex-w

The limit is valid only at a given zoom level (around 60 deg)

What is this about? Is the text misplaced?

@alex-w
Copy link
Member

alex-w commented Sep 5, 2023

From the description: Set the parameters so that the stars disappear at about the naked-eye limiting magnitude corresponding to the given zenith luminance at moonless night.

P.S. I think the description of setLightPollutionLuminance should be improved

@andrey-nakin
Copy link
Author

@alex-w thank you!

Is there an easy way to convert bortle scale to a magnitude/arcmin^2?

@alex-w
Copy link
Member

alex-w commented Sep 5, 2023

@andrey-nakin please see https://en.wikipedia.org/wiki/Bortle_scale (hint: SQM)

@10110111
Copy link
Contributor

10110111 commented Sep 5, 2023

From the description

Either my browser is broken, or the Doxygen output is:

Screenshot_2023-09-05_16-03-45

@alex-w
Copy link
Member

alex-w commented Sep 5, 2023

From the description

Either my browser is broken, or the Doxygen output is:

Screenshot_2023-09-05_16-03-45

This part you will see when link “more” is pressing in the list of scriptable methods above.

@alex-w alex-w added question Just a question, no change in code needed documentation Improvements or additions to documentation labels Sep 5, 2023
@alex-w alex-w added this to the 23.3 milestone Sep 5, 2023
@github-actions
Copy link

github-actions bot commented Sep 5, 2023

Thank you for suggesting documentation improvement.

@10110111
Copy link
Contributor

10110111 commented Sep 5, 2023

This part you will see when link “more” is pressing in the list of scriptable methods above.

Well, this is a bad layout, because I got to this part by mere following your link. The @brief should also be there in the full section. If the layout can't be changed, then the approach to filling the @brief and the full parts in the sources should be changed.

@alex-w
Copy link
Member

alex-w commented Sep 5, 2023

This part you will see when link “more” is pressing in the list of scriptable methods above.

Well, this is a bad layout, because I got to this part by mere following your link. The @brief should also be there in the full section. If the layout can't be changed, then the approach to filling the @brief and the full parts in the sources should be changed.

You can propose better layout.

P.S. The current layout was prepared around doxygen 1.6 and I far as I can remember it was some limits or problems when brief and full descriptions was showing together.

@alex-w alex-w self-assigned this Sep 11, 2023
@alex-w alex-w closed this as completed Sep 11, 2023
Scripting automation moved this from Needs triage to Done Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Just a question, no change in code needed
Projects
Scripting
  
Done
Development

No branches or pull requests

3 participants