diff --git a/modules/camera/include/vkcv/camera/Camera.hpp b/modules/camera/include/vkcv/camera/Camera.hpp index 795a386eec6a757aac5c9e8d62a9daa2b67f47ac..b333fbbd696a4583bd4aa9f9591a75d4de532d1d 100644 --- a/modules/camera/include/vkcv/camera/Camera.hpp +++ b/modules/camera/include/vkcv/camera/Camera.hpp @@ -1,4 +1,9 @@ #pragma once +/** + * @authors Vanessa Karolek, Josch Morgenstern, Sebastian Gaida, Katharina Krämer, Tobias Frisch, Alexander Gauggel + * @file include/vkcv/camera/Camera.hpp + * @brief Camera class of the camera module for the vkcv framework. + */ #include <glm/glm.hpp> #include <glm/gtc/matrix_transform.hpp> diff --git a/modules/camera/include/vkcv/camera/CameraController.hpp b/modules/camera/include/vkcv/camera/CameraController.hpp index 143893a5f000abb2e0cfc6dba407dfd098726abd..d6efd8f2f300dead870b3546939dad2088cd466e 100644 --- a/modules/camera/include/vkcv/camera/CameraController.hpp +++ b/modules/camera/include/vkcv/camera/CameraController.hpp @@ -1,4 +1,11 @@ #pragma once +/** + * @authors Vanessa Karolek, Josch Morgenstern, Tobias Frisch + * @file include/vkcv/camera/CameraController.hpp + * @brief CameraController class of the camera module for the vkcv framework. A camera object is controlled by a camera + * controller object. Using inheritance of this base class a camera controller object defines a specific control + * behaviour of the camera object in the scene. + */ #include "Camera.hpp" #include "vkcv/Window.hpp" diff --git a/modules/camera/include/vkcv/camera/CameraManager.hpp b/modules/camera/include/vkcv/camera/CameraManager.hpp index 9f5aa0080b90eda2c2b5edb4713487c654fdde4b..092e1fc8552a192368b06216e2f51d2b291946d7 100644 --- a/modules/camera/include/vkcv/camera/CameraManager.hpp +++ b/modules/camera/include/vkcv/camera/CameraManager.hpp @@ -1,4 +1,10 @@ #pragma once +/** + * @authors Vanessa Karolek, Josch Morgenstern, Sebastian Gaida, Katharina Krämer, Tobias Frisch, Alexander Gauggel + * @file include/vkcv/camera/CameraManager.hpp + * @brief CameraManager class of the camera module for the vkcv framework. The camera manager manages several camera + * controller objects. Camera objects can be created and bound to a specific camera controller via this class. + */ #include "PilotCameraController.hpp" #include "TrackballCameraController.hpp" diff --git a/modules/camera/include/vkcv/camera/PilotCameraController.hpp b/modules/camera/include/vkcv/camera/PilotCameraController.hpp index 0596b7763892046e18e09eebbceb6a19dd6cb43b..c23a2cccce6f3d4036e9648d39b7b39df1d7ce4b 100644 --- a/modules/camera/include/vkcv/camera/PilotCameraController.hpp +++ b/modules/camera/include/vkcv/camera/PilotCameraController.hpp @@ -1,4 +1,10 @@ #pragma once +/** + * @authors Vanessa Karolek, Josch Morgenstern, Tobias Frisch + * @file include/vkcv/camera/PilotCameraController.hpp + * @brief PilotCameraController class of the camera module for the vkcv framework. This class inherits from the base + * class @#CameraController and enables camera objects to be moved freely within the scene. + */ #include <vkcv/camera/CameraController.hpp> diff --git a/modules/camera/include/vkcv/camera/TrackballCameraController.hpp b/modules/camera/include/vkcv/camera/TrackballCameraController.hpp index 13f7fefa76b0c4e5823845d5fd90f4cd62e5c5f9..e4f40383218f8c25fd0bca41d9ff673ce5a3589e 100644 --- a/modules/camera/include/vkcv/camera/TrackballCameraController.hpp +++ b/modules/camera/include/vkcv/camera/TrackballCameraController.hpp @@ -1,4 +1,10 @@ #pragma once +/** + * @authors Vanessa Karolek, Josch Morgenstern, Sebastian Gaida,Tobias Frisch + * @file include/vkcv/camera/TrackballCameraController.hpp + * @brief TrackballCameraController class of the camera module for the vkcv framework. This class inherits from the base + * class @#CameraController and enables camera objects to be orbited around a specific center point. + */ #include "CameraController.hpp"