This commit is contained in:
David Rowe 2019-05-09 08:33:37 +12:00
parent 65f9099ea5
commit c3730e41f7
6 changed files with 12 additions and 12 deletions

View file

@ -50,7 +50,7 @@ public:
* @property {boolean} intersects - <code>true</code> if there's a valid intersection, <code>false</code> if there isn't.
* @property {Uuid} objectID - The ID of the intersected object. <code>null</code> for HUD or invalid intersections.
* @property {number} distance - The distance from the parabola origin to the intersection point in a straight line.
* @property {number} parabolicDistance - The distance from the parabola origin to the intersection point along the arc of
* @property {number} parabolicDistance - The distance from the parabola origin to the intersection point along the arc of
* the parabola.
* @property {Vec3} intersection - The intersection point in world coordinates.
* @property {Vec3} surfaceNormal - The surface normal at the intersected point. All <code>NaN</code>s if <code>type ==

View file

@ -64,12 +64,12 @@ PickFilter getPickFilter(unsigned int filter) {
* values (e.g., <code>Picks.PICK_DOMAIN_ENTTITIES</code>) combined with <code>|</code> (bitwise OR) operators.
* @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code>
* means no maximum.
* @property {Uuid} [parentID] - The ID of the parent: either an avatar, an entity, or another pick.
* @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick.
* @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint.
* A value of <code>0</code> means no joint.<br />
* <em>Used only if <code>parentID</code> is specified.</em>
* @property {string} [joint] - <code>"Mouse"</code> parents the pick to the mouse; <code>"Avatar"</code> parents the pick to
* the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise the pick is "static", not
* the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not
* parented to anything.<br />
* <em>Used only if <code>parentID</code> is not specified.</em>
* @property {Vec3} [position=Vec3.ZERO] - The offset of the ray origin from its parent if parented, otherwise the ray origin
@ -198,12 +198,12 @@ unsigned int PickScriptingInterface::createStylusPick(const QVariant& properties
* values (e.g., <code>Picks.PICK_DOMAIN_ENTTITIES</code>) combined with <code>|</code> (bitwise OR) operators.
* @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code>
* means no maximum.
* @property {Uuid} [parentID] - The ID of the parent: either an avatar, an entity, or another pick.
* @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick.
* @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint.
* A value of <code>0</code> means no joint.<br />
* <em>Used only if <code>parentID</code> is specified.</em>
* @property {string} [joint] - <code>"Mouse"</code> parents the pick to the mouse; <code>"Avatar"</code> parents the pick to
* the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise the pick is "static", not
* the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not
* parented to anything.
* <em>Used only if <code>parentID</code> is not specified.</em>
* @property {Vec3} [position=Vec3.ZERO] - The offset of the parabola origin from its parent if parented, otherwise the
@ -307,12 +307,12 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti
* <p><strong>Note:</strong> Collision picks do not intersect the HUD.</p>
* @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code>
* means no maximum.
* @property {Uuid} [parentID] - The ID of the parent: either an avatar, an entity, or another pick.
* @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick.
* @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint.
* A value of <code>0</code> means no joint.<br />
* <em>Used only if <code>parentID</code> is specified.</em>
* @property {string} [joint] - <code>"Mouse"</code> parents the pick to the mouse; <code>"Avatar"</code> parents the pick to
* the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise the pick is "static", not
* the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not
* parented to anything.<br />
* <em>Used only if <code>parentID</code> is not specified.</em>
* @property {boolean} [scaleWithParent=true] - <code>true</code> to scale the pick's dimensions and threshold according to the

View file

@ -109,7 +109,7 @@ public:
* Creates a new pick. Different {@link PickType}s use different properties, and within one PickType the properties you
* choose can lead to a wide range of behaviors. For example, with <code>PickType.Ray</code>, the properties could
* configure a mouse ray pick, an avatar head ray pick, or a joint ray pick.
* <p><strong>Warning:</strong> Picks created with this method currently always intersect at least visible and collidable
* <p><strong>Warning:</strong> Picks created using this method currently always intersect at least visible and collidable
* things but this may not always be the case.</p>
* @function Picks.createPick
* @param {PickType} type - The type of picking to use.
@ -121,7 +121,7 @@ public:
Q_INVOKABLE unsigned int createPick(const PickQuery::PickType type, const QVariant& properties);
/**jsdoc
* Enables a pick. enabled picks update their pick results.
* Enables a pick. Enabled picks update their pick results.
* @function Picks.enablePick
* @param {number} id - The ID of the pick.
*/

View file

@ -67,7 +67,7 @@ public:
/**jsdoc
* Creates a new ray pick.
* <p><strong>Warning:</strong> Picks created with this method currently always intersect at least visible and collidable
* <p><strong>Warning:</strong> Picks created using this method currently always intersect at least visible and collidable
* things but this may not always be the case.</p>
* @function RayPick.createRayPick
* @param {Picks.RayPickProperties} properties - Properties of the pick.

View file

@ -19,7 +19,7 @@ public:
* individual flag values.</p>
* <table>
* <thead>
* <tr><th>Flag name</th><th>Value</th><th>Description</th></tr>
* <tr><th>Flag Name</th><th>Value</th><th>Description</th></tr>
* </thead>
* <tbody>
* <tr><td>PICK_DOMAIN_ENTITIES</td><td><code>1</code></td><td>Include domain entities when intersecting.</td></tr>

View file

@ -296,7 +296,7 @@ void pickRayFromScriptValue(const QScriptValue& object, PickRay& pickRay);
* @typedef {object} StylusTip
* @property {number} side - The hand that the stylus is attached to: <code>0</code> for left hand, <code>1</code> for the
* right hand, <code>-1</code> for invalid.
* @property {Vec3} tipOffset - The position of the stylus tip relative to the body of the stylus.
* @property {Vec3} tipOffset - The position of the stylus tip relative to the body of the stylus.
* @property {Vec3} position - The position of the stylus tip.
* @property {Quat} orientation - The orientation of the stylus.
* @property {Vec3} velocity - The velocity of the stylus tip.