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

Doxygen fixes

Browse Source
This commit is contained in:
Alexander Bock
2023-12-09 00:16:25 +01:00
parent 19f8e70822
commit 0cf0fe492b
26 changed files with 291 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/OpenSpace/ext/launcher/include/filesystemaccess.h
+9 -10
View File
@@ -30,22 +30,21 @@
class FileSystemAccess {
public:
/**
* Constructor for filesystemAccess class
* Constructor for filesystemAccess class.
*
* \param fileExtension string that defines the filter used to find files. Only
* files with this extension will be recognized (e.g. '.xml')
* \param hideFileExtensions if true then file extensions will be removed from the
* listed files in the output
* \param useCheckboxes if true then the text output format will contain a '0' as
* the first character in the line (this first character is
* used to represent checked ('1'), uncheck ('0') or doesn't
* exist in filesystem ('x') states.
* \param fileExtension The file extensiopn filter used to find files. Only files with
* this extension will be recognized (e.g. '.xml')
* \param hideFileExtensions If `true` then file extensions will be removed from the
* listed files in the output
* \param useCheckboxes If `true` then the text output format will contain a '0' as
* the first character in the line (this first character is used to represent
* checked ('1'), uncheck ('0') or doesn't exist in filesystem ('x') states
*/
FileSystemAccess(std::string fileExtension, bool hideFileExtensions,
bool useCheckboxes);
/**
* Function that uses the #QtFileSystemModel class to search the given directory
* Function that uses the #QtFileSystemModel class to search the given directory.
*
* \param dir The directory from which to start the search from
*/
apps/OpenSpace/ext/launcher/include/launcherwindow.h
+17 -19
View File
@@ -43,49 +43,47 @@ class LauncherWindow final : public QMainWindow {
Q_OBJECT
public:
/**
* Constructor for LauncherWindow class
* Constructor for LauncherWindow class.
*
* \param profileEnabled true if profile selection combo box will be enabled
* \param globalConfig reference to global configuration for OpenSpace settings
* \param sgctConfigEnabled true if window selection combo box will be enabled
* \param sgctConfigName the name of the sgct configuration function used to
* generate window config (blank if file is used)
* \param profileEnabled `true` if profile selection combo box will be enabled
* \param globalConfig Reference to global configuration for OpenSpace settings
* \param sgctConfigEnabled `true` if window selection combo box will be enabled
* \param sgctConfigName The name of the sgct configuration function used to generate
* window config (blank if file is used)
* \param parentItem The parent that contains this (and possibly other) children
* in the tree structure.
*/
LauncherWindow(bool profileEnabled,
const openspace::Configuration& globalConfig, bool sgctConfigEnabled,
std::string sgctConfigName, QWidget* parent);
LauncherWindow(bool profileEnabled, const openspace::Configuration& globalConfig,
bool sgctConfigEnabled, std::string sgctConfigName, QWidget* parent);
/**
* Returns bool for whether "start OpenSpace" was chosen when this window closed.
* OpenSpace will not start if false
* Returns whether "Start OpenSpace" was chosen when this window closed.
*
* \return true if the "start OpenSpace" button was clicked
* \return `true` if the "Start OpenSpace" button was clicked
*/
bool wasLaunchSelected() const;
/**
* Returns the selected profile name when launcher window closed
* Returns the selected profile name when launcher window closed.
*
* \return name of selected profile (this is only the name without file extension
* \return The name of selected profile (this is only the name without file extension
* and without path)
*/
std::string selectedProfile() const;
/**
* Returns the selected sgct window configuration when launcher window closed
* Returns the selected sgct window configuration when launcher window closed.
*
* \return name of selected profile (this is only the name without file extension
* \return The name of selected profile (this is only the name without file extension
* and without path)
*/
std::string selectedWindowConfig() const;
/**
* Returns true if the window configuration filename selected in the combo box
* is a file in the user configurations section
* Returns `true` if the window configuration filename selected in the combo box
* is a file in the user configurations section.
*
* \return true if window configuration is a user configuration file
* \return `true` if window configuration is a user configuration file
*/
bool isUserConfigSelected() const;
apps/OpenSpace/ext/launcher/include/profile/additionalscriptsdialog.h
+5 -5
View File
@@ -33,11 +33,11 @@ class AdditionalScriptsDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for addedScripts class
* Constructor for addedScripts class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param scripts The list of scripts containing all data of the new or imported
* profile
*/
AdditionalScriptsDialog(QWidget* parent, std::vector<std::string>* scripts);
@@ -48,9 +48,9 @@ private:
void chooseScripts();
/**
* Adds scripts to the _scriptEdit from outside dialogs
* Adds scripts to the _scriptEdit from outside dialogs.
*
* \param scripts #std::string scripts to be appended
* \param scripts The scripts to be appended
*/
void appendScriptsToTextfield(std::vector<std::string> scripts);
apps/OpenSpace/ext/launcher/include/profile/assetsdialog.h
+12 -9
View File
@@ -37,17 +37,17 @@ class SearchProxyModel : public QSortFilterProxyModel {
Q_OBJECT
public:
/**
* Constructor for SearchProxyModel class
* Constructor for SearchProxyModel class.
*
* \param parent The QObject* object that is the Qt parent of this object
* \param parent The parent object of this object
*/
SearchProxyModel(QObject* parent = nullptr);
public slots:
/**
* Sets the regular expression pattern to apply to the filter
* Sets the regular expression pattern to apply to the filter.
*
* \param pattern The QString reference containing the regex pattern
* \param pattern The regex pattern used for filtering
*/
void setFilterRegularExpression(const QString& pattern);
@@ -64,14 +64,14 @@ class AssetsDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for assets class
* Constructor for assets class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param profile The #openspace::Profile object containing all data of the new or
* imported profile
* \param assetBasePath The path to the folder in which all of the assets are living
* \param userAssetBasePath The path to the folder in which the users' assets are
* living
* \param parent Pointer to parent Qt widget
*/
AssetsDialog(QWidget* parent, openspace::Profile* profile,
const std::string& assetBasePath, const std::string& userAssetBasePath);
@@ -84,7 +84,10 @@ private:
void setViewToBaseModel();
void parseSelections();
void selected(const QModelIndex&);
/// Creates a text summary of all assets and their paths
/**
* Creates a text summary of all assets and their paths.
*/
QString createTextSummary();
void openAssetEditor();
apps/OpenSpace/ext/launcher/include/profile/assettreeitem.h
+25 -25
View File
@@ -36,8 +36,8 @@ public:
* Constructor for assetTreeItem class.
*
* \param data QVector containing the data contained in this tree view item
* \param parentItem The parent that contains this (and possibly other) children
* in the tree structure (optional).
* \param parentItem The parent that contains this (and possibly other) children in
* the tree structure (optional)
*/
AssetTreeItem(std::vector<QVariant> data, AssetTreeItem* parentItem = nullptr);
@@ -49,7 +49,7 @@ public:
/**
* Returns pointer to this tree item's child at position \p row.
*
* \param row int of the row number of the child to get pointer
* \param row The row number of the child to get pointer
*/
AssetTreeItem* child(int row) const;
@@ -78,27 +78,27 @@ public:
/**
* Inserts children item(s) to the current item.
*
* \param position where in this item's children to insert new children
* \param count number of children to insert
* \param columns number of data columns in each child
* \param position Where in this item's children to insert new children
* \param count Number of children to insert
* \param columns Number of data columns in each child
*
* \return true if new children were successfully inserted
* \return `true` if new children were successfully inserted
*/
bool insertChildren(int position, int count, int columns);
/**
* Inserts data column(s) in the current item.
*
* \param position column number at which to insert column(s)
* \param columns number of columns to insert
* \return true if columns were successfully inserted
* \param position Column number at which to insert column(s)
* \param columns Number of columns to insert
* \return `true` if columns were successfully inserted
*/
bool insertColumns(int position, int columns);
/**
* Returns a pointer to the current item's parent.
*
* \return pointer to the \p assetTreeItem parent
* \return Pointer to the \p assetTreeItem parent
*/
AssetTreeItem* parent();
@@ -112,10 +112,10 @@ public:
/**
* Returns the data at column \p column of this item.
*
* \param position The position of the child(ren) to remove from the current
* item (which is parent)
* \param position The position of the child(ren) to remove from the current item
* (which is parent)
* \param count The number of children to remove
* \return true if child item(s) successfully removed
* \return `true` if child item(s) successfully removed
*/
bool removeChildren(int position, int count);
@@ -124,7 +124,7 @@ public:
*
* \param column The data column number to set
* \param value The #QVariant data element to store at column \p column
* \return true if the data set was successful
* \return `true` if the data set was successful
*/
bool setData(int column, const QVariant& value);
@@ -132,30 +132,30 @@ public:
* Returns the checked state of this item. If an asset is selected to be included
* in a profile, then it is checked.
*
* \return true if this item is checked
* \return `true` if this item is checked
*/
bool isChecked() const;
/**
* Sets the checked state of this item (whether or not it is selected for a profile).
*
* \param set bool for whether or not this is checked
* \param set Whether or not this item is checked
*/
void setChecked(bool set);
/**
* Returns a bool for whether or not this is an asset. If it is a file
* (has no children in the filesystem tree), then it is an asset.
* Returns a bool for whether or not this is an asset. If it is a file (has no
* children in the filesystem tree), then it is an asset.
*
* \return true if this is an asset file and not a directory containing asset(s)
* \return `true` if this is an asset file and not a directory containing asset(s)
*/
bool isAsset() const;
/**
* Returns a bool for whether or not this is a category. If it is a directory
* and not an asset (file), then it is a category.
* Returns a bool for whether or not this is a category. If it is a directory and not
* an asset (file), then it is a category.
*
* \return true if this is a category
* \return `true` if this is a category
*/
bool isCategory() const;
@@ -164,14 +164,14 @@ public:
* possible that an imported profile lists an asset from another system that is not
* included on the current filesystem.
*
* \param set to true if the asset file exists in the current filesystem
* \param fileExists `true` if the asset file exists in the current filesystem
*/
void setExistsInFilesystem(bool fileExists);
/**
* Returns bool for whether or not the asset exists in the current filesystem.
*
* \return true if the asset exists in the current filesystem
* \return `true` if the asset exists in the current filesystem
*/
bool doesExistInFilesystem() const;
apps/OpenSpace/ext/launcher/include/profile/assettreemodel.h
+48 -48
View File
@@ -39,9 +39,9 @@ public:
/**
* Returns the data contained at an index.
*
* \param index that defines where the item is located in the tree model
* \param role Qt-defined role that describes the reason Qt is calling the
* function (can be multiple times)
* \param index The index defining where the item is located in the tree model
* \param role Qt-defined role that describes the reason Qt is calling the function
* (can be multiple times)
* \return QVariant data object
*/
QVariant data(const QModelIndex& index, int role) const final;
@@ -49,10 +49,10 @@ public:
/**
* Returns the header data of the tree view.
*
* \param section of data to be obtained from header
* \param orientation of the query (e.g. Qt::horizontal)
* \param role Qt-defined role that describes the reason Qt is calling the
* function (can be multiple times)
* \param section The data to be obtained from header
* \param orientation The orientation of the query (e.g. Qt::horizontal)
* \param role Qt-defined role that describes the reason Qt is calling the function
* (can be multiple times)
* \return QVariant data object in the header
*/
QVariant headerData(int section, Qt::Orientation orientation,
@@ -61,10 +61,10 @@ public:
/**
* Returns the index of item in #QModelIndex object form.
*
* \param row the row number
* \param column the column number
* \param parent index of parent
* \return #QModelIndex index of the item at specified position
* \param row The row number
* \param column The column number
* \param parent Index of parent
* \return QModelIndex index of the item at specified position
*/
QModelIndex index(int row, int column,
const QModelIndex& parent = QModelIndex()) const final;
@@ -72,18 +72,18 @@ public:
/**
* Returns the index of the parent of the item specified by input param.
*
* \param index of item that is a child of the parent
* \return #QModelIndex index of the parent
* \param index The index of item that is a child of the parent
* \return QModelIndex index of the parent
*/
QModelIndex parent(const QModelIndex& index) const final;
/**
* Returns the index of the parent of the item specified by the input params.
*
* \param row the row number
* \param column the column number
* \param parent index of parent
* \return #QModelIndex index of the parent
* \param row The row number
* \param column The column number
* \param parent Index of parent
* \return QModelIndex index of the parent
*/
QModelIndex parent(int row, int column,
const QModelIndex& parent = QModelIndex()) const;
@@ -91,24 +91,24 @@ public:
/**
* Returns asset item at specified index.
*
* \param index of item that is a child of the parent
* \return #assetTreeItem pointer to the item at the provided index
* \param index The index of item that is a child of the parent
* \return Pointer to the item at the provided index
*/
AssetTreeItem* assetItem(const QModelIndex& index);
/**
* Returns number of children/rows of the parent.
*
* \param parent #QModelIndex of the parent item
* \return number of children/rows of this parent
* \param parent QModelIndex of the parent item
* \return The number of children/rows of this parent
*/
int rowCount(const QModelIndex& parent = QModelIndex()) const final;
/**
* Returns the number of columns of data in each item of the tree.
*
* \param parent specified by the #QModelIndex index
* \return the number of data columns
* \param parent The parent specified by the QModelIndex index
* \return The number of data columns
*/
int columnCount(const QModelIndex& parent = QModelIndex()) const final;
@@ -116,18 +116,18 @@ public:
* Return the Qt flags of the item specified by index, which can include
* Qt::ItemIsEnabled, Qt::ItemIsSelectable.
*
* \param index specified by the #QModelIndex index
* \return the Qt flags
* \param index The index specified by the #QModelIndex index
* \return The Qt flags
*/
Qt::ItemFlags flags(const QModelIndex& index) const final;
/**
* Set data at index \p index.
*
* \param index location of the item to set
* \param index Location of the item to set
* \param value The #QVariant data element to store at column \p column
* \param role Qt-specific role to define context of the call
* \return true if the data set was successful
* \return `true` if the data set was successful
*/
bool setData(const QModelIndex& index, const QVariant& value,
int role = Qt::EditRole) final;
@@ -135,9 +135,8 @@ public:
/**
* Returns a vector of all #Assets selected in the tree view.
*
* \param outputPaths vector of #openspace::Profile::Asset objects, each of which are
* selected
* \param outputItems vector of #assetTreeItem * objects, each of which are selected
* \param outputPaths The vector of paths that were selected
* \param outputItems The vector of AssetTreeItem that were selected
*/
void getSelectedAssets(std::vector<std::string>& outputPaths,
std::vector<AssetTreeItem*>& outputItems);
@@ -145,6 +144,7 @@ public:
/**
* Imports asset tree data for this model by recursively traversing the folder
* structure.
*
* \param assetBasePath The base path where to find all assets
* \param assetBasePath The base path where to find user assets
*/
@@ -154,72 +154,72 @@ public:
/**
* Returns bool for if item is checked/selected.
*
* \param index location of the item to set
* \return true if the item is checked
* \param index Location of the item to set
* \return `true` if the item is checked
*/
bool isChecked(QModelIndex& index) const;
/**
* Answers query about whether or not item is an asset.
*
* \param index location of the item to query
* \return true if the item is an asset (and not a directory)
* \param index Location of the item to query
* \return `true` if the item is an asset (and not a directory)
*/
bool isAsset(QModelIndex& index) const;
/**
* Answers query about whether or not item is in the current filesystem.
*
* \param index location of the item to query
* \return true if the data is in the filesystem
* \param index Location of the item to query
* \return `true` if the data is in the filesystem
*/
bool inFilesystem(QModelIndex& index) const;
/**
* Returns number of child items of referenced item.
*
* \param index location of the item to query
* \return number of child items
* \param index Location of the item to query
* \return Number of child items
*/
int childCount(QModelIndex& index) const;
/**
* Returns a pointer to a child item of the current item.
*
* \param row the child number of the current item
* \return assetTreeItem pointer to the child
* \param row The child number of the current item
* \return The pointer to the child
*/
AssetTreeItem* child(int row) const;
/**
* Returns the asset name of the specified item.
*
* \param index location of the item to query
* \return the asset name of the item
* \param index Location of the item to query
* \return The asset name of the item
*/
QString name(QModelIndex& index) const;
/**
* Set asset name at specified index.
*
* \param index location of the item to set
* \param name the asset name to set
* \param index Location of the item to set
* \param name The asset name to set
*/
void setName(QModelIndex& index, QString name);
/**
* Set state of checked/selected of an item.
*
* \param index location of the item to set
* \param checked true if item is checked/selected
* \param index Location of the item to set
* \param checked `true` if item is checked/selected
*/
void setChecked(QModelIndex& index, bool checked);
/**
* Set state of whether or not asset exists in filesystem.
*
* \param index location of the item to set
* \param fileExists true if asset exists in filesystem
* \param index Location of the item to set
* \param fileExists `true` if asset exists in filesystem
*/
void setExistenceInFilesystem(QModelIndex& index, bool fileExists);
apps/OpenSpace/ext/launcher/include/profile/cameradialog.h
+3 -3
View File
@@ -40,9 +40,9 @@ public:
/**
* Constructor for camera gui class
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget (optional)
* \param parent Pointer to parent Qt widget
* \param profile The #openspace::Profile::CameraType object containing all data of
* the new or imported profile
*/
CameraDialog(QWidget* parent, std::optional<openspace::Profile::CameraType>* camera);
apps/OpenSpace/ext/launcher/include/profile/deltatimesdialog.h
+10 -10
View File
@@ -37,27 +37,27 @@ class DeltaTimesDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for deltaTimes class
* Constructor for deltaTimes class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param profile The list of delta times containing all data of the new or imported
* profile
*/
DeltaTimesDialog(QWidget* parent, std::vector<double>* deltaTimes);
/**
* Returns a text summary of the delta time list for display purposes
* Returns a text summary of the delta time list for display purposes.
*
* \param idx index in dt list
* \param forListView true if this summary is for the Qt list view, false if
* it is used for a different display mode
* \param forListView true if this summary is for the Qt list view, false if it is
* used for a different display mode
*/
std::string createSummaryForDeltaTime(size_t idx, bool forListView);
/**
* Handles keypress while the Qt dialog window is open
* Handles keypress while the Qt dialog window is open.
*
* \param evt #QKeyEvent object for the key press event
* \param evt QKeyEvent object for the key press event
*/
virtual void keyPressEvent(QKeyEvent* evt) override;
@@ -73,9 +73,9 @@ private:
void parseSelections();
/**
* Called to transition to editing a particular dt value (gui settings)
* Called to transition to editing a particular dt value (gui settings).
*
* \param index index in dt list
* \param index Index in dt list
* \param state `true` if the edit mode should be turned on, `false` otherwise
*/
void transitionEditMode(int index, bool state);
apps/OpenSpace/ext/launcher/include/profile/marknodesdialog.h
+5 -5
View File
@@ -36,18 +36,18 @@ class MarkNodesDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for markNodes class
* Constructor for markNodes class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param profile The list of marked nodes containing all data of the new or imported
* profile
*/
MarkNodesDialog(QWidget* parent, std::vector<std::string>* markedNodes);
/**
* Handles keypress while the Qt dialog window is open
* Handles keypress while the Qt dialog window is open.
*
* \param evt #QKeyEvent object for the key press event
* \param evt QKeyEvent object for the key press event
*/
void keyPressEvent(QKeyEvent* evt) override;
apps/OpenSpace/ext/launcher/include/profile/metadialog.h
+2 -2
View File
@@ -39,9 +39,9 @@ public:
/**
* Constructor for meta class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param profile The #openspace::Profile::Meta object containing all data of the
* new or imported profile
*/
MetaDialog(QWidget* parent, std::optional<openspace::Profile::Meta>* meta);
apps/OpenSpace/ext/launcher/include/profile/modulesdialog.h
+5 -5
View File
@@ -39,18 +39,18 @@ class ModulesDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for osmodules class
* Constructor for modules class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param profile The #openspace::Profile::Module object containing all data of the
* new or imported profile
*/
ModulesDialog(QWidget* parent, std::vector<openspace::Profile::Module>* modules);
/**
* Handles keypress while the Qt dialog window is open
* Handles keypress while the Qt dialog window is open.
*
* \param evt #QKeyEvent object for the key press event
* \param evt QKeyEvent object for the key press event
*/
virtual void keyPressEvent(QKeyEvent* evt) override;
apps/OpenSpace/ext/launcher/include/profile/profileedit.h
+7 -7
View File
@@ -40,10 +40,10 @@ class ProfileEdit final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for ProfileEdit class
* Constructor for ProfileEdit class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param profile The #openspace::Profile object containing all data of the new or
* imported profile
* \param profileName The name of the profile to create
* \param assetBasePath The path to the folder where the assets live
* \param userAssetBasePath The path to the folder where the user assets live
@@ -59,7 +59,7 @@ public:
/**
* Gets the status of the save when the window is closed; was the file saved?
*
* \return true if the file was saved (false if cancel)
* \return `true` if the file was saved (false if cancel)
*/
bool wasSaved() const;
@@ -67,14 +67,14 @@ public:
* Gets the profile name from the top save/edit window. This can be changed by user in
* order to save to a different file.
*
* \return the profile name
* \return The profile name
*/
std::string specifiedFilename() const;
/**
* Handles keypress while the Qt dialog window is open
* Handles keypress while the Qt dialog window is open.
*
* \param evt #QKeyEvent object for the key press event
* \param evt The QKeyEvent object for the key press event
*/
virtual void keyPressEvent(QKeyEvent* evt) override;
apps/OpenSpace/ext/launcher/include/profile/propertiesdialog.h
+5 -5
View File
@@ -40,19 +40,19 @@ class PropertiesDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for properties class
* Constructor for properties class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param properties The #openspace::Profile::Property object containing all data of
* the new or imported profile
*/
PropertiesDialog(QWidget* parent,
std::vector<openspace::Profile::Property>* properties);
/**
* Handles keypress while the Qt dialog window is open
* Handles keypress while the Qt dialog window is open.
*
* \param evt #QKeyEvent object for the key press event
* \param evt The QKeyEvent object for the key press event
*/
virtual void keyPressEvent(QKeyEvent* evt) override;
apps/OpenSpace/ext/launcher/include/profile/scriptlogdialog.h
+2 -2
View File
@@ -41,10 +41,10 @@ signals:
private:
void createWidgets();
void loadScriptFile();
void saveChosenScripts();
void updateScriptList();
QListWidget* _scriptlogList = nullptr;
apps/OpenSpace/ext/launcher/include/profile/timedialog.h
+3 -3
View File
@@ -39,11 +39,11 @@ class TimeDialog final : public QDialog {
Q_OBJECT
public:
/**
* Constructor for ostime class
* Constructor for ostime class.
*
* \param profile The #openspace::Profile object containing all data of the
* new or imported profile.
* \param parent Pointer to parent Qt widget
* \param time The #openspace::Profile::Time object containing all data of the new or
* imported profile.
*/
TimeDialog(QWidget* parent, std::optional<openspace::Profile::Time>* time);
apps/OpenSpace/ext/launcher/include/sgctedit/displaywindowunion.h
+16 -16
View File
@@ -39,27 +39,27 @@ Q_OBJECT
public:
/**
* Constructor for DisplayWindowUnion class, which manages the overall control layout
* including monitorBox, multiple WindowControl columns, and additional controls
* including monitorBox, multiple WindowControl columns, and additional controls.
*
* \param monitorSizeList A vector containing QRect objects containing pixel dims
* of each monitor
* \param nMaxWindows The maximum number of windows allowed (depends on the number
* of monitors in the system)
* \param winColors An array of QColor objects for window colors. The indexing of
* this array matches the window indexing used elsewhere in the
* class. This allows for a unique color for each window.
* \param monitorSizeList A vector containing QRect objects containing pixel dims of
* each monitor
* \param nMaxWindows The maximum number of windows allowed (depends on the number of
* monitors in the system)
* \param winColors An array of QColor objects for window colors. The indexing of this
* array matches the window indexing used elsewhere in the class. This allows
* for a unique color for each window
* \param resetToDefault If set to true, all display and window settings will be
* initialized to their default values.
* initialized to their default values
* \param parent The parent to which this widget belongs
*/
DisplayWindowUnion(const std::vector<QRect>& monitorSizeList,
int nMaxWindows, const std::array<QColor, 4>& windowColors, bool resetToDefault,
QWidget* parent = nullptr);
/**
* Returns a vector of pointers to the WindowControl objects for all visible windows.
*
* \return vector of pointers of WindowControl objects
* \return The vector of pointers of WindowControl objects
*/
std::vector<WindowControl*> activeWindowControls() const;
@@ -67,7 +67,7 @@ public:
* Returns a vector of pointers to the WindowControl objects for all windows, whether
* they are visible or not.
*
* \return vector of pointers of all WindowControl objects
* \return The vector of pointers of all WindowControl objects
*/
std::vector<WindowControl*>& windowControls();
@@ -87,14 +87,14 @@ public:
* Returns the number of windows that are displayed (there can be more window
* objects than are currently displayed).
*
* \return the number of displayed windows in the current configuration
* \return The number of displayed windows in the current configuration
*/
unsigned int numWindowsDisplayed() const;
signals:
/**
* This signal is emitted when a windowhas changed.
*
* This signal is emitted when a window has changed.
*
* \param monitorIndex The 0-based index of the monitor to which the window belongs to
* \param windowIndex The 0-based index of the window that was changed
* \param newDimensions The pixel sizes of the window after the change
@@ -103,7 +103,7 @@ signals:
/**
* This signal is emitted when the total number of windows has changed.
*
*
* \param newCount The new total number of windows
*/
void nWindowsChanged(int newCount);
apps/OpenSpace/ext/launcher/include/sgctedit/monitorbox.h
+8 -8
View File
@@ -35,16 +35,16 @@ class MonitorBox final : public QWidget {
Q_OBJECT
public:
/**
* Constructor for MonitorBox class, which displays the system's monitor(s),
* their relative position and size, and window(s) that they contain
* Constructor for MonitorBox class, which displays the system's monitor(s), their
* relative position and size, and window(s) that they contain.
*
* \param widgetDims The size of the display widget in pixels, stored in QRect
* \param monitorResolution A vector containing the monitor's maximum display
* size in pixels in a QRect object
* \param monitorResolution A vector containing the monitor's maximum display size in
* pixels in a QRect object
* \param nWindows The current number of windows that has been selected by the user
* \param winColors An array of QColor objects for window colors. The indexing of
* this array matches the window indexing used elsewhere in the
* class. This allows for a unique color for each window.
* \param winColors An array of QColor objects for window colors. The indexing of this
* array matches the window indexing used elsewhere in the class. This allows
* for a unique color for each window
* \param parent The parent which to which this MonitorBox belongs
*/
MonitorBox(QRect widgetDims, const std::vector<QRect>& monitorResolutions,
@@ -65,7 +65,7 @@ public:
/**
* Called when the number of windows that should be displayed changes.
*
*
* \param newCount The new number of windows included
*/
void nWindowsDisplayedChanged(int newCount);
apps/OpenSpace/ext/launcher/include/sgctedit/orientationdialog.h
+4 -4
View File
@@ -37,16 +37,16 @@ Q_OBJECT
public:
/**
* Constructor for OrientationDialog object which contains the input text boxes for
* orientation x,y,z values
* orientation x,y,z values,
*
* \param orientation x,y,z angles in degrees contained in sgct::quat object
* \param parent pointer to Qt QWidget parent object
* \param orientation The x,y,z angles in degrees contained in sgct::quat object
* \param parent Pointer to Qt QWidget parent object
*/
OrientationDialog(sgct::quat& orientation, QWidget* parent);
private:
void ok();
QLineEdit* _linePitch = nullptr;
QLineEdit* _lineRoll = nullptr;
QLineEdit* _lineYaw = nullptr;
apps/OpenSpace/ext/launcher/include/sgctedit/settingswidget.h
+34 -35
View File
@@ -39,45 +39,44 @@ Q_OBJECT
public:
/**
* Constructor for Orientation class, which manages the overall control layout
* including monitorBox, multiple WindowControl columns, and additional controls
* including monitorBox, multiple WindowControl columns, and additional controls.
*/
SettingsWidget(sgct::quat orientation, QWidget* parent = nullptr);
/**
* Gets the user-provided x,y,z orientation values (degrees)
* Gets the user-provided x,y,z orientation values (degrees).
*
* \return the orientation angles provided in sgct::quat object
* \return The orientation angles provided in sgct::quat object
*/
sgct::quat orientation() const;
/**
* Gets the value for if VSync is enabled
* Gets the value for if VSync is enabled.
*
* \return true if the VSync option is checked/enabled
* \return `true` if the VSync option is checked/enabled
*/
bool vsync() const;
/**
* Gets whether the UI should be restricted to the first window
*
* \return true if the UI should only be on the first window
* Gets whether the UI should be restricted to the first window.
*
* \return `true` if the UI should only be on the first window
*/
bool showUiOnFirstWindow() const;
/**
* Sets the value of the checkbox for putting the GUI only on the first window.
* If this is enabled, then the first window will draw2D but not draw3D. All
* subsequent windows will be the opposite of this.
*
* \param setUiOnFirstWindow boolean value, if set true then the GUI will only
* be on the first window
* Sets the value of the checkbox for putting the GUI only on the first window. If
* this is enabled, then the first window will draw2D but not draw3D. All subsequent
* windows will be the opposite of this.
*
* \param setUiOnFirstWindow If `true` then the GUI will only be on the first window
*/
void setShowUiOnFirstWindow(bool setUiOnFirstWindow);
/**
* Sets value for whether or not the checkbox for having the UI only on the first
* window is enabled. This checkbox should only be clickable if the number of
* windows is 2 or more.
* windows is 2 or more.
*/
void setEnableShowUiOnFirstWindowCheckbox(bool enable);
@@ -85,48 +84,48 @@ public:
* Gets the value of the selection for which display first window should mirror if
* the option to show the Ui in the first window is enabled. Note that this will
* return a value even if the checkbox is not enabled.
*
* \return -1 if in a disabled state (e.g. when showUiOnFirstWindow() returns false)
* 0 if no window graphics are selected (only the UI will appear)
* (1-4) for which window's setting will be used for window 1 graphics
*
* \return `-1` if in a disabled state (e.g. when showUiOnFirstWindow() returns
* false). `0` if no window graphics are selected (only the UI will appear).
* `(1-4)` for which window's setting will be used for window 1 graphics
*/
int graphicsSelectionForShowUiOnFirstWindow() const;
/**
* Sets value of the graphics selection combo box for which other window that the
* first window will mirror.
*
* \param selection int value for the combo box selection.
* 0 if no window graphics are selected (only the UI will appear)
* (1-4) for which window's setting to use for window 1 graphics
*
* \param selection integer value for the combo box selection. `0` if no window
* graphics are selected (only the UI will appear). `(1-4)` for which window's
* setting to use for window 1 graphics
*/
void setGraphicsSelectionForShowUiOnFirstWindow(int selection);
/**
* Sets the value of the checkbox for enabling VSync.
*
* \param enableVsync boolean value, if set true then VSync is enabled
*
* \param enableVsync If set `true` then VSync is enabled
*/
void setVsync(bool enableVsync);
/**
* Called when the number of windows that should be displayed changes.
*
*
* \param newCount The new number of windows included
*/
void nWindowsDisplayedChanged(int newCount);
/**
* Gets the pointer to the QComboBox that selects the graphics for first window
*
* \return pointer to the QComboBox object
* Gets the pointer to the QComboBox that selects the graphics for first window.
*
* \return Pointer to the QComboBox object
*/
QComboBox* firstWindowGraphicsSelection();
/**
* Gets the pointer to the QCheckBox that selects if UI is in first window only
*
* \return pointer to the QCheckBox object
* Gets the pointer to the QCheckBox that selects if UI is in first window only.
*
* \return Pointer to the QCheckBox object
*/
QCheckBox* showUiOnFirstWindowCheckbox();
@@ -135,7 +134,7 @@ signals:
private:
void showUiOnFirstWindowClicked(bool checked);
void firstWindowGraphicsSelectionChanged(const QString &text);
void firstWindowGraphicsSelectionChanged(const QString& text);
sgct::quat _orientationValue = sgct::quat(0.f, 0.f, 0.f, 0.f);
QCheckBox* _checkBoxVsync = nullptr;
apps/OpenSpace/ext/launcher/include/sgctedit/sgctedit.h
+9 -9
View File
@@ -52,7 +52,7 @@ public:
*
* \param parent The Qt QWidget parent object
* \param userConfigPath A string containing the file path of the user config
* directory where all window configs are stored
* directory where all window configs are stored
*/
SgctEdit(QWidget* parent, std::string userConfigPath);
@@ -70,37 +70,37 @@ public:
std::string& configBasePath, QWidget* parent);
/**
* Returns the saved filename
* Returns the saved filename.
*
* \return saved filename in std::string
* \return The saved filename in std::string
*/
std::filesystem::path saveFilename() const;
/**
* Returns the generated Cluster object.
*
*
* \return The generated Cluster object
*/
sgct::config::Cluster cluster() const;
/**
* Called when the number of windows that should be displayed changes.
*
*
* \param newCount The new number of windows included
*/
void nWindowsDisplayedChanged(int newCount);
/**
* Called when the checkbox for GUI only on first window is clicked.
*
* \param checked true if GUI is selected for first window only.
*
* \param checked `true` if GUI is selected for first window only.
*/
void firstWindowGuiOptionClicked(bool checked);
/**
* Called when the QComboBox is selected and has a new value
*
* \param text the QString of the selected value
*
* \param text The QString of the selected value
*/
void firstWindowGraphicsSelectionChanged(const QString& text);
apps/OpenSpace/ext/launcher/include/sgctedit/windowcontrol.h
+47 -44
View File
@@ -50,55 +50,58 @@ public:
};
/**
* Constructor for WindowControl class, which contains settings and configuration
* for individual windows
* Constructor for WindowControl class, which contains settings and configuration for
* individual windows.
*
* \param monitorIndex The zero-based index for monitor number that this window
* resides in
* resides in
* \param windowIndex The zero-based window index
* \param monitorDims Vector of monitor dimensions in QRect form
* \param winColor A QColor object for this window's unique color
* \param resetToDefault If this is `true`, the widgets will be initialized to their
* default values
* \param parent The parent widget
*/
WindowControl(int monitorIndex, int windowIndex,
const std::vector<QRect>& monitorDims, const QColor& winColor,
bool resetToDefault, QWidget* parent);
/**
* Makes the window label at top of a window control column visible
* Makes the window label at top of a window control column visible.
*
* \param bool Shows the window label if true
* \param show Shows the window label if true
*/
void showWindowLabel(bool show);
/**
* Resets all controls for this window to default settings
* Resets all controls for this window to default settings.
*/
void resetToDefaults();
/**
* Sets the window dimensions
* Sets the window dimensions.
*
* \param newDims The x, y dimensions to set the window to
*/
void setDimensions(QRectF newDims);
/**
* Sets the monitor selection combobox
* Sets the monitor selection combobox.
*
* \param monitorIndex The zero-based monitor index to set the combobox selection to
*/
void setMonitorSelection(int monitorIndex);
/**
* Sets the window name in the text edit box
* Sets the window name in the text edit box.
*
* \param windowName The window title to set
*/
void setWindowName(const std::string& windowName);
/**
* Sets the window's decoration status. If set to true, then the window has a
* border. If false it is borderless
* Sets the window's decoration status. If set to true, then the window has a border.
* If false it is borderless.
*
* \param hasWindowDecoration boolean for if window has decoration (border)
*/
@@ -106,10 +109,10 @@ public:
/**
* Generates window configuration (sgct::config::Window struct) based on the
* GUI settings.
* GUI settings.
*
* \param window The sgct::config::Window struct that is passed into the function
* and modified with the generated window content
* \param window The sgct::config::Window struct that is passed into the function and
* modified with the generated window content
*/
void generateWindowInformation(sgct::config::Window& window) const;
@@ -117,67 +120,67 @@ public:
* Sets the window's projection type to planar, with the accompanying parameters
* for horizontal and vertical FOV.
*
* \param hfov float value for horizontal field of view angle (degrees)
* \param vfov float value for vertical field of view angle (degrees)
* \param hfov The horizontal field of view angle in degrees
* \param vfov The vertical field of view angle in degrees
*/
void setProjectionPlanar(float hfov, float vfov);
/**
* Sets the window's projection type to fisheye, with the accompanying quality
* setting and spout option
* setting and spout option.
*
* \param quality int value for number of vertical lines of resolution. This will
* be compared against the QualityValues array in order to set the
* correct combobox index
* \param spoutOutput bool for enabling the spout output option
* \param quality The value for number of vertical lines of resolution. This will be
* compared against the QualityValues array in order to set the correct
* combobox index
* \param spoutOutput Enabling the spout output option
*/
void setProjectionFisheye(int quality, bool spoutOutput);
/**
* Sets the window's projection type to spherical mirror, with the accompanying
* quality setting
* quality setting.
*
* \param quality int value for number of vertical lines of resolution. This will
* be compared against the QualityValues array in order to set the
* correct combobox index
* \param quality The value for number of vertical lines of resolution. This will be
* compared against the QualityValues array in order to set the correct
* combobox index
*/
void setProjectionSphericalMirror(int quality);
/**
* Sets the window's projection type to cylindrical, with the accompanying quality
* setting and height offset value
* setting and height offset value.
*
* \param quality int value for number of vertical lines of resolution. This will
* be compared against the QualityValues array in order to set the
* correct combobox index
* \param heightOffset float value for height offset to be applied
* \param quality The value for number of vertical lines of resolution. This will be
* compared against the QualityValues array in order to set the correct
* combobox index
* \param heightOffset The height offset to be applied
*/
void setProjectionCylindrical(int quality, float heightOffset);
/**
* Sets the window's projection type to equirectangular, with the accompanying
* quality setting and spout option
* quality setting and spout option.
*
* \param quality int value for number of vertical lines of resolution. This will
* be compared against the QualityValues array in order to set the
* correct combobox index
* \param spoutOutput bool for enabling the spout output option
* \param quality The value for number of vertical lines of resolution. This will be
* compared against the QualityValues array in order to set the correct
* combobox index
* \param spoutOutput Enabling the spout output option
*/
void setProjectionEquirectangular(int quality, bool spoutOutput);
/**
* Controls the visibility of all projection controls, including those
* that are only shown when the projection type is set to certain values.
* Controls the visibility of all projection controls, including those that are only
* shown when the projection type is set to certain values.
*
* \param enable bool true if the projections controls should be visible
* \param enable `true` if the projections controls should be visible
*/
void setVisibilityOfProjectionGui(bool enable);
/**
* Returns an sgct::config::Projections struct containing the projection
* information for this window.
* Returns an #sgct::config::Projections struct containing the projection information
* for this window.
*
* \return sgct::config::Projections object containing the projection information
* \return The object containing the projection information
*/
sgct::config::Projections generateProjectionInformation() const;
@@ -213,7 +216,7 @@ private:
bool _fovLocked = true;
std::vector<QRect> _monitorResolutions;
QRectF _windowDimensions;
QLabel* _windowNumber = nullptr;
QLineEdit* _windowName = nullptr;
QComboBox* _monitor = nullptr;
apps/OpenSpace/ext/sgct
+1 -1
Submodule apps/OpenSpace/ext/sgct updated: 2c151bbffe...e2e1b99a2d
ext/ghoul
+1 -1
Submodule ext/ghoul updated: b9c9a031f8...82f83b40fd
include/openspace/interaction/sessionrecording.h
+1
View File
@@ -585,6 +585,7 @@ public:
the file format version number.
*
* \param filename source filename to be converted
* \param mode Whether the file is binary or text-based
*
* \return pathname of the converted version of the file
*/
include/openspace/util/time.h
+10 -16
View File
@@ -38,15 +38,12 @@ namespace scripting { struct LuaLibrary; }
* the J2000 epoch or a `string` that denotes a valid date string in accordance to the
* SPICE library (http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/str2et_c.html).
* The time can be retrieved as the number of seconds since the J2000 epoch with
* #currentTime or as a UTC string following ISO 8601 with the method #UTC.
* #j2000Seconds or as a UTC string following ISO 8601 with the method #UTC.
*
* In addition to the time itself, it also stores a delta time value. This value denotes
* the number of seconds that pass for each real-time second. This value is set with
* #setDeltaTime(double), retrieved with deltaTime() and solely used in the
* #advanceTime(double), which takes a `tickTime` parameter. The value of the parameter is
* dependent on the usage of the class and must be equal to the real-world time that has
* passed since the last call to the method. For example, if the #advanceTime(double)
* method is called each frame, the `tickTime` has to be equal to the frame time.
* The value of the parameter is dependent on the usage of the class and must be equal to
* the real-world time that has passed since the last call to the method. For example, if
* the #advanceTime(double) method is called each frame, the `tickTime` has to be equal to
* the frame time.
*/
class Time {
public:
@@ -153,17 +150,14 @@ public:
void ISO8601(char* buffer) const;
/**
* Advances the simulation time using the #deltaTime and the `tickTime`. The
* #deltaTime is the number of simulation seconds that pass for each real-time second.
* `tickTime` is the number of real-time seconds that passed since the last call to
* this method. If this method is called in the render loop, the \p tickTime should be
* equivalent to the frame time.
* Advances the simulation time using the \p deltaTime. The \p deltaTime is the number
* of seconds that the time should be advanced by. If this method is called in the
* render loop, the \p deltaTime should be equivalent to the frame time.
*
* \param tickTime The number of real-time seconds that passed since the last call to
* this method
* \param deltaTime The number of seconds that this time should be advanced by
* \return The new time value after advancing the time
*/
double advanceTime(double tickTime);
double advanceTime(double deltaTime);
/**
* Modifies the passed time (first argument) by the delta time (second argument). The
modules/gaia/rendering/octreemanager.h
+2 -2
View File
@@ -91,8 +91,8 @@ public:
/**
* Prints the whole tree structure, including number of stars per node, number of
* nodes, tree depth and if node is a leaf. Calls #printStarsPerNode(node, prefix)
* internally.
* nodes, tree depth and if node is a leaf. Calls
* #printStarsPerNode(const OctreeNode&, const std::string&) const internally.
*/
void printStarsPerNode() const;