Feature/navigation state (#930)

* Replace setCameraState with setNavigationState + equivalents
* Add documentation and verification of NavigationState-related interfaces
* Documentation and verification fixes
* Change reference frame behavior
* Scene fixes
* Replace earthrise recording with navigation state and time

include/openspace/interaction/navigationhandler.h

@@ -25,13 +25,17 @@
 #ifndef __OPENSPACE_CORE___NAVIGATIONHANDLER___H__
 #define __OPENSPACE_CORE___NAVIGATIONHANDLER___H__
 
-#include <openspace/properties/propertyowner.h>
-
+#include <openspace/documentation/documentation.h>
+#include <openspace/interaction/inputstate.h>
 #include <openspace/interaction/joystickcamerastates.h>
+#include <openspace/interaction/orbitalnavigator.h>
+#include <openspace/interaction/keyframenavigator.h>
+#include <openspace/properties/propertyowner.h>
 #include <openspace/properties/stringproperty.h>
 #include <openspace/properties/scalar/boolproperty.h>
 #include <openspace/util/mouse.h>
 #include <openspace/util/keys.h>
+#include <optional>
 
 namespace openspace {
     class Camera;
@@ -48,6 +52,25 @@ class OrbitalNavigator;
 
 class NavigationHandler : public properties::PropertyOwner {
 public:
+    struct NavigationState {
+        NavigationState() = default;
+        NavigationState(const ghoul::Dictionary& dictionary);
+        NavigationState(std::string anchor, std::string aim, std::string referenceFrame,
+            glm::dvec3 position, std::optional<glm::dvec3> up = std::nullopt,
+            double yaw = 0.0, double pitch = 0.0);
+
+        ghoul::Dictionary dictionary() const;
+        static documentation::Documentation Documentation();
+
+        std::string anchor;
+        std::string aim;
+        std::string referenceFrame;
+        glm::dvec3 position;
+        std::optional<glm::dvec3> up;
+        double yaw = 0.0;
+        double pitch = 0.0;
+    };
+
     NavigationHandler();
     ~NavigationHandler();
 
@@ -55,10 +78,10 @@ public:
     void deinitialize();
 
     // Mutators
+    void setNavigationStateNextFame(NavigationState state);
     void setCamera(Camera* camera);
     void setInterpolationTime(float durationInSeconds);
 
-    void setCameraStateFromDictionary(const ghoul::Dictionary& cameraDict);
     void updateCamera(double deltaTime);
     void setEnableKeyFrameInteraction();
     void setDisableKeyFrameInteraction();
@@ -66,12 +89,11 @@ public:
     void stopPlayback();
 
     // Accessors
-    ghoul::Dictionary cameraStateDictionary();
     Camera* camera() const;
     const InputState& inputState() const;
     const OrbitalNavigator& orbitalNavigator() const;
     OrbitalNavigator& orbitalNavigator();
-    KeyframeNavigator& keyframeNavigator() const;
+    KeyframeNavigator& keyframeNavigator();
     bool isKeyFrameInteractionEnabled() const;
     float interpolationTime() const;
 
@@ -100,10 +122,14 @@ public:
     void clearJoystickButtonCommand(int button);
     std::vector<std::string> joystickButtonCommand(int button) const;
 
+    NavigationState navigationState(const SceneGraphNode& referenceFrame) const;
 
+    void saveNavigationState(const std::string& filepath, 
+        const std::string& referenceFrameIdentifier);
 
-    void saveCameraStateToFile(const std::string& filepath);
-    void restoreCameraStateFromFile(const std::string& filepath);
+    void loadNavigationState(const std::string& filepath);
+
+    void setNavigationStateNextFrame(NavigationState state);
 
     /**
     * \return The Lua library that contains all Lua functions available to affect the
@@ -112,15 +138,18 @@ public:
     static scripting::LuaLibrary luaLibrary();
 
 private:
-    bool _cameraUpdatedFromScript = false;
+    void applyNavigationState(const NavigationHandler::NavigationState& ns);
+
     bool _playbackModeEnabled = false;
 
-    std::unique_ptr<InputState> _inputState;
+    InputState _inputState;
     Camera* _camera = nullptr;
     std::function<void()> _playbackEndCallback;
 
-    std::unique_ptr<OrbitalNavigator> _orbitalNavigator;
-    std::unique_ptr<KeyframeNavigator> _keyframeNavigator;
+    OrbitalNavigator _orbitalNavigator;
+    KeyframeNavigator _keyframeNavigator;
+
+    std::optional<NavigationState> _pendingNavigationState;
 
     properties::BoolProperty _useKeyFrameInteraction;
 };