Simple-Objects Plugin #297

carlobrok · 2022-08-19T13:58:18Z

This pull request contains the new csp-simple-objects plugin with a readme.
With this it is possible to load glTF 3D models, place them on celestial bodies, rotate and move each object as desired.

Things that still need to be improved:

Replace the rotation input boxes and the button next to them with three Euler angle sliders. This means that conversion to a quaternion is still necessary.
The fly to object functionality is not implemented yet, but should be trivial.
CosmoScout VR crashes when entering a non-existent anchor name in the editor input field.
It's likely that there are other bugs that I haven't found yet.

coveralls · 2022-08-19T18:29:38Z

Pull Request Test Coverage Report for Build 2889928608

0 of 287 (0.0%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.05%) to 2.942%

Changes Missing Coverage	Changed/Added Lines	%
plugins/csp-simple-objects/src/logger.cpp	3	0.0%
plugins/csp-simple-objects/src/utils.cpp	18	0.0%
plugins/csp-simple-objects/src/SimpleObject.cpp	95	0.0%
plugins/csp-simple-objects/src/Plugin.cpp	171	0.0%

Totals
Change from base Build 2696156115:	-0.05%
Covered Lines:	491
Relevant Lines:	16691

💛 - Coveralls

Schneegans

Thank you very much! This looks pretty good already. I'll do some thorough tests and report any issues I find. For now, I added some remarks to the code.

You should also run the tools/clang-format script to apply some common formatting rules.

Edit: Make sure to unfold the hidden conversations below. GitHub does not like to show too many comments 😉.

Thank you!

Schneegans · 2022-08-31T10:11:29Z

plugins/csp-simple-objects/.gitignore

@@ -0,0 +1 @@
+*.drawio


This file could be dropped.

Schneegans · 2022-08-31T10:12:06Z

plugins/csp-simple-objects/LICENSE

@@ -0,0 +1,21 @@
+MIT License


This file could be dropped as well :)

Schneegans · 2022-08-31T11:01:36Z

plugins/csp-simple-objects/README.md

+
+
+![](demo_image.png)
+
+
+
+
+
+


Here plenty of empty lines.

Schneegans · 2022-08-31T11:03:06Z

plugins/csp-simple-objects/gui/css/csp-simple-objects.css

+ /*background-color: rgba(230, 230, 255, 0.1);
+ border-bottom: 2px solid var(--cs-color-primary);
+ box-shadow: none;
+ color: var(--cs-color-text);*/


Can this be removed?

Suggested change

/*background-color: rgba(230, 230, 255, 0.1);

border-bottom: 2px solid var(--cs-color-primary);

box-shadow: none;

color: var(--cs-color-text);*/

Schneegans · 2022-08-31T11:05:26Z

plugins/csp-simple-objects/gui/js/csp-simple-objects-editor.js

+ * Funktionalität für rückwärts tabben durch prevDiv und this.tabRevMap,
+ * aber rückwärts funktioniert nicht.. :(
+ * 
+ * Weil: "shift+tab" triggert keypress event nicht.
+ * -> nur "tab" (keyCodwe == 9) triggert keypress event. 
+ * 
+ * keydown wird durch "shift" getriggert, aber nicht durch "tab"?!
+ * -> während shift gedrückt ist kommt auch kein keypress event von tab. WARUM?!
+ * 
+ * Ist das irgendwo im code deaktiviert oder ist das hier eine ALTE VERSION?


Could you write this in english? 😉

Schneegans · 2022-08-31T11:31:08Z

plugins/csp-simple-objects/src/SimpleObject.hpp

+ glm::dquat qRot;
+ glm::dvec3 lastSurfaceNormal;
+
+ bool editEnabled = false;


Suggested change

bool editEnabled = false;

bool mEditEnabled = false;

Schneegans · 2022-08-31T11:31:33Z

plugins/csp-simple-objects/src/SimpleObject.hpp

+
+
+/*
+/// A single satellite within the Solar System.
+class Satellite : public cs::scene::CelestialBody {
+ public:
+ Satellite(Plugin::Settings::SimpleObject const& config, std::string const& anchorName,
+ VistaSceneGraph* sceneGraph, std::shared_ptr<cs::core::Settings> settings,
+ std::shared_ptr<cs::core::SolarSystem> solarSystem);
+
+ Satellite(Satellite const& other) = delete;
+ Satellite(Satellite&& other) = default;
+
+ Satellite& operator=(Satellite const& other) = delete;
+ Satellite& operator=(Satellite&& other) = delete;
+
+ ~Satellite() override;
+
+ void update(double tTime, cs::scene::CelestialObserver const& oObs) override;
+
+ void setSun(std::shared_ptr<const cs::scene::CelestialObject> const& sun);
+
+ // interface of scene::CelestialBody ---------------------------------------
+
+ bool getIntersection(
+ glm::dvec3 const& rayPos, glm::dvec3 const& rayDir, glm::dvec3& pos) const override;
+ double getHeight(glm::dvec2 lngLat) const override;
+
+ private:
+ VistaSceneGraph* mSceneGraph;
+ std::shared_ptr<cs::core::Settings> mSettings;
+ std::shared_ptr<cs::core::SolarSystem> mSolarSystem;
+ std::unique_ptr<VistaTransformNode> mAnchor;
+ std::unique_ptr<cs::graphics::GltfLoader> mModel;
+ std::shared_ptr<const cs::scene::CelestialObject> mSun;
+}; */
+
+


Suggested change

/*

/// A single satellite within the Solar System.

class Satellite : public cs::scene::CelestialBody {

public:

Satellite(Plugin::Settings::SimpleObject const& config, std::string const& anchorName,

VistaSceneGraph* sceneGraph, std::shared_ptr<cs::core::Settings> settings,

std::shared_ptr<cs::core::SolarSystem> solarSystem);

Satellite(Satellite const& other) = delete;

Satellite(Satellite&& other) = default;

Satellite& operator=(Satellite const& other) = delete;

Satellite& operator=(Satellite&& other) = delete;

~Satellite() override;

void update(double tTime, cs::scene::CelestialObserver const& oObs) override;

void setSun(std::shared_ptr<const cs::scene::CelestialObject> const& sun);

// interface of scene::CelestialBody ---------------------------------------

bool getIntersection(

glm::dvec3 const& rayPos, glm::dvec3 const& rayDir, glm::dvec3& pos) const override;

double getHeight(glm::dvec2 lngLat) const override;

private:

VistaSceneGraph* mSceneGraph;

std::shared_ptr<cs::core::Settings> mSettings;

std::shared_ptr<cs::core::SolarSystem> mSolarSystem;

std::unique_ptr<VistaTransformNode> mAnchor;

std::unique_ptr<cs::graphics::GltfLoader> mModel;

std::shared_ptr<const cs::scene::CelestialObject> mSun;

}; */

Schneegans · 2022-08-31T11:33:21Z

plugins/csp-simple-objects/src/utils.hpp

+namespace csp::simpleobjects { 
+
+namespace utils { 


These could be merged, I guess.

Suggested change

namespace csp::simpleobjects {

namespace utils {

namespace csp::simpleobjects::utils {

Schneegans · 2022-08-31T11:33:44Z

plugins/csp-simple-objects/src/utils.hpp

+} //namespace utils
+
+} // namespace csp::simplobjects


Suggested change

} //namespace utils

} // namespace csp::simplobjects

} // namespace csp::simplobjects::utils

Schneegans · 2022-08-31T11:35:43Z

plugins/csp-simple-objects/src/utils.hpp

+ glm::dvec3 getSurfaceNormal(const glm::dvec2 &lngLat, std::shared_ptr<cs::scene::CelestialBody> &body, const double offset = 0.9F); 
+
+ // wrapper around cs::utils::convert::toCartesian for easier 
+ // access to position from getSurfaceNormal() 
+ glm::dvec3 getLngLatPositionOnBody(const glm::dvec2 &lngLat, std::shared_ptr<cs::scene::CelestialBody> &body);
+
+ glm::dquat normalToRotation(const glm::dvec3 &normal);


By convention, the const& notation is used in CosmoScout. Also, the const before the double is not required and the shared_ptr could be pass as const& as well.

Suggested change

glm::dvec3 getSurfaceNormal(const glm::dvec2 &lngLat, std::shared_ptr<cs::scene::CelestialBody> &body, const double offset = 0.9F);

// wrapper around cs::utils::convert::toCartesian for easier

// access to position from getSurfaceNormal()

glm::dvec3 getLngLatPositionOnBody(const glm::dvec2 &lngLat, std::shared_ptr<cs::scene::CelestialBody> &body);

glm::dquat normalToRotation(const glm::dvec3 &normal);

glm::dvec3 getSurfaceNormal(glm::dvec2 const& lngLat, std::shared_ptr<cs::scene::CelestialBody> const& body, double offset = 0.9F);

// wrapper around cs::utils::convert::toCartesian for easier

// access to position from getSurfaceNormal()

glm::dvec3 getLngLatPositionOnBody(glm::dvec2 const& lngLat, std::shared_ptr<cs::scene::CelestialBody> const& body);

glm::dquat normalToRotation(glm::dvec3 const& normal);

Schneegans · 2022-09-02T08:27:30Z

I played around with the plugin! Most of the time, it works flawlessly. However, in addition to the list of issues you posted above, I discovered some further things:

Saving a scene does not seem to work.
1. Place some objects.
2. Call CosmoScout.callbacks.core.save("test.json")
3. Restart CosmoScout VR
4. Call CosmoScout.callbacks.core.load("test.json")
5. The previously placed objects are not there.
The sun light direction is not updated
- I think basically something like this is missing.
There seems to be a minimum distance for the object location picking to be available. For me, this is a bit confusing. Is there a reason for it not being always available?
Sometimes, objects become transparent. They may actually not be transparent but the draw order could be wrong. This is not-so-easy to reproduce, however, here's a possibility:
1. Start cosmoscout with the example configuration (avocado & curiosity on Mars).
2. Uncheck Advanced Settings -> Atmospheres -> Enabled. This will make the issue easier to spot.
3. Fly to Earth and land on the surface, let's say in Italy.
4. Use the edit button and then the surface picking to place curiosity somewhere in Italy.
5. You may have to adjust the size to see it, let's insert 100.
6. Observe the stars through curiosity 😉
7. If you save the object, the issues persists. However, if you edit it again, it looks fine. But only until you save it again.

Carlo Brokering and others added 6 commits August 19, 2022 14:38

Don't ignore plugins/csp-simple-objects

9060f73

Add csp-simple-objecs plugin

c37c20f

Inserted new README

5d5977e

🔧 sleep_for as bugix did not work

0887b4a

📝 Added links to demo model files

9812e2d

📝 corrected link to mars environment map

f8c038f

JonasGilg requested a review from Schneegans August 19, 2022 18:03

JonasGilg added the new feature A feature request or a general improvement idea label Aug 19, 2022

Schneegans requested changes Aug 31, 2022

View reviewed changes

Schneegans changed the title ~~🎉🎨 New simple objects plugin added~~ Simple-Objects Plugin Sep 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simple-Objects Plugin #297

Simple-Objects Plugin #297

carlobrok commented Aug 19, 2022

coveralls commented Aug 19, 2022

Schneegans left a comment •

edited

Loading

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans Aug 31, 2022

Schneegans commented Sep 2, 2022

		@@ -0,0 +1 @@
		*.drawio



		![](demo_image.png)

Simple-Objects Plugin #297

Are you sure you want to change the base?

Simple-Objects Plugin #297

Conversation

carlobrok commented Aug 19, 2022

coveralls commented Aug 19, 2022

Pull Request Test Coverage Report for Build 2889928608

💛 - Coveralls

Schneegans left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Schneegans commented Sep 2, 2022

Schneegans left a comment •

edited

Loading