Files
OpenSpace/include/openspace/interaction/keyframerecording.h
Joakim Kilby ed39d4fc68 Add possibility to capture, edit & replay camera-keyframes (#2785)
* Add possibility to capture, edit & replay camera-keyframes

* fix compilation on non-windows systems

* use cbegin/cend instead of std::views

* Coding style adaptions

* Member variable names

* add Keyframe struct, fix pr suggestions

* add function to remove keyframes

* add lua function to fetch keyframes

* Update lua documentation

* add constexpr keys for json entries

* Add log info messages, input checks and general pr suggestions

* update comments to doxygen style

* batch of pr suggestions

* add jump to keyframe function

* update docs

---------

Co-authored-by: Alexander Bock <mail@alexanderbock.eu>
Co-authored-by: Alexander Bock <alexander.bock@liu.se>
Co-authored-by: Andreas Engberg <adde.engberg@gmail.com>
2024-08-30 10:25:38 +02:00

85 lines
3.7 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2024 *
* *
* 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___KEYFRAMERECORDING___H__
#define __OPENSPACE_CORE___KEYFRAMERECORDING___H__
#include <openspace/navigation/keyframenavigator.h>
#include <openspace/properties/propertyowner.h>
#include <openspace/scripting/lualibrary.h>
#include <json/json.hpp>
#include <string>
#include <vector>
namespace openspace::interaction {
class KeyframeRecording : public properties::PropertyOwner {
public:
struct Keyframe {
struct TimeStamp {
double application;
double sequenceTime;
double simulation;
};
KeyframeNavigator::CameraPose camera;
TimeStamp timestamp;
};
KeyframeRecording();
void newSequence();
void addKeyframe(double sequenceTime);
void removeKeyframe(int index);
void updateKeyframe(int index);
void moveKeyframe(int index, double sequenceTime);
bool saveSequence(std::optional<std::string> filename);
void loadSequence(std::string filename);
void preSynchronization(double dt);
void play();
void pause();
void setSequenceTime(double sequenceTime);
void jumpToKeyframe(int index);
bool hasKeyframeRecording() const;
std::vector<ghoul::Dictionary> keyframes() const;
static openspace::scripting::LuaLibrary luaLibrary();
private:
void sortKeyframes();
Keyframe newKeyframe(double sequenceTime);
bool isInRange(int index) const;
std::vector<Keyframe> _keyframes;
std::string _filename;
bool _isPlaying = false;
bool _hasStateChanged = false;
double _sequenceTime = 0.0;
};
} // namespace openspace
#endif // __OPENSPACE_CORE___KEYFRAMERECORDING___H__