Adds Field of View option

Author: Jerboa-app

DOCUMENTATION.md

@@ -127,6 +127,8 @@ It is possible to write Lua scripts to manipulate visualisation in SFOAV. By sup
 | rotateCamera | dphi, the azimuthal increment | Rotate the camera |
 | zoomCamera | dr, move the camera to or from the focus | Zoom the camera |
 | inclineCamera | dtheta, the inclination increment | Incline the camera |
+| setCameraFieldOfView | fov, degrees | Set the field of view |
+| getCameraFieldOfView | | Get the field of view in degrees |
 | exit | | Exit sfoav |
 
 E.g. the following script will set Atom 0 to a random colour every frame.

README.md

@@ -123,6 +123,8 @@ It is possible to write Lua scripts to manipulate visualisation in SFOAV. By sup
 | rotateCamera | dphi, the azimuthal increment | Rotate the camera |
 | zoomCamera | dr, move the camera to or from the focus | Zoom the camera |
 | inclineCamera | dtheta, the inclination increment | Incline the camera |
+| setCameraFieldOfView | fov, degrees | Set the field of view |
+| getCameraFieldOfView | | Get the field of view in degrees |
 | exit | | Exit sfoav |
 
 ```lua

include/axes.h

@@ -15,7 +15,7 @@ class Axes
 public:
 
     Axes(const Camera & camera)
-    : camera({3.5, M_PI*0.5f, M_PI}, camera.getResX(), camera.getResY()),
+    : camera({3.5, M_PI*0.5f, M_PI}, camera.getResX(), camera.getResY(), camera.getFieldOfView()),
       renderer(axes, axesPoints, axes.size())
     {
         renderer.setBondScale(0.33f);

include/camera.h

@@ -37,8 +37,8 @@ class Camera
      * @param resX the screen resolution width.
      * @param resY the screen resolution in height.
      */
-    Camera(const std::vector<Atom> & atoms, uint16_t resX, uint16_t resY)
-    : resX(resX), resY(resY)
+    Camera(const std::vector<Atom> & atoms, uint16_t resX, uint16_t resY, float fieldOfView)
+    : resX(resX), resY(resY), fieldOfView(fieldOfView)
     {
         reset(atoms);
     }
@@ -50,8 +50,8 @@ class Camera
      * @param resX the screen resolution width.
      * @param resY the screen resolution in height.
      */
-    Camera(glm::vec3 positionSpherical, uint16_t resX, uint16_t resY)
-    : resX(resX), resY(resY), positionSpherical(positionSpherical)
+    Camera(glm::vec3 positionSpherical, uint16_t resX, uint16_t resY, float fieldOfView)
+    : resX(resX), resY(resY), fieldOfView(fieldOfView), positionSpherical(positionSpherical)
     {
         reset();
     }
@@ -66,7 +66,7 @@ class Camera
 
         projection = glm::perspective
         (
-            glm::radians(45.0f), float(resX)/float(resY),
+            glm::radians(fieldOfView), float(resX)/float(resY),
             0.1f,
             1000.0f
         );
@@ -180,6 +180,25 @@ class Camera
      */
     float getUp() const { return up; }
 
+    /**
+     * @brief Set the Field Of View
+     *
+     * @param degrees the field of view in degrees.
+     * @remark clipped to [30, 90].
+     */
+    void setFieldOfView(float degrees)
+    {
+        fieldOfView = std::min(std::max(30.0f, degrees), 90.0f);
+        reset();
+    }
+
+    /**
+     * @brief Get the Field Of View
+     *
+     * @return float the field of view in degrees.
+     */
+    float getFieldOfView() const { return fieldOfView; }
+
     /**
      * @brief Get the Projection matrix.
      *
@@ -278,10 +297,31 @@ class Camera
      */
     inline int lua_inclineCamera(lua_State * lua);
 
+    /**
+     * @brief Set the field of view.
+     *
+     * @remark Lua arguments are:
+     * 1. Field of view in degrees.
+     * @param lua the Lua context.
+     * @return int the return code.
+     */
+    inline int lua_setCameraFieldOfView(lua_State * lua);
+
+    /**
+     * @brief Set the field of view.
+     *
+     * @remark Lua arguments are:
+     * 1. Field of view in degrees.
+     * @param lua the Lua context.
+     * @return int the return code.
+     */
+    inline int lua_getCameraFieldOfView(lua_State * lua);
+
 private:
 
     uint16_t resX;
     uint16_t resY;
+    float fieldOfView;
 
     glm::vec3 positionSpherical;
     glm::vec3 focus;

include/commandLine.h

@@ -305,6 +305,7 @@ struct CommandLine
         extractArgument(deemphasisAlpha, arguments);
         extractArgument(atomClipCorrection, arguments);
         extractArgument(bondClipCorrection, arguments);
+        extractArgument(fieldOfView, arguments);
         extractArgument(colourmap, arguments);
         extractArgument(atomColours, arguments);
         extractArgument(atomSize, arguments);
@@ -344,6 +345,7 @@ struct CommandLine
     Argument<float> deemphasisAlpha = {"deemphasisAlpha", "Alpha colour for deemphasised atoms.", "", 0.25f};
     Argument<float> atomClipCorrection = {"atomClipCorrection", "Correction for atom impostors.", "Increase if atoms clipped.", 1.5f};
     Argument<float> bondClipCorrection = {"bondClipCorrection", "Correction for bond impostors.", "Increase if atoms clipped.", 5.0f};
+    Argument<float> fieldOfView = {"fieldOfView", "Field of view in degrees.", "", 60.0f};
     Argument<std::filesystem::path> colourmap = {"colourmap", "The colourmap path.", "", {}};
     Argument<std::filesystem::path> atomColours = {"atomColours", "Path for per-atom colour overrides.", "", {}};
     Argument<std::string> videoName = {"videoName", "Name of saved video.", "", ""};
@@ -464,10 +466,8 @@ struct CommandLine
         std::string * sval = stringFromName(s.characters);
         if (sval != nullptr)
         {
-            std::cout << "yes\n";
             if (lua_isstring(lua, 2))
             {
-                std::cout << "yes2\n";
                 LuaString v; v.read(lua, 2);
                 *sval = v.characters;
                 return 0;
@@ -623,7 +623,7 @@ struct CommandLine
           << "\n"
           << sidebyside(argumentHelp(levelOfDetail), argumentHelp(hideInfoText), 42)
           << "\n"
-          << argumentHelp(videoName)
+          << sidebyside(argumentHelp(videoName), argumentHelp(fieldOfView), 42)
           << "\n"
           #ifdef WITH_FFMPEG
           << "\n FFMPEG recording options:\n\n"
@@ -949,7 +949,7 @@ END OF TERMS AND CONDITIONS)";
             {globalBondAlpha.name, globalBondAlpha},
             {deemphasisAlpha.name, deemphasisAlpha},
             {atomClipCorrection.name, atomClipCorrection},
-            {bondClipCorrection.name, bondClipCorrection},
+            {bondClipCorrection.name, bondClipCorrection}
         };
 
         if (values.find(name) != values.cend())

include/console.h

@@ -341,7 +341,7 @@ class Console
 
     static int load_sfoavLib(lua_State * lua)
     {
-        luaL_Reg sfoavLib[23] =
+        luaL_Reg sfoavLib[25] =
         {
             {"setAtomColour", &dispatchVisualisationState<&VisualisationState::lua_setAtomColour>},
             {"getAtomColour", &dispatchVisualisationState<&VisualisationState::lua_getAtomColour>},
@@ -362,6 +362,8 @@ class Console
             {"rotateCamera", &dispatchCamera<&Camera::lua_rotateCamera>},
             {"zoomCamera", &dispatchCamera<&Camera::lua_zoomCamera>},
             {"inclineCamera", &dispatchCamera<&Camera::lua_inclineCamera>},
+            {"setCameraFieldOfView", &dispatchCamera<&Camera::lua_setCameraFieldOfView>},
+            {"getCameraFieldOfView", &dispatchCamera<&Camera::lua_getCameraFieldOfView>},
             {"exit", &lua_exit},
             {"getOption", &dispatchCommandLine<&CommandLine::lua_getOption>},
             {"setOption", &dispatchCommandLine<&CommandLine::lua_setOption>},

include/luaBindings/camera.h

@@ -133,4 +133,43 @@ inline int Camera::lua_inclineCamera(lua_State * lua)
     return 0;
 }
 
+/**
+ * @brief Set the field of view.
+ *
+ * @remark Lua arguments are:
+ * 1. Field of view in degrees.
+ * @param lua the Lua context.
+ * @return int the return code.
+ */
+inline int Camera::lua_setCameraFieldOfView(lua_State * lua)
+{
+    int args = lua_gettop(lua);
+    if (args != 1)
+    {
+        const std::string msg = "setCameraFieldOfView expects a number as argument.\n";
+        lua_pushlstring(lua, msg.c_str(), msg.length());
+        return lua_error(lua);
+    }
+
+    LuaNumber fov;
+    fov.read(lua, 1);
+    fieldOfView = fov.n;
+    reset();
+
+    return 0;
+}
+
+/**
+ * @brief Set the field of view.
+ *
+ * @remark Lua arguments are:
+ * @param lua the Lua context.
+ * @return int the return code.
+ */
+inline int Camera::lua_getCameraFieldOfView(lua_State * lua)
+{
+    lua_pushnumber(lua, fieldOfView);
+    return 1;
+}
+
 #endif /* LUA_CAMERA_H */

src/main.cpp

@@ -78,7 +78,7 @@ int main(int argv, char ** argc)
 
     structure->readFrame(0);
 
-    Camera loadingCamera {sfoavAtoms, resX, resY};
+    Camera loadingCamera {sfoavAtoms, resX, resY, options.fieldOfView.value};
     loadingCamera.rotate(-M_PI/2.0);
 
     AtomRenderer loadingAtoms
@@ -119,7 +119,7 @@ int main(int argv, char ** argc)
     if (options.focus.value < structure->atoms.size()) { centerOn(structure->atoms, options.focus.value); }
     com = getCenter(structure->atoms);
 
-    Camera camera {structure->atoms, resX, resY};
+    Camera camera {structure->atoms, resX, resY, options.fieldOfView.value};
 
     jLog::Log log;
     Console console(log, &visualisationState, &options, &camera);

tests/generate_lua_options_interop_tests.py

@@ -16,6 +16,24 @@
         }
 """
 
+generate_string_test = """        WHEN("The script \\"v = sfoav.getOption(\\"meshes\\");\\"")
+        {
+            console.runString("v = sfoav.getOption(\\"meshes\\");");
+            THEN("v is DEFAULT_INTERPOLATED")
+            {
+                REQUIRE(console.getGlobal<TYPE>("v").MEMBER == DEFAULT);
+            }
+            WHEN("The script \\"sfoav.setOption(\\"meshes\\", SET); v = sfoav.getOption(\\"meshes\\");\\"")
+            {
+                console.runString("sfoav.setOption(\\"meshes\\", SET); v = sfoav.getOption(\\"meshes\\");");
+                THEN("v is SET")
+                {
+                    CONDITION
+                }
+            }
+        }
+"""
+
 tests = """/*
     Tests are generated by tests/generate_lua_options_interop_tests.py
 */
@@ -53,19 +71,21 @@
     tests += test+"\n"
 
 for (option, default) in [("videoName", "\"\"")]:
-    test = generate_test
-    for (k, v) in [("meshes", option), ("DEFAULT", str(default)),
+    test = generate_string_test
+    for (k, v) in [("meshes", option), ("DEFAULT_INTERPOLATED", default.replace("\"","")),
+                   ("DEFAULT", str(default)),
                    ("SET", "\\\"TEST\\\""), ("TYPE", "LuaString"),
                    ("MEMBER", "characters"),
                    ("CONDITION", "REQUIRE(\"TEST\" == console.getGlobal<LuaString>(\"v\").characters);")]:
         test = test.replace(k, v)
     tests += test+"\n"
 
 tests += "        #ifdef WITH_FFMPEG\n"
-for (option, default) in [("preset", "slow"), ("codec", "libx264"),
-                          ("profile", "main")]:
-    test = generate_test
-    for (k, v) in [("meshes", option), ("DEFAULT", str(default)),
+for (option, default) in [("preset", "\"slow\""), ("codec", "\"libx264\""),
+                          ("profile", "\"main\"")]:
+    test = generate_string_test
+    for (k, v) in [("meshes", option), ("DEFAULT_INTERPOLATED", default.replace("\"","")),
+                   ("DEFAULT", default),
                    ("SET", "\\\"TEST\\\""), ("TYPE", "LuaString"),
                    ("MEMBER", "characters"),
                    ("CONDITION", "REQUIRE(\"TEST\" == console.getGlobal<LuaString>(\"v\").characters);")]:

tests/test_console/test_console.cpp

@@ -19,7 +19,7 @@ VisualisationState vs
 );
 
 CommandLine options;
-Camera camera(testAtoms, 64, 64);
+Camera camera(testAtoms, 64, 64, 60.0);
 
 SCENARIO("Lua atom interop")
 {
@@ -354,7 +354,7 @@ SCENARIO("Lua bond interop")
 SCENARIO("Lua camera interop")
 {
     jLog::Log l;
-    GIVEN("A Lua console and a camera at spherical coordinates (1,3.14,1.57)")
+    GIVEN("A Lua console and a camera at spherical coordinates (1,3.14,1.57) and 60 fov.")
     {
         Console console(l, &vs, &options, &camera);
         camera.setPosition({1,3.14,1.57});
@@ -423,6 +423,24 @@ SCENARIO("Lua camera interop")
                 REQUIRE_THAT(z.n, WithinAbs(1.57, 0.01));
             }
         }
+        WHEN("The script \"fov = sfoav.getCameraFieldOfView()\" is run")
+        {
+            console.runString("fov = sfoav.getCameraFieldOfView()");
+            THEN("fov is 60.0")
+            {
+                auto fov = console.getGlobal<LuaNumber>("fov");
+                REQUIRE_THAT(fov.n, WithinAbs(60.0, tol));
+            }
+        }
+        WHEN("The script \"sfoav.setCameraFieldOfView(35.0); fov = sfoav.getCameraFieldOfView()\" is run")
+        {
+            console.runString("sfoav.setCameraFieldOfView(35.0); fov = sfoav.getCameraFieldOfView()");
+            THEN("fov is 35.0")
+            {
+                auto fov = console.getGlobal<LuaNumber>("fov");
+                REQUIRE_THAT(fov.n, WithinAbs(35.0, tol));
+            }
+        }
     }
 }
 
@@ -762,7 +780,7 @@ SCENARIO("Lua options interop")
         WHEN("The script \"v = sfoav.getOption(\"videoName\");\"")
         {
             console.runString("v = sfoav.getOption(\"videoName\");");
-            THEN("v is """)
+            THEN("v is ")
             {
                 REQUIRE(console.getGlobal<LuaString>("v").characters == "");
             }
@@ -782,7 +800,7 @@ SCENARIO("Lua options interop")
             console.runString("v = sfoav.getOption(\"preset\");");
             THEN("v is slow")
             {
-                REQUIRE(console.getGlobal<LuaString>("v").characters == slow);
+                REQUIRE(console.getGlobal<LuaString>("v").characters == "slow");
             }
             WHEN("The script \"sfoav.setOption(\"preset\", \"TEST\"); v = sfoav.getOption(\"preset\");\"")
             {
@@ -798,7 +816,7 @@ SCENARIO("Lua options interop")
             console.runString("v = sfoav.getOption(\"codec\");");
             THEN("v is libx264")
             {
-                REQUIRE(console.getGlobal<LuaString>("v").characters == libx264);
+                REQUIRE(console.getGlobal<LuaString>("v").characters == "libx264");
             }
             WHEN("The script \"sfoav.setOption(\"codec\", \"TEST\"); v = sfoav.getOption(\"codec\");\"")
             {
@@ -814,7 +832,7 @@ SCENARIO("Lua options interop")
             console.runString("v = sfoav.getOption(\"profile\");");
             THEN("v is main")
             {
-                REQUIRE(console.getGlobal<LuaString>("v").characters == main);
+                REQUIRE(console.getGlobal<LuaString>("v").characters == "main");
             }
             WHEN("The script \"sfoav.setOption(\"profile\", \"TEST\"); v = sfoav.getOption(\"profile\");\"")
             {