Showing the changes to interface/src/Application.cpp (1 of 20 files). Show all
Unified · Split
| @@ -688,6 +688,34 @@ private: · 687 unmodified lines | ||
| 688 | 688 | } |
| 689 | 689 | }; |
| 690 | 690 | |
| 691 | +/**jsdoc | |
| 692 | + * <p>The <code>Controller.Hardware.Application</code> object has properties representing Interface's state. The property | |
| 693 | + * values are integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be mapped to actions or functions or | |
| 694 | + * <code>Controller.Standard</code> items in a {@link RouteObject} mapping (e.g., using the {@link RouteObject#when} method). | |
| 695 | + * Each data value is either <code>1.0</code> for "true" or <code>0.0</code> for "false".</p> | |
| 696 | + * <table> | |
| 697 | + * <thead> | |
| 698 | + * <tr><th>Property</th><th>Type</th><th>Data</th><th>Description</th></tr> | |
| 699 | + * </thead> | |
| 700 | + * <tbody> | |
| 701 | + * <tr><td><code>CameraFirstPerson</code></td><td>number</td><td>number</td><td>The camera is in first-person mode. | |
| 702 | + * </td></tr> | |
| 703 | + * <tr><td><code>CameraThirdPerson</code></td><td>number</td><td>number</td><td>The camera is in third-person mode. | |
| 704 | + * </td></tr> | |
| 705 | + * <tr><td><code>CameraFSM</code></td><td>number</td><td>number</td><td>The camera is in full screen mirror mode.</td></tr> | |
| 706 | + * <tr><td><code>CameraIndependent</code></td><td>number</td><td>number</td><td>The camera is in independent mode.</td></tr> | |
| 707 | + * <tr><td><code>CameraEntity</code></td><td>number</td><td>number</td><td>The camera is in entity mode.</td></tr> | |
| 708 | + * <tr><td><code>InHMD</code></td><td>number</td><td>number</td><td>The user is in HMD mode.</td></tr> | |
| 709 | + * <tr><td><code>AdvancedMovement</code></td><td>number</td><td>number</td><td>Advanced movement controls are enabled. | |
| 710 | + * </td></tr> | |
| 711 | + * <tr><td><code>SnapTurn</code></td><td>number</td><td>number</td><td>Snap turn is enabled.</td></tr> | |
| 712 | + * <tr><td><code>Grounded</code></td><td>number</td><td>number</td><td>The user's avatar is on the ground.</td></tr> | |
| 713 | + * <tr><td><code>NavigationFocused</code></td><td>number</td><td>number</td><td><em>Not used.</em></td></tr> | |
| 714 | + * </tbody> | |
| 715 | + * </table> | |
| 716 | + * @typedef Controller.Hardware-Application | |
| 717 | + */ | |
| 718 | + | |
| 691 | 719 | static const QString STATE_IN_HMD = "InHMD"; |
| 692 | 720 | static const QString STATE_CAMERA_FULL_SCREEN_MIRROR = "CameraFSM"; |
| 693 | 721 | static const QString STATE_CAMERA_FIRST_PERSON = "CameraFirstPerson"; |