Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-06 18:23:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc review

Browse source
This commit is contained in:
David Rowe 2019-10-08 21:15:16 +13:00
parent f224832d27
commit 1106d8fdfa
4 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
interface/src/ui/overlays/Overlays.cpp
View file

@ -1934,7 +1934,7 @@ QVector<QUuid> Overlays::findOverlays(const glm::vec3& center, float radius) {
* start point.</p>
* @property {Vec3} end - The end point of the line. Synonyms: <code>endPoint</code> and <code>p2</code>.
* <p><strong>Note:</strong> If <code>parentID</code> is set, use <code>localEnd</code> to set the local position of the
* end point.</em></p>
* end point.</p>
* @property {Vec3} localStart - The local position of the overlay relative to its parent if the overlay has a
* <code>parentID</code> set, otherwise the same value as <code>start</code>.

2
libraries/animation/src/AnimInverseKinematics.h
View file

@ -75,7 +75,7 @@ public:
* close to the previous solution, but still provides the benefits of avoiding limb locking.</td></tr>
* <tr><td><code>2</code></td><td>PreviousSolution</td><td>
* <p>The IK system will begin to solve from the same position and orientations for each joint that was the result
* from the previous frame.<p>
* from the previous frame.</p>
* <p>Pros: As the end effectors typically do not move much from frame to frame, this is likely to converge quickly
* to a valid solution.</p>
* <p>Cons: If the previous solution resulted in an awkward or uncomfortable posture, the next frame will also be

12
libraries/controllers/src/controllers/Actions.cpp
View file

@ -44,7 +44,7 @@ namespace controller {
* <tr><th>Property</th><th>Type</th><th>Data</th><th>Description</th></tr>
* </thead>
* <tbody>
* <tr><td colSpan=4><strong>Avatar Movement</strong></td>
* <tr><td colSpan=4><strong>Avatar Movement</strong></td></tr>
* <tr><td><code>TranslateX</code></td><td>number</td><td>number</td><td>Move the user's avatar in the direction of its
* x-axis, if the camera isn't in independent or mirror modes.</td></tr>
* <tr><td><code>TranslateY</code></td><td>number</td><td>number</td><td>Move the user's avatar in the direction of its
@ -71,7 +71,7 @@ namespace controller {
* step increment, if the camera isn't in independent or mirror modes.</td></tr>
* <tr><td><code>StepRoll</code></td><td>number</td><td>number</td><td>No action.</td></tr>
*
* <tr><td colSpan=4><strong>Avatar Skeleton</strong></td>
* <tr><td colSpan=4><strong>Avatar Skeleton</strong></td></tr>
* <tr><td><code>Hips</code></td><td>number</td><td>{@link Pose}</td><td>Set the hips pose of the user's avatar.
* </td></tr>
* <tr><td><code>Spine2</code></td><td>number</td><td>{@link Pose}</td><td>Set the spine2 pose of the user's avatar.
@ -171,7 +171,7 @@ namespace controller {
* <tr><td><code>RightFoot</code></td><td>number</td><td>{@link Pose}</td><td>Set the right foot pose of the user's
* avatar.</td></tr>
*
* <tr><td colSpan=4><strong>Application</strong></td>
* <tr><td colSpan=4><strong>Application</strong></td></tr>
* <tr><td><code>BoomIn</code></td><td>number</td><td>number</td><td>Zoom camera in from third person toward first
* person view.</td></tr>
* <tr><td><code>BoomOut</code></td><td>number</td><td>number</td><td>Zoom camera out from first person to third
@ -212,7 +212,7 @@ namespace controller {
* <tr><td><code>SecondaryAction</code></td><td>number</td><td>number</td><td><span class="important">Deprecated: This
* action is deprecated and will be removed. It takes no action.</span></td></tr>
*
* <tr><td colSpan=4><strong>Aliases</strong></td>
* <tr><td colSpan=4><strong>Aliases</strong></td></tr>
* <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
@ -234,7 +234,7 @@ namespace controller {
* <tr><td><code>YawRight</code></td><td>number</td><td>number</td><td>Alias for <code>Yaw</code> in the negative
* direction.</td></tr>
*
* <tr><td colSpan=4><strong>Deprecated Aliases</strong></td>
* <tr><td colSpan=4><strong>Deprecated Aliases</strong></td></tr>
* <tr><td><code>LEFT_HAND</code></td><td>number</td><td>{@link Pose}</td><td><span class="important">Deprecated: This
* action is deprecated and will be removed. Use <code>LeftHand</code> instead.</span></td></tr>
* <tr><td><code>RIGHT_HAND</code></td><td>number</td><td>{@link Pose}</td><td><span class="important">Deprecated: This
@ -282,7 +282,7 @@ namespace controller {
* <tr><td><code>ACTION2</code></td><td>number</td><td>number</td><td><span class="important">Deprecated: This
* action is deprecated and will be removed. Use <code>SecondaryAction</code> instead.</span></td></tr>
*
* <tr><td colSpan=4><strong>Deprecated Trackers</strong></td>
* <tr><td colSpan=4><strong>Deprecated Trackers</strong></td><tr>
* <tr><td><code>TrackedObject00</code></td><td>number</td><td>{@link Pose}</td><td><span class="important">Deprecated:
* This action is deprecated and will be removed. It takes no action.</span></td></tr>
* <tr><td><code>TrackedObject01</code></td><td>number</td><td>{@link Pose}</td><td><span class="important">Deprecated:

2
libraries/midi/src/Midi.h
View file

@ -23,7 +23,7 @@
/**jsdoc
* The <code>Midi</code> API provides the ability to connect Interface with musical instruments and other external or virtual
* devices via the MIDI protocol. For further information and examples, see the tutorial:
* <a href="https://docs.highfidelity.com/en/rc81/script/midi-tutorial.html">Use MIDI to Control Your Environment</a>.
* <a href="https://docs.highfidelity.com/script/midi-tutorial.html">Use MIDI to Control Your Environment</a>.
*
* <p><strong>Note:</strong> Only works on Windows.</p>
*