Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
VkCV Framework
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Vulkan2021
VkCV Framework
Commits
5fafcefe
Commit
5fafcefe
authored
3 years ago
by
Vanessa Karolek
Browse files
Options
Downloads
Patches
Plain Diff
[
#42
][Doc] add missing documentation, remove solved TODOs
parent
3a416824
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!35
Resolve "Kamera - Trackballkamera"
Pipeline
#25705
passed
3 years ago
Stage: build
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
modules/camera/include/vkcv/camera/CameraManager.hpp
+40
-11
40 additions, 11 deletions
modules/camera/include/vkcv/camera/CameraManager.hpp
with
40 additions
and
11 deletions
modules/camera/include/vkcv/camera/CameraManager.hpp
+
40
−
11
View file @
5fafcefe
...
...
@@ -105,39 +105,68 @@ namespace vkcv {
~
CameraManager
();
/**
* @brief Adds a new camera object to the #CameraManager.
* @brief Adds a new camera object to the #CameraManager.
The camera is not binded to a controller type.
* @return The index of the newly created camera object.
*/
int
addCamera
();
// TODO: Add docu!
/**
* @brief Adds a new camera object to the #CameraManager and binds it to a camera controller object of specified
* @p controllerType.
* @param controllerType The type of the camera controller
* @return The index of the newly created camera object.
*/
int
addCamera
(
ControllerType
controllerType
);
/**
* @brief Gets the stored camera object located at @p cameraIndex.
* @param cameraIndex The
index of the stored
camera
object
.
* @param cameraIndex The camera
index
.
* @return The camera object at @p cameraIndex.
* @throws std::runtime_error If @p cameraIndex is not a valid camera index.
*/
Camera
&
getCamera
(
uint32_t
cameraIndex
);
// TODO: Add docu!
/**
* @brief Gets the stored camera object set as the active camera.
* @return The active camera.
*/
Camera
&
getActiveCamera
();
// TODO: Add docu!
/**
* @brief Sets the stored camera object located at @p cameraIndex as the active camera.
* @param cameraIndex The camera index.
* @throws std::runtime_error If @p cameraIndex is not a valid camera index.
*/
void
setActiveCamera
(
uint32_t
cameraIndex
);
// TODO: Add docu!
/**
* @brief Gets the index of the stored active camera object.
* @return The active camera index.
*/
uint32_t
getActiveCameraIndex
();
// TODO: Add docu!
/**
* @brief Binds a stored camera object located at @p cameraIndex to a camera controller of specified
* @p controllerType.
* @param cameraIndex The camera index.
* @param controllerType The type of the camera controller.
* @throws std::runtime_error If @p cameraIndex is not a valid camera index.
*/
void
setControllerType
(
uint32_t
cameraIndex
,
ControllerType
controllerType
);
// TODO: Add docu!
/**
* @brief Gets the currently bound camera controller type of the stored camera object located at @p cameraIndex.
* @param cameraIndex The camera index.
* @return The type of the camera controller of the specified camera object.
* @throws std::runtime_error If @p cameraIndex is not a valid camera index.
*/
ControllerType
getControllerType
(
uint32_t
cameraIndex
);
// TODO: Add docu!
/**
* @brief Gets a camera controller object of specified @p controllerType.
* @param controllerType The type of the camera controller.
* @return The specified camera controller object.
*/
CameraController
&
getControllerByType
(
ControllerType
controllerType
);
/**
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment