diff --git a/libraries/shared/src/shared/Camera.cpp b/libraries/shared/src/shared/Camera.cpp index ced50f7760..76e5e770bb 100644 --- a/libraries/shared/src/shared/Camera.cpp +++ b/libraries/shared/src/shared/Camera.cpp @@ -10,6 +10,52 @@ #include "Camera.h" +/**jsdoc + *
Camera modes affect the position of the camera and the controls for camera movement. The camera can be in one of the + * following modes:
+ *Mode | + *String | + *Description | + *
---|---|---|
First Person | + *"first person" |
+ * The camera is positioned such that you have the same view as your avatar. The camera moves and rotates with your + * avatar. | + *
Third Person | + *"third person" |
+ * The camera is positioned such that you have a view from just behind your avatar. The camera moves and rotates with + * your avatar. | + *
Mirror | + *"mirror" |
+ * The camera is positioned such that you are looking directly at your avatar. The camera moves and rotates with your + * avatar. | + *
Independent | + *"independent" |
+ * The camera's position and orientation don't change with your avatar movement. Instead, they can be set via + * scripting. | + *
Entity | + *"entity" |
+ * The camera's position and orientation are set to be the same as a specified entity's, and move with the entity as + ( it moves. + * |
Camera modes affect the position of the camera and the controls for camera movement. The camera can be in one of the - * following modes:
- * - *Mode | - *String | - *Description | - *
---|---|---|
First Person | - *"first person" |
- * The camera is positioned such that you have the same view as your avatar. The camera moves and rotates with - * your avatar. | - *
Third Person | - *"third person" |
- * The camera is positioned such that you have a view from just behind your avatar. The camera moves and rotates - * with your avatar. | - *
Mirror | - *"mirror" |
- * The camera is positioned such that you are looking directly at your avatar. The camera moves and rotates with - * your avatar. | - *
Independent | - *"independent" |
- * The camera's position and orientation don't change with your avatar movement. Instead, they can be set via - * scripting. | - *
Entity | - *"entity" |
- * The camera's position and orientation are set to be the same as a specified entity's, and move with the entity - * as it moves. - * |
The camera mode can be changed using Camera.mode
and {@link Camera.setModeString}, and Interface's "View"
- * menu.
Camera.mode
property.
* @function Camera.getModeString
- * @returns {string} The current camera mode.
+ * @returns {Camera.Mode} The current camera mode.
*/
QString getModeString() const;
/**jsdoc
* Set the camera mode. You can also set the mode using the Camera.mode
property.
* @function Camera.setModeString
- * @param {string} mode - The mode to set the camera to.
+ * @param {Camera.Mode} mode - The mode to set the camera to.
*/
void setModeString(const QString& mode);