mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-06 03:29:44 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen style overhaul (#2954)

Browse Source 
Reformatting the existing Doxygen comments to be unified
This commit is contained in:
Alexander Bock
2023-11-20 23:39:17 +01:00
committed by GitHub
parent 4ee078502b
commit 7db7c40841
163 changed files with 2266 additions and 2035 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
include/openspace/scripting/scriptscheduler.h
View File

@@ -45,8 +45,8 @@ namespace openspace::scripting {
struct LuaLibrary;
/**
* Maintains an ordered list of `ScheduledScript`s and provides a simple
* interface for retrieveing scheduled scripts
* Maintains an ordered list of `ScheduledScript`s and provides a simple interface for
* retrieveing scheduled scripts.
*/
class ScriptScheduler : public properties::PropertyOwner {
public:
@@ -69,8 +69,9 @@ public:
* ScheduledScript%s to the list of stored scripts.
*
* \param scheduledScripts The scripts that should be loaded
*
* \throw SpecificationError If the dictionary does not adhere to the Documentation as
* specified in the openspace::Documentation function
* specified in the openspace::Documentation function
*/
void loadScripts(std::vector<ScheduledScript> scheduledScripts);
@@ -84,51 +85,48 @@ public:
* Removes all scripts for the schedule.
*
* \param group An int that specifies which group to clear. If none given then all
* scripts
* is cleared from the schedule.
* scripts are cleared from the schedule
*/
void clearSchedule(std::optional<int> group = std::nullopt);
/**
* Progresses the script schedulers time and returns all scripts that has been
* scheduled to run between \p newTime and the time provided in the last invocation
* of this method.
*
* \param newTime A j2000 time value specifying the new time stamp that
* the script scheduler should progress to.
*
* \returns vector with the scheduled scripts that should be run from begining to end.
*/
* Progresses the script schedulers time and returns all scripts that has been
* scheduled to run between \p newTime and the time provided in the last invocation
* of this method.
*
* \param newTime A j2000 time value specifying the new time stamp that the script
* scheduler should progress to.
* \return vector with the scheduled scripts that should be run from begining to end
*/
std::vector<std::string> progressTo(double newTime);
/**
* Returns the the j2000 time value that the script scheduler is currently at
* Returns the the j2000 time value that the script scheduler is currently at.
*/
double currentTime() const;
/**
* Updates the current time to the given j2000 time value
* Updates the current time to the given J2000 time value.
*/
void setCurrentTime(double time);
/**
* Function that returns all scripts currently loaded in the script scheduler
*
* \param group An int specifying which group to return, if empty all scripts
* will be returned
*
* \returns a vector of all scripts that has been loaded
*/
* Function that returns all scripts currently loaded in the script scheduler.
*
* \param group An int specifying which group to return, if empty all scripts
* will be returned
* \return a vector of all scripts that has been loaded
*/
std::vector<ScheduledScript> allScripts(
std::optional<int> group = std::nullopt) const;
/**
* Sets the mode for how each scheduled script's timestamp will be interpreted.
* \param refType reference mode (for exact syntax, see definition of
* openspace::interaction::KeyframeTimeRef) which is either relative to the
* application start time, relative to the recorded session playback start time,
* or according to the absolute simulation time in seconds from J2000 epoch.
*/
* Sets the mode for how each scheduled script's timestamp will be interpreted.
* \param refType reference mode (for exact syntax, see definition of
* interaction::KeyframeTimeRef) which is either relative to the application start
* time, relative to the recorded session playback start time, or according to the
* absolute simulation time in seconds from J2000 epoch.
*/
void setTimeReferenceMode(openspace::interaction::KeyframeTimeRef refType);
static LuaLibrary luaLibrary();