Gui: Refactor navigation animations

- Animations are played through an Animator - Standard animations have a fixed duration and inherit from QVariantAnimation - The animation duration can be changed in the preferences - Fix animations when using the two arrows above the NaviCube - Start an animation or start and wait for an animation - Replaces standard camera animations (e.g. by selecting standard views or NaviCube) with FixedTimeAnimation - Replace View3DInventorViewer's CameraAnimation with FixedTimeAnimation - Replace OpenInventor navigation style infinite spin animation with SpinningAnimation - Stops an active animation when a new animation is started - Stops an active animation when the user starts dragging, panning or zooming - Refactor reorientCamera so it can be used in animations - Enable animations by default
2023-04-30 19:26:27 +02:00
parent 4d17f4831a
commit 37e600e766
15 changed files with 685 additions and 352 deletions
--- a/src/Gui/NavigationAnimation.cpp
+++ b/src/Gui/NavigationAnimation.cpp
@@ -0,0 +1,155 @@
+// SPDX-License-Identifier: LGPL-2.1-or-later
+/****************************************************************************
+ *                                                                          *
+ *   Copyright (c) 2023 Bas Ruigrok (Rexbas) <Rexbas@proton.me>             *
+ *                                                                          *
+ *   This file is part of FreeCAD.                                          *
+ *                                                                          *
+ *   FreeCAD is free software: you can redistribute it and/or modify it     *
+ *   under the terms of the GNU Lesser General Public License as            *
+ *   published by the Free Software Foundation, either version 2.1 of the   *
+ *   License, or (at your option) any later version.                        *
+ *                                                                          *
+ *   FreeCAD is distributed in the hope that it will be useful, but         *
+ *   WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU       *
+ *   Lesser General Public License for more details.                        *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with FreeCAD. If not, see                                *
+ *   <https://www.gnu.org/licenses/>.                                       *
+ *                                                                          *
+ ***************************************************************************/
+
+#include "PreCompiled.h"
+#include "NavigationAnimation.h"
+#include <Inventor/nodes/SoCamera.h>
+
+using namespace Gui;
+
+NavigationAnimation::NavigationAnimation(NavigationStyle* navigation)
+    : navigation(navigation), started(false)
+{}
+
+void NavigationAnimation::startAnimation(QAbstractAnimation::DeletionPolicy policy)
+{
+    started = true;
+    QAbstractAnimation::start(policy);
+}
+
+void NavigationAnimation::updateCurrentValue(const QVariant& value)
+{
+    if (!started) {
+        return;
+    }
+    update(value);
+}
+
+void NavigationAnimation::stopAnimation()
+{
+    QAbstractAnimation::stop();
+}
+
+FixedTimeAnimation::FixedTimeAnimation(NavigationStyle* navigation, const SbRotation& orientation,
+                                       const SbVec3f& rotationCenter, const SbVec3f& translation,
+                                       int duration)
+    : NavigationAnimation(navigation)
+    , targetOrientation(orientation)
+    , targetTranslation(translation)
+    , rotationCenter(rotationCenter)
+{
+    setDuration(duration);
+    setStartValue(0.0);
+    setEndValue(duration * 1.0);
+}
+
+void FixedTimeAnimation::initialize()
+{
+    prevAngle = 0;
+    prevTranslation = SbVec3f(0, 0, 0);
+
+    // Find an axis and angle to rotate from the camera orientation to the target orientation using post-multiplication
+    SbVec3f rotationAxisPost;
+    float angle;
+    SbRotation(navigation->getCamera()->orientation.getValue().inverse() * targetOrientation).getValue(rotationAxisPost, angle);
+    if (angle > M_PI) {
+        angle -= 2 * M_PI;
+    }
+
+    // Convert post-multiplication axis to a pre-multiplication axis
+    navigation->getCamera()->orientation.getValue().inverse().multVec(rotationAxisPost, rotationAxis);
+
+    angularVelocity = angle / duration();
+    linearVelocity = targetTranslation / duration();
+}
+
+/**
+ * @param value The elapsed time
+ */
+void FixedTimeAnimation::update(const QVariant& value)
+{
+    SoCamera* camera = navigation->getCamera();
+    if (!camera) {
+        return;
+    }
+
+    float angle = value.toFloat() * angularVelocity;
+    SbVec3f translation = value.toFloat() * linearVelocity;
+
+    SbRotation rotation(rotationAxis, angle - prevAngle);
+
+    navigation->reorientCamera(camera, rotation, rotationCenter);
+    camera->position = camera->position.getValue() + translation - prevTranslation;
+
+    prevAngle = angle;
+    prevTranslation = translation;
+}
+
+/**
+ * @param navigation The navigation style
+ * @param axis The rotation axis in screen coordinates
+ * @param velocity The angular velocity in radians per second
+ */
+SpinningAnimation::SpinningAnimation(NavigationStyle* navigation, const SbVec3f& axis,
+                                     float velocity)
+    : NavigationAnimation(navigation)
+    , rotationAxis(axis)
+{
+    setDuration((2 * M_PI / velocity) * 1000.0);
+    setStartValue(0.0);
+    setEndValue(2 * M_PI);
+    setLoopCount(-1);
+}
+
+void SpinningAnimation::initialize()
+{
+    prevAngle = 0;
+
+    navigation->setViewing(true);
+    navigation->setViewingMode(NavigationStyle::SPINNING);
+}
+
+/**
+ * @param value The angle in radians
+ */
+void SpinningAnimation::update(const QVariant& value)
+{
+    SoCamera* camera = navigation->getCamera();
+    if (!camera) {
+        return;
+    }
+
+    SbRotation deltaRotation = SbRotation(rotationAxis, value.toFloat() - prevAngle);
+    navigation->reorientCamera(camera, deltaRotation);
+
+    prevAngle = value.toFloat();
+}
+
+void SpinningAnimation::stopAnimation()
+{
+    NavigationAnimation::stopAnimation();
+    if (navigation->getViewingMode() != NavigationStyle::SPINNING) {
+        return;
+    }
+    navigation->setViewingMode(navigation->isViewing() ? NavigationStyle::IDLE : NavigationStyle::INTERACT);
+}