Files
OpenSpace/include/openspace/interaction/sessionrecording.h

87 lines
3.8 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2025 *
* *
* 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___SESSIONRECORDING___H__
#define __OPENSPACE_CORE___SESSIONRECORDING___H__
#include <openspace/navigation/keyframenavigator.h>
#include <ghoul/misc/dictionary.h>
#include <filesystem>
#include <functional>
#include <string>
#include <variant>
#include <vector>
namespace openspace::interaction {
enum class DataMode {
Ascii = 0,
Binary
};
struct SessionRecording {
struct Entry {
using Camera = KeyframeNavigator::CameraPose;
using Script = std::string;
bool operator==(const Entry&) const noexcept = default;
double timestamp = 0.0;
double simulationTime = 0.0;
std::variant<Camera, Script> value;
};
bool operator==(const SessionRecording&) const noexcept = default;
std::vector<Entry> entries;
bool hasCameraFrame() const noexcept;
// Call the provided \p function for all entries of the specified type \tparam T. The
// function calls will be ordered by the entries timestamps. If the callback function
// returns `true`, the loop is aborted
template <typename T>
void forAll(std::function<bool (const T&)> function) {
for (const Entry& e : entries) {
if (std::holds_alternative<T>(e.value)) {
bool cont = function(std::get<T>(e.value));
if (cont) {
break;
}
}
}
}
};
SessionRecording loadSessionRecording(const std::filesystem::path& filename);
void saveSessionRecording(const std::filesystem::path& filename,
const SessionRecording& sessionRecording, DataMode dataMode);
std::vector<ghoul::Dictionary> sessionRecordingToDictionary(
const SessionRecording& recording);
} // namespace openspace::interaction
#endif // __OPENSPACE_CORE___SESSIONRECORDING___H__