diff --git a/interface/src/raypick/ParabolaPick.h b/interface/src/raypick/ParabolaPick.h index 78c35e13b4..1175b2b246 100644 --- a/interface/src/raypick/ParabolaPick.h +++ b/interface/src/raypick/ParabolaPick.h @@ -50,7 +50,7 @@ public: * @property {boolean} intersects - true if there's a valid intersection, false if there isn't. * @property {Uuid} objectID - The ID of the intersected object. null 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 NaNs if type == diff --git a/interface/src/raypick/PickScriptingInterface.cpp b/interface/src/raypick/PickScriptingInterface.cpp index 7e87ac22a7..dff68f3ded 100644 --- a/interface/src/raypick/PickScriptingInterface.cpp +++ b/interface/src/raypick/PickScriptingInterface.cpp @@ -64,12 +64,12 @@ PickFilter getPickFilter(unsigned int filter) { * values (e.g., Picks.PICK_DOMAIN_ENTTITIES) combined with | (bitwise OR) operators. * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 * 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 0 means no joint.
* Used only if parentID is specified. * @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" 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.
* Used only if parentID is not specified. * @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., Picks.PICK_DOMAIN_ENTTITIES) combined with | (bitwise OR) operators. * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 * 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 0 means no joint.
* Used only if parentID is specified. * @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" 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. * Used only if parentID is not specified. * @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 *

Note: Collision picks do not intersect the HUD.

* @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of 0.0 * 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 0 means no joint.
* Used only if parentID is specified. * @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" 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.
* Used only if parentID is not specified. * @property {boolean} [scaleWithParent=true] - true to scale the pick's dimensions and threshold according to the diff --git a/interface/src/raypick/PickScriptingInterface.h b/interface/src/raypick/PickScriptingInterface.h index b85249b599..1cbdaa92f7 100644 --- a/interface/src/raypick/PickScriptingInterface.h +++ b/interface/src/raypick/PickScriptingInterface.h @@ -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 PickType.Ray, the properties could * configure a mouse ray pick, an avatar head ray pick, or a joint ray pick. - *

Warning: Picks created with this method currently always intersect at least visible and collidable + *

Warning: Picks created using this method currently always intersect at least visible and collidable * things but this may not always be the case.

* @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. */ diff --git a/interface/src/raypick/RayPickScriptingInterface.h b/interface/src/raypick/RayPickScriptingInterface.h index a38e953824..32a2ec4a5d 100644 --- a/interface/src/raypick/RayPickScriptingInterface.h +++ b/interface/src/raypick/RayPickScriptingInterface.h @@ -67,7 +67,7 @@ public: /**jsdoc * Creates a new ray pick. - *

Warning: Picks created with this method currently always intersect at least visible and collidable + *

Warning: Picks created using this method currently always intersect at least visible and collidable * things but this may not always be the case.

* @function RayPick.createRayPick * @param {Picks.RayPickProperties} properties - Properties of the pick. diff --git a/libraries/shared/src/PickFilter.h b/libraries/shared/src/PickFilter.h index 8c1c4f56f6..9b7f763e6a 100644 --- a/libraries/shared/src/PickFilter.h +++ b/libraries/shared/src/PickFilter.h @@ -19,7 +19,7 @@ public: * individual flag values.

* * - * + * * * * diff --git a/libraries/shared/src/RegisteredMetaTypes.h b/libraries/shared/src/RegisteredMetaTypes.h index ef2d775eec..25a1792fe2 100644 --- a/libraries/shared/src/RegisteredMetaTypes.h +++ b/libraries/shared/src/RegisteredMetaTypes.h @@ -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: 0 for left hand, 1 for the * right hand, -1 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.
Flag nameValueDescription
Flag NameValueDescription
PICK_DOMAIN_ENTITIES1Include domain entities when intersecting.