Merge branch 'master' into feature/FastVolume

include/openspace/engine/globals.h

@@ -53,6 +53,7 @@ namespace configuration { struct Configuration; }
 namespace interaction {
     struct JoystickInputStates;
     struct WebsocketInputStates;
+    class InteractionMonitor;
     class KeybindingManager;
     class NavigationHandler;
     class SessionRecording;
@@ -87,6 +88,7 @@ VersionChecker& gVersionChecker();
 VirtualPropertyManager& gVirtualPropertyManager();
 WindowDelegate& gWindowDelegate();
 configuration::Configuration& gConfiguration();
+interaction::InteractionMonitor& gInteractionMonitor();
 interaction::JoystickInputStates& gJoystickInputStates();
 interaction::WebsocketInputStates& gWebsocketInputStates();
 interaction::KeybindingManager& gKeybindingManager();
@@ -120,6 +122,7 @@ static VersionChecker& versionChecker = detail::gVersionChecker();
 static VirtualPropertyManager& virtualPropertyManager = detail::gVirtualPropertyManager();
 static WindowDelegate& windowDelegate = detail::gWindowDelegate();
 static configuration::Configuration& configuration = detail::gConfiguration();
+static interaction::InteractionMonitor& interactionMonitor = detail::gInteractionMonitor();
 static interaction::JoystickInputStates& joystickInputStates =
     detail::gJoystickInputStates();
 static interaction::WebsocketInputStates& websocketInputStates =

include/openspace/engine/windowdelegate.h

@@ -107,7 +107,7 @@ struct WindowDelegate {
 
     bool (*isFisheyeRendering)() = []() { return false; };
 
-    void (*takeScreenshot)(bool applyWarping) = [](bool) { };
+    unsigned int(*takeScreenshot)(bool applyWarping) = [](bool) { return 0u; };
 
     void (*swapBuffer)() = []() {};
 

include/openspace/interaction/interactionmonitor.h

@@ -0,0 +1,70 @@
+/*****************************************************************************************
+ *                                                                                       *
+ * OpenSpace                                                                             *
+ *                                                                                       *
+ * Copyright (c) 2014-2019                                                               *
+ *                                                                                       *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
+ * software and associated documentation files (the "Software"), to deal in the Software *
+ * without restriction, including without limitation the rights to use, copy, modify,    *
+ * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
+ * permit persons to whom the Software is furnished to do so, subject to the following   *
+ * conditions:                                                                           *
+ *                                                                                       *
+ * The above copyright notice and this permission notice shall be included in all copies *
+ * or substantial portions of the Software.                                              *
+ *                                                                                       *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
+ * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
+ ****************************************************************************************/
+
+#ifndef __OPENSPACE_CORE___INTERACTIONMONITOR___H__
+#define __OPENSPACE_CORE___INTERACTIONMONITOR___H__
+
+#include <openspace/properties/propertyowner.h>
+
+#include <openspace/properties/scalar/boolproperty.h>
+#include <openspace/properties/scalar/floatproperty.h>
+
+namespace openspace::interaction {
+
+/**
+ * The class InteractionMonitor keeps track of user interactions during an OpenSpace
+ * session. It keeps track of when the latest interaction was made and of when the state
+ * changes to idle.
+ */
+class InteractionMonitor : public properties::PropertyOwner {
+public:
+    InteractionMonitor();
+
+    void setActivityState(bool isActive);
+    void setIdleTime(float time);
+
+    /*
+     * Called every frame from OpenSpaceEngine and calculates the activity state depending
+     * on the last registered interaction.
+     */
+    void updateActivityState();
+
+    /*
+     * Called from all places we want to mark activity from. Updates the last registered
+     * interaction time
+     */
+    void markInteraction();
+
+private:
+    double _lastInteractionTime = 0;
+    properties::BoolProperty _isInActiveState;
+    properties::FloatProperty _idleTime; // in seconds
+
+    // @TODO (lovisa) make a list of interactions to listen for
+    // and only allow registering updates from those interactions
+};
+
+} // namespace openspace::interaction
+
+#endif // __OPENSPACE_CORE___INTERACTIONMONITOR___H__

include/openspace/interaction/navigationhandler.h

@@ -136,6 +136,7 @@ public:
         WebsocketCameraStates::AxisNormalize shouldNormalize =
         WebsocketCameraStates::AxisNormalize::No);
     
+    NavigationState navigationState() const;
     NavigationState navigationState(const SceneGraphNode& referenceFrame) const;
 
     void saveNavigationState(const std::string& filepath,

include/openspace/rendering/renderengine.h

@@ -142,9 +142,14 @@ public:
     void setResolveData(ghoul::Dictionary resolveData);
 
     /**
-     * Mark that one screenshot should be taken
+     * Take a screenshot and store in the ${SCREENSHOTS} directory
      */
-    void takeScreenShot();
+    void takeScreenshot();
+
+    /**
+     * Get the filename of the latest screenshot
+     */
+    unsigned int latestScreenshotNumber() const;
 
     /**
      * Returns the Lua library that contains all Lua functions available to affect the
@@ -187,8 +192,6 @@ private:
     properties::BoolProperty _showVersionInfo;
     properties::BoolProperty _showCameraInfo;
 
-    properties::TriggerProperty _takeScreenshot;
-    bool _shouldTakeScreenshot = false;
     properties::BoolProperty _applyWarping;
     properties::BoolProperty _showFrameInformation;
 #ifdef OPENSPACE_WITH_INSTRUMENTATION
@@ -226,6 +229,7 @@ private:
     properties::Vec3Property _masterRotation;
     
     uint64_t _frameNumber = 0;
+    unsigned int _latestScreenshotNumber = 0;
 
     std::vector<ghoul::opengl::ProgramObject*> _programs;