Added keyboard controls to vsg::Trackball, a vsg::Keyboard class for tracking keyboard state and FocusIn/Out events

include/vsg/all.h

@@ -163,6 +163,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/ui/CollectEvents.h>
 #include <vsg/ui/FrameStamp.h>
 #include <vsg/ui/KeyEvent.h>
+#include <vsg/ui/Keyboard.h>
 #include <vsg/ui/PlayEvents.h>
 #include <vsg/ui/PointerEvent.h>
 #include <vsg/ui/PrintEvents.h>

include/vsg/app/Trackball.h

@@ -15,8 +15,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/app/Camera.h>
 #include <vsg/app/EllipsoidModel.h>
 #include <vsg/maths/transform.h>
-#include <vsg/ui/ApplicationEvent.h>
-#include <vsg/ui/KeyEvent.h>
+#include <vsg/ui/Keyboard.h>
 #include <vsg/ui/PointerEvent.h>
 #include <vsg/ui/ScrollWheelEvent.h>
 #include <vsg/ui/TouchEvent.h>
@@ -37,6 +36,9 @@ namespace vsg
         dvec3 tbc(PointerEvent& event);
 
         void apply(KeyPressEvent& keyPress) override;
+        void apply(KeyReleaseEvent& keyRelease) override;
+        void apply(FocusInEvent& focusIn) override;
+        void apply(FocusOutEvent& focusOut) override;
         void apply(ButtonPressEvent& buttonPress) override;
         void apply(ButtonReleaseEvent& buttonRelease) override;
         void apply(MoveEvent& moveEvent) override;
@@ -81,6 +83,42 @@ namespace vsg
         /// container that maps key symbol bindings with the Viewpoint that should move the LookAt to when pressed.
         std::map<KeySymbol, Viewpoint> keyViewpointMap;
 
+        /// Key that turns the view left around the eye points
+        KeySymbol turnLeftKey = KEY_a;
+
+        /// Key that turns the view right around the eye points
+        KeySymbol turnRightKey = KEY_d;
+
+        /// Key that pitches up the view around the eye point
+        KeySymbol pitchUpKey = KEY_w;
+
+        /// Key that pitches down the view around the eye point
+        KeySymbol pitchDownKey = KEY_s;
+
+        /// Key that rools the view anti-clockwise/left
+        KeySymbol rollLeftKey = KEY_q;
+
+        /// Key that rolls the view clockwise/right
+        KeySymbol rollRightKey = KEY_e;
+
+        /// Key that moves the view forward
+        KeySymbol moveForwardKey = KEY_o;
+
+        /// Key that moves the view backwards
+        KeySymbol moveBackwardKey = KEY_i;
+
+        /// Key that moves the view left
+        KeySymbol moveLeftKey = KEY_Left;
+
+        /// Key that moves the view right
+        KeySymbol moveRightKey = KEY_Right;
+
+        /// Key that moves the view upward
+        KeySymbol moveUpKey = KEY_Up;
+
+        /// Key that moves the view downard
+        KeySymbol moveDownKey = KEY_Down;
+
         /// Button mask value used to enable panning of the view, defaults to left mouse button
         ButtonMask rotateButtonMask = BUTTON_MASK_1;
 
@@ -104,7 +142,8 @@ namespace vsg
         ref_ptr<LookAt> _lookAt;
         ref_ptr<EllipsoidModel> _ellipsoidModel;
 
-        bool _hasFocus = false;
+        bool _hasKeyboardFocus = false;
+        bool _hasPointerFocus = false;
         bool _lastPointerEventWithinRenderArea = false;
 
         enum UpdateMode
@@ -131,6 +170,8 @@ namespace vsg
         ref_ptr<LookAt> _endLookAt;
         std::map<uint32_t, ref_ptr<TouchEvent>> _previousTouches;
 
+        ref_ptr<Keyboard> _keyboard;
+
         double _animationDuration = 0.0;
     };
     VSG_type_name(vsg::Trackball);

include/vsg/app/WindowResizeHandler.h

@@ -26,7 +26,6 @@ namespace vsg
     class VSG_DECLSPEC UpdateGraphicsPipelines : public vsg::Inherit<vsg::Visitor, UpdateGraphicsPipelines>
     {
     public:
-
         UpdateGraphicsPipelines();
 
         vsg::ref_ptr<vsg::Context> context;

include/vsg/core/ConstVisitor.h

@@ -109,6 +109,8 @@ namespace vsg
     class ExposeWindowEvent;
     class ConfigureWindowEvent;
     class CloseWindowEvent;
+    class FocusInEvent;
+    class FocusOutEvent;
     class KeyEvent;
     class KeyPressEvent;
     class KeyReleaseEvent;
@@ -356,6 +358,8 @@ namespace vsg
         virtual void apply(const ExposeWindowEvent&);
         virtual void apply(const ConfigureWindowEvent&);
         virtual void apply(const CloseWindowEvent&);
+        virtual void apply(const FocusInEvent&);
+        virtual void apply(const FocusOutEvent&);
         virtual void apply(const KeyEvent&);
         virtual void apply(const KeyPressEvent&);
         virtual void apply(const KeyReleaseEvent&);

include/vsg/core/Visitor.h

@@ -109,6 +109,8 @@ namespace vsg
     class ExposeWindowEvent;
     class ConfigureWindowEvent;
     class CloseWindowEvent;
+    class FocusInEvent;
+    class FocusOutEvent;
     class KeyEvent;
     class KeyPressEvent;
     class KeyReleaseEvent;
@@ -356,6 +358,8 @@ namespace vsg
         virtual void apply(ExposeWindowEvent&);
         virtual void apply(ConfigureWindowEvent&);
         virtual void apply(CloseWindowEvent&);
+        virtual void apply(FocusInEvent&);
+        virtual void apply(FocusOutEvent&);
         virtual void apply(KeyEvent&);
         virtual void apply(KeyPressEvent&);
         virtual void apply(KeyReleaseEvent&);

include/vsg/maths/plane.h

@@ -102,6 +102,8 @@ namespace vsg
 
         bool valid() const { return n.x != 0.0 && n.y != 0.0 && n.z != 0.0; }
 
+        explicit operator bool() const noexcept { return valid(); }
+
         T* data() { return value; }
         const T* data() const { return value; }
     };

include/vsg/maths/quat.h

@@ -141,6 +141,8 @@ namespace vsg
             z = axis.z * sinhalfangle * inversenorm;
             w = coshalfangle;
         }
+
+        explicit operator bool() const noexcept { return value[0] != 0.0 || value[1] != 0.0 || value[2] != 0.0 || value[3] != 0.0; }
     };
 
     using quat = t_quat<float>;   /// float quaternion

include/vsg/maths/vec2.h

@@ -130,6 +130,8 @@ namespace vsg
             }
             return *this;
         }
+
+        explicit operator bool() const noexcept { return value[0] != 0.0 || value[1] != 0.0; }
     };
 
     using vec2 = t_vec2<float>;           // float 2D vector

include/vsg/maths/vec3.h

@@ -140,6 +140,8 @@ namespace vsg
             }
             return *this;
         }
+
+        explicit operator bool() const noexcept { return value[0] != 0.0 || value[1] != 0.0 || value[2] != 0.0; }
     };
 
     using vec3 = t_vec3<float>;           // float 3D vector

include/vsg/maths/vec4.h

@@ -154,6 +154,8 @@ namespace vsg
             }
             return *this;
         }
+
+        explicit operator bool() const noexcept { return value[0] != 0.0 || value[1] != 0.0 || value[2] != 0.0 || value[3] != 0.0; }
     };
 
     using vec4 = t_vec4<float>;           // float 4D vector

include/vsg/ui/Keyboard.h

@@ -0,0 +1,49 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2023 Robert Osfield
+
+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.
+
+</editor-fold> */
+
+#include <vsg/ui/ApplicationEvent.h>
+#include <vsg/ui/KeyEvent.h>
+
+namespace vsg
+{
+
+    /// Keyboard tracks keyboard events to maintain the key pressed state and how long the key has been hel for
+    class VSG_DECLSPEC Keyboard : public Inherit<Visitor, Keyboard>
+    {
+    public:
+        void apply(KeyPressEvent& keyPress) override;
+        void apply(KeyReleaseEvent& keyRelease) override;
+        void apply(FocusInEvent& focusIn) override;
+        void apply(FocusOutEvent& focusOut) override;
+
+        struct KeyHistory
+        {
+            vsg::time_point timeOfFirstKeyPress = {};
+            vsg::time_point timeOfLastKeyPress = {};
+            vsg::time_point timeOfKeyRelease = {};
+            bool handled = false;
+        };
+
+        std::map<KeySymbol, KeyHistory> keyState;
+
+        /// return true if key is currently pressed
+        bool pressed(KeySymbol key, bool ignore_handled_keys = true);
+
+        /// return a pair of times, the first is the time, in seconds, since the key was first pressed and the second is the time, in secnds, since it was released.
+        /// if the key hasn't been pressed then then first value will be < 0.0, if the key is still pressed then the second value will be 0.0.
+        std::pair<double, double> times(KeySymbol key, bool ignore_handled_keys = true);
+    };
+    VSG_type_name(vsg::Keyboard);
+
+} // namespace vsg

include/vsg/ui/WindowEvent.h

@@ -93,4 +93,26 @@ namespace vsg
     };
     VSG_type_name(vsg::CloseWindowEvent);
 
+    /// FocusInEvent represents a window aquiring focus event.
+    class FocusInEvent : public Inherit<WindowEvent, FocusInEvent>
+    {
+    public:
+        FocusInEvent() {}
+
+        FocusInEvent(Window* in_window, time_point in_time) :
+            Inherit(in_window, in_time) {}
+    };
+    VSG_type_name(vsg::FocusInEvent);
+
+    /// FocusOutEvent represents a window loosing focus event.
+    class FocusOutEvent : public Inherit<WindowEvent, FocusOutEvent>
+    {
+    public:
+        FocusOutEvent() {}
+
+        FocusOutEvent(Window* in_window, time_point in_time) :
+            Inherit(in_window, in_time) {}
+    };
+    VSG_type_name(vsg::FocusOutEvent);
+
 } // namespace vsg

src/vsg/CMakeLists.txt

@@ -192,6 +192,7 @@ set(SOURCES
     ui/ShiftEventTime.cpp
     ui/PlayEvents.cpp
     ui/PrintEvents.cpp
+    ui/Keyboard.cpp
 
     vk/CommandBuffer.cpp
     vk/CommandPool.cpp

src/vsg/app/CompileTraversal.cpp

@@ -310,7 +310,7 @@ void CompileTraversal::apply(View& view)
     {
         // if context is associated with a view make sure we only apply it if it matches with view, oherwsie we skip this context
         auto context_view = context->view.ref_ptr();
-        if (context_view && context_view.get()!=&view) continue;
+        if (context_view && context_view.get() != &view) continue;
 
         context->viewID = view.viewID;
         context->viewDependentState = view.viewDependentState.get();