mirror of
https://github.com/JulianGro/overte.git
synced 2025-04-07 03:22:27 +02:00
Doc review
This commit is contained in:
David Rowe
parent
7087abd201
commit
748052614f
8 changed files with 24 additions and 24 deletions
|
|
@ -690,8 +690,8 @@ private:
|
|||
|
||||
/**jsdoc
|
||||
* <p>The <code>Controller.Hardware.Application</code> object has properties representing Interface's state. The property
|
||||
* values are integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be can be mapped to actions or
|
||||
* functions or <code>Controller.Standard</code> items in a {@link RouteObject} mapping. Each data value is either
|
||||
* values are integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be mapped to actions or functions or
|
||||
* <code>Controller.Standard</code> items in a {@link RouteObject} mapping. Each data value is either
|
||||
* <code>1.0</code> for "true" or <code>0.0</code> for "false".</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
|
|
|
|||
|
|
@ -299,10 +299,10 @@ public slots:
|
|||
virtual void setVPadHidden(bool hidden); // Call it when a window should hide it
|
||||
|
||||
/**jsdoc
|
||||
* Sets the amount of extra margins between the virtual game pad that is displayed on certain devices (e.g., Android) and
|
||||
* Sets the amount of extra margin between the virtual game pad that is displayed on certain devices (e.g., Android) and
|
||||
* the bottom of the display.
|
||||
* @function Controller.setVPadExtraBottomMargin
|
||||
* @param {number} margin - Integer number of pixels of extra margin.
|
||||
* @param {number} margin - Integer number of pixels in the extra margin.
|
||||
*/
|
||||
virtual void setVPadExtraBottomMargin(int margin);
|
||||
|
||||
|
|
|
|||
|
|
@ -191,23 +191,23 @@ namespace controller {
|
|||
* event.</td></tr>
|
||||
* <tr><td><code>UiNavGroup</code></td><td>number</td><td>number</td><td>Generate a keyboard tab or back-tab key event.
|
||||
* </td></tr>
|
||||
* <tr><td><code>UiNavSelect</code></td><td>number</td><td>number</td><td>Generate keyboard an Enter key event.
|
||||
* <tr><td><code>UiNavSelect</code></td><td>number</td><td>number</td><td>Generate a keyboard Enter key event.
|
||||
* </td></tr>
|
||||
* <tr><td><code>UiNavBack</code></td><td>number</td><td>number</td><td>Generate keyboard an Esc key event.</td></tr>
|
||||
* <tr><td><code>LeftHandClick</code></td><td>number</td><td>number</td><td><strong>Deprecated: </strong>: No action.
|
||||
* <tr><td><code>UiNavBack</code></td><td>number</td><td>number</td><td>Generate a keyboard Esc key event.</td></tr>
|
||||
* <tr><td><code>LeftHandClick</code></td><td>number</td><td>number</td><td><strong>Deprecated: </strong> No action.
|
||||
* </td></tr>
|
||||
* <tr><td><code>RightHandClick</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong>: No action.
|
||||
* <tr><td><code>RightHandClick</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong> No action.
|
||||
* </td></tr>
|
||||
* <tr><td><code>Shift</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong>: No action.</td></tr>
|
||||
* <tr><td><code>PrimaryAction</code></td><td>number</td><td>number</td><td><strong>Deprecated: </strong>: No action.
|
||||
* <tr><td><code>Shift</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong> No action.</td></tr>
|
||||
* <tr><td><code>PrimaryAction</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong> No action.
|
||||
* </td></tr>
|
||||
* <tr><td><code>SecondaryAction</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong>: No action.
|
||||
* <tr><td><code>SecondaryAction</code></td><td>number</td><td>number</td><td><strong>Deprecated:</strong> No action.
|
||||
* </td></tr>
|
||||
*
|
||||
* <tr><td colSpan=4><strong>Aliases</strong></td>
|
||||
* <tr><td><code>Backward</code></td><td>number</td><td>number</td><td>Alias for <code>TranslateZ</code> in the
|
||||
* positive direction.</td></tr>
|
||||
* <tr><td><code>Forward</code></td><td>number</td><td>number</td><td>Alias for <code>TranslateZ<code> in the negative
|
||||
* <tr><td><code>Forward</code></td><td>number</td><td>number</td><td>Alias for <code>TranslateZ</code> in the negative
|
||||
* direction.</td></tr>
|
||||
* <tr><td><code>StrafeRight</code></td><td>number</td><td>number</td><td>Alias for <code>TranslateX</code> in the
|
||||
* positive direction.</td></tr>
|
||||
|
|
@ -221,7 +221,7 @@ namespace controller {
|
|||
* direction.</td></tr>
|
||||
* <tr><td><code>PitchUp</code></td><td>number</td><td>number</td><td>Alias for <code>Pitch</code> in the negative
|
||||
* direction.</td></tr>
|
||||
* <tr><td><code>YawLeft</code></td><td>number</td><td>number</td><td>Alias of <code>Yaw</code> in the positive
|
||||
* <tr><td><code>YawLeft</code></td><td>number</td><td>number</td><td>Alias for <code>Yaw</code> in the positive
|
||||
* direction.</td></tr>
|
||||
* <tr><td><code>YawRight</code></td><td>number</td><td>number</td><td>Alias for <code>Yaw</code> in the negative
|
||||
* direction.</td></tr>
|
||||
|
|
|
|||
|
|
@ -477,7 +477,7 @@ namespace controller {
|
|||
|
||||
/**jsdoc
|
||||
* Enable processing of mouse "move", "press", "double-press", and "release" events into
|
||||
* {@link Controller.Hardware-Keyboard|Controller.Hardware.Keyboard} outputs that was disabled using
|
||||
* {@link Controller.Hardware-Keyboard|Controller.Hardware.Keyboard} outputs that were disabled using
|
||||
* {@link Controller.captureMouseEvents|captureMouseEvents}.
|
||||
* @function Controller.releaseMouseEvents
|
||||
*/
|
||||
|
|
@ -497,7 +497,7 @@ namespace controller {
|
|||
* Enable processing of touch "begin", "update", and "end" events into
|
||||
* {@link Controller.Hardware|Controller.Hardware.Keyboard},
|
||||
* {@link Controller.Hardware|Controller.Hardware.Touchscreen}, and
|
||||
* {@link Controller.Hardware|Controller.Hardware.TouchscreenVirtualPad} outputs that was disabled using
|
||||
* {@link Controller.Hardware|Controller.Hardware.TouchscreenVirtualPad} outputs that were disabled using
|
||||
* {@link Controller.captureTouchEvents|captureTouchEvents}.
|
||||
* @function Controller.releaseTouchEvents
|
||||
*/
|
||||
|
|
@ -513,7 +513,7 @@ namespace controller {
|
|||
|
||||
/**jsdoc
|
||||
* Enable processing of mouse wheel rotation events into {@link Controller.Hardware|Controller.Hardware.Keyboard}
|
||||
* outputs that was disabled using {@link Controller.captureWheelEvents|captureWheelEvents}.
|
||||
* outputs that wer disabled using {@link Controller.captureWheelEvents|captureWheelEvents}.
|
||||
* @function Controller.releaseWheelEvents
|
||||
*/
|
||||
virtual void releaseWheelEvents() { _wheelCaptured = false; }
|
||||
|
|
@ -534,7 +534,7 @@ namespace controller {
|
|||
virtual void captureActionEvents() { _actionsCaptured = true; }
|
||||
|
||||
/**jsdoc
|
||||
* Enable translating and rotating the user's avatar in response to keyboard and controller controls that was disabled
|
||||
* Enable translating and rotating the user's avatar in response to keyboard and controller controls that were disabled
|
||||
* using {@link Controller.captureActionEvents|captureActionEvents}.
|
||||
* @function Controller.releaseActionEvents
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ void StandardController::focusOutEvent() {
|
|||
/**jsdoc
|
||||
* <p>The <code>Controller.Standard</code> object has properties representing standard controller outputs. Those for physical
|
||||
* controllers are based on the XBox controller, with aliases for PlayStation. The property values are integer IDs, uniquely
|
||||
* identifying each output. <em>Read-only.</em> These can be can be mapped to actions or functions in a {@link RouteObject}
|
||||
* identifying each output. <em>Read-only.</em> These can be mapped to actions or functions in a {@link RouteObject}
|
||||
* mapping.</p>
|
||||
*
|
||||
* <p>The data value provided by each control is either a number or a {@link Pose}. Numbers are typically normalized to
|
||||
|
|
@ -64,7 +64,7 @@ void StandardController::focusOutEvent() {
|
|||
*
|
||||
* <tr><td colspan="4"><strong>Sticks</strong></td></tr>
|
||||
* <tr><td><code>LX</code></td><td>number</td><td>number</td><td>Left stick x-axis scale.</td></tr>
|
||||
* <tr><td><code>LY</code></td><td>number</td><td>number</td><td>left stick y-axis scale.</td></tr>
|
||||
* <tr><td><code>LY</code></td><td>number</td><td>number</td><td>Left stick y-axis scale.</td></tr>
|
||||
* <tr><td><code>RX</code></td><td>number</td><td>number</td><td>Right stick x-axis scale.</td></tr>
|
||||
* <tr><td><code>RY</code></td><td>number</td><td>number</td><td>Right stick y-axis scale.</td></tr>
|
||||
* <tr><td><code>LS</code></td><td>number</td><td>number</td><td>Left stick button pressed.</td></tr>
|
||||
|
|
|
|||
|
|
@ -218,9 +218,9 @@ controller::Input KeyboardMouseDevice::InputDevice::makeInput(KeyboardMouseDevic
|
|||
|
||||
/**jsdoc
|
||||
* <p>The <code>Controller.Hardware.Keyboard</code> object has properties representing keyboard, mouse, and display touch
|
||||
* events. The property values are integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be can be
|
||||
* mapped to actions or functions or <code>Controller.Standard</code> items in a {@link RouteObject} mapping. For presses,
|
||||
* each data value is either <code>1.0</code> for "true" or <code>0.0</code> for "false".</p>
|
||||
* events. The property values are integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be mapped to
|
||||
* actions or functions or <code>Controller.Standard</code> items in a {@link RouteObject} mapping. For presses, each data
|
||||
* value is either <code>1.0</code> for "true" or <code>0.0</code> for "false".</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
* <tr><th>Property</th><th>Type</th><td>Data</th><th>Description</th></tr>
|
||||
|
|
|
|||
|
|
@ -385,7 +385,7 @@ void OculusControllerManager::TouchDevice::stopHapticPulse(bool leftHand) {
|
|||
|
||||
/**jsdoc
|
||||
* <p>The <code>Controller.Hardware.OculusTouch</code> object has properties representing Oculus Rift. The property values are
|
||||
* integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be can be mapped to actions or functions or
|
||||
* integer IDs, uniquely identifying each output. <em>Read-only.</em> These can be mapped to actions or functions or
|
||||
* <code>Controller.Standard</code> items in a {@link RouteObject} mapping.</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
|
|
|
|||
|
|
@ -1234,7 +1234,7 @@ void ViveControllerManager::InputDevice::setConfigFromString(const QString& valu
|
|||
|
||||
/**jsdoc
|
||||
* <p>The <code>Controller.Hardware.Vive</code> object has properties representing Vive. The property values are integer IDs,
|
||||
* uniquely identifying each output. <em>Read-only.</em> These can be can be mapped to actions or functions or
|
||||
* uniquely identifying each output. <em>Read-only.</em> These can be mapped to actions or functions or
|
||||
* <code>Controller.Standard</code> items in a {@link RouteObject} mapping.</p>
|
||||
* <table>
|
||||
* <thead>
|
||||
|
|
|
|||
Loading…
Reference in a new issue