mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-05 19:19:39 -06:00
58 lines
3.2 KiB
C++
58 lines
3.2 KiB
C++
/*****************************************************************************************
|
|
* *
|
|
* OpenSpace *
|
|
* *
|
|
* Copyright (c) 2014-2023 *
|
|
* *
|
|
* 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___MESSAGESTRUCTURESHELPER___H__
|
|
#define __OPENSPACE_CORE___MESSAGESTRUCTURESHELPER___H__
|
|
|
|
#include <openspace/network/messagestructures.h>
|
|
|
|
namespace openspace::datamessagestructures {
|
|
|
|
/**
|
|
* Method that creates a CameraKeyframe object and populates
|
|
* it with the current properties of the camera from the navigation handler.
|
|
* \returns CameraKeyframe with current state from NavigationHandler
|
|
*/
|
|
CameraKeyframe generateCameraKeyframe();
|
|
|
|
/**
|
|
* Method that creates a TimeKeyframe object and populates
|
|
* it with the current time values from the application time manager.
|
|
* \returns TimeKeyframe The time keyframe
|
|
*/
|
|
TimeKeyframe generateTimeKeyframe();
|
|
|
|
/**
|
|
* Method that creates a ScriptMessage object from a given script
|
|
* string, and populates the ScriptMessage with the script and timestamp
|
|
* of the current application time.
|
|
* \param script The script to execute in std::string form
|
|
* \returns ScriptMessage The ScriptMessage data structure with script
|
|
*/
|
|
ScriptMessage generateScriptMessage(std::string script);
|
|
|
|
} // namespace openspace::datamessagestructures
|
|
|
|
#endif // __OPENSPACE_CORE___MESSAGESTRUCTURESHELPER___H__
|