Schneegans commented 2 years ago

This major refactoring reduces the CPU load of scenes containing many celestial bodies significantly. The primary change is a shift from inheritance to composition when it comes to the celestial anchors. For the default scene, the time to update the SolarSystem has been reduced by more than 50% (on my machine from 11 ms to 5 ms).

Primary Changes

The Settings class now has a map of immutable CelestialObjects which are instantiated when CosmoScout is started. Before it used to have a list of anchor configurations which could be used to initialize CelestialObjects.
CelestialObjects now have four new properties:
- bodyCullingRadius: This can be used to determine the visiblity of an object. If the object is too far away to be seen, plugins may want to skip updating or drawing attached things.
- orbitCullingRadius:This can be used to determine the visiblity of an object's trajectory. If the object is really far away, plugins may want to skip updating or drawing attached things (like trajectories or anchor labels).
- trackable: If set to false, the observer will not automatically follow this object.
- collidable: If set to false, the observer can travel through the object.
The observer-relative transformation of each CelestialObject is updated once each frame by the SolarSystem.
All classes which previously derived from CelestialAnchor, CelestialObject, or CelestialBody now get the observer-relative transformation from the CelestialObjects in the Settings.
Classes which previously derived from CelestialBody now have to derive from the new class CelestialSurface. A CelestialSurface can then be assigned to a CelestialObject.
CelestialAnchorNodes do not exist anymore. Classes which used to use these, now have to use a VistaTransformNode instead and update its transformation once each frame with the observer-relative transformation from the respective CelestialObject.
Much per-frame logic used to be executed in overrides of CelestialObject::update(). This method does not exist any more; plugins now need to update their objects manually.
The Windows CI jobs do not use clcache anymore. See #299.

Other Changes

The mouse navigation has been made a bit smoother. This makes it possible to update the scene scale only once each frame. Before, it had to be updated multiple times each frame which introduced a significant CPU overhead during rapid movements.
All plugins now save their configuration before being unloaded. This makes it possible that plugins keep their current state when being reloaded at run-time.
Test source files are now only compiled into the executable and into the libraries if COSMOSCOUT_UNIT_TESTS is set to true.

`csp-anchor-labels`

Anchor Labels are now shown for each configured object per default. A blacklist has been added to the plugin configuration to remove labels selectively.
Anchor Labels now show the name of the configured object rather than the SPICE center name.
The maximum size of Anchor Labels has been increased to prevent line breaking for longer object names.
Anchor Labels now use the new orbitCullingRadius of the object for deciding whether they should be shown or not.

`csp-measurement-tools`

Some common code has been moved from the measurement tools to the base classes cs::core::tools::Tool and cs::core::tools::Mark. This simplifies some code in the measurement tools.

`csp-satellites`

It's now possible to reload this plugin at run-time.

`csp-wms-overlays`

A regression was fixed which led to low precision close to a bodies surface.

Future Work

The method SolarSystem::getObject() is called pretty frequently. Performance-wise it could be better to store weak_ptrs to the CelestialObjects instead of calling this method every frame. For now, most objects only store the name of the CelestialObject they are attached to and get the corresponding CelestialObject from the settings each frame.
If a plugin references an object which is actually not available (e.g. due to a typo in the scene configuration), CosmoScout will crash (it prints a error message though).
Adding and removing CelestialObjects at run-time could work now (like adding a completely new planet at run-time), but has not been tested. Plugins may need some tweaking to properly respond to this.

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build 3164757767

0 of 1375 (0.0%) changed or added relevant lines in 56 files are covered.
95 unchanged lines in 40 files lost coverage.
Overall coverage increased (+0.02%) to 3.011%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/cs-core/GraphicsEngine.cpp	0	1	0.0%
src/cs-scene/CelestialObject.hpp	0	1	0.0%
src/cs-scene/CelestialSurface.hpp	0	1	0.0%
plugins/csp-vr-accessibility/src/FovVignette.cpp	0	2	0.0%
src/cs-scene/CelestialAnchor.hpp	0	2	0.0%
plugins/csp-fly-to-locations/src/Plugin.cpp	0	3	0.0%
src/cosmoscout/ObserverNavigationNode.cpp	0	3	0.0%
src/cs-core/tools/DeletableMark.cpp	0	3	0.0%
src/cs-graphics/Shadows.cpp	0	4	0.0%
plugins/csp-recorder/src/Plugin.cpp	0	5	0.0%
<!--	Total:	0	1375	0.0%	-->

Files with Coverage Reduction	New Missed Lines	%
plugins/csp-anchor-labels/src/AnchorLabel.cpp	1	0%
plugins/csp-atmospheres/src/Atmosphere.cpp	1	0%
plugins/csp-custom-web-ui/src/Plugin.hpp	1	0%
plugins/csp-fly-to-locations/src/Plugin.cpp	1	0%
plugins/csp-lod-bodies/src/LodBody.cpp	1	0%
plugins/csp-lod-bodies/src/PlanetShader.cpp	1	0%
plugins/csp-measurement-tools/src/Plugin.cpp	1	0%
plugins/csp-minimap/src/Plugin.cpp	1	0%
plugins/csp-rings/src/Ring.cpp	1	0%
plugins/csp-satellites/src/Plugin.cpp	1	0%
<!--	Total:	95	-->

Totals
Change from base Build 2696156115:	0.02%
Covered Lines:	491
Relevant Lines:	16305

💛 - Coveralls

Schneegans commented 2 years ago

A tip for testing this: The DLR-internal configuration repository also contains a feature/refactor-celestial-anchors branch with updated configuration files.

JonasGilg commented 1 year ago

The csp-satellites plugin throws the following OpenGL errors:

[I] csp-satellites .... Loading plugin...
[W] cs-graphics ....... From vista-gltf: OpenGL error in "createGPUsampler": 1280 (1280) C:/C++/cs-gh/src/cs-graphics/internal/gltfmodel.cpp:916
[W] cs-graphics ....... From vista-gltf: OpenGL error in "createGPUsampler": 1280 (1280) C:/C++/cs-gh/src/cs-graphics/internal/gltfmodel.cpp:916
[W] cs-graphics ....... From vista-gltf: OpenGL error in "createGPUsampler": 1280 (1280) C:/C++/cs-gh/src/cs-graphics/internal/gltfmodel.cpp:916
[I] csp-satellites .... Loading done.

Schneegans commented 1 year ago