Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-25 16:55:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc review.

Browse source
This commit is contained in:
David Rowe 2019-07-04 20:02:42 +12:00
parent 5c29eb04b3
commit 8fb83e98be
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
interface/src/raypick/PointerScriptingInterface.cpp
View file

@ -140,8 +140,8 @@ unsigned int PointerScriptingInterface::createStylus(const QVariant& properties)
* @property {boolean} [faceAvatar=false] - <code>true</code> if the overlay rendered at the end of the ray rotates about the
* world y-axis to always face the avatar; <code>false</code> if it maintains its world orientation.
* @property {boolean} [centerEndY=true] - <code>true</code> if the overlay rendered at the end of the ray is centered on
* the ray end; <code>false</code> if the overlay is rendered adjacent to the surface if <code>followNormal</code> is
* <code>true</code> or on top of the ray end if if <code>followNormal</code> is <code>false</code>.
* the ray end; <code>false</code> if the overlay is positioned against the surface if <code>followNormal</code> is
* <code>true</code>, or above the ray end if <code>followNormal</code> is <code>false</code>.
* @property {boolean} [lockEnd=false] - <code>true</code> if the end of the ray is locked to the center of the object at
* which the ray is pointing; <code>false</code> if the end of the ray is at the intersected surface.
* @property {boolean} [distanceScaleEnd=false] - <code>true</code> if the dimensions of the overlay at the end of the ray
@ -331,8 +331,8 @@ unsigned int PointerScriptingInterface::createLaserPointer(const QVariant& prope
* @property {boolean} [faceAvatar=false] - <code>true</code> if the overlay rendered at the end of the ray rotates about the
* world y-axis to always face the avatar; <code>false</code> if it maintains its world orientation.
* @property {boolean} [centerEndY=true] - <code>true</code> if the overlay rendered at the end of the ray is centered on
* the ray end; <code>false</code> if the overlay is rendered adjacent to the surface if <code>followNormal</code> is
* <code>true</code> or on top of the ray end if if <code>followNormal</code> is <code>false</code>.
* the ray end; <code>false</code> if the overlay is positioned against the surface if <code>followNormal</code> is
* <code>true</code>, or above the ray end if <code>followNormal</code> is <code>false</code>.
* @property {boolean} [lockEnd=false] - <code>true</code> if the end of the ray is locked to the center of the object at
* which the ray is pointing; <code>false</code> if the end of the ray is at the intersected surface.
* @property {boolean} [distanceScaleEnd=false] - <code>true</code> if the dimensions of the overlay at the end of the ray

4
interface/src/raypick/PointerScriptingInterface.h
View file

@ -41,8 +41,8 @@ public:
* pointer.
* @typedef {object} Pointers.Trigger
* @property {Controller.Standard|Controller.Actions|function} action - The controller output or function that triggers the
* events on the entity or overlay. If a function, it must return a number <code>>= 1.0</code> to start the action and
* <code>< 1.0</code> to terminate the action.
* events on the entity or overlay. If a function, it must return a number <code>&gt;= 1.0</code> to start the action
* and <code>&lt; 1.0</code> to terminate the action.
* @property {string} button - Which button to trigger.
* <ul>
* <li><code>"Primary"</code>, <code>"Secondary"</code>, and <code>"Tertiary"</code> cause {@link Entities} and