History

Fix not mentioning pick parenting in all pick parenting jsdocs for parentID

sabrina-shanman committed 8 years ago

Commit 7a89f951 parent 0cf7e951 file · +2 −2Browse files

Showing the changes to interface/src/raypick/PickScriptingInterface.cpp (1 of 1 file). Show all

Unified · Split

interface/src/raypick/PickScriptingInterface.cpp+2−2
@@ -147,7 +147,7 @@ unsigned int PickScriptingInterface::createStylusPick(const QVariant& properties · 146 unmodified lines
147 * @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results.147 * @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results.
148 * @property {number} [filter=Picks.PICK_NOTHING] The filter for this Pick to use, constructed using filter flags combined using bitwise OR.148 * @property {number} [filter=Picks.PICK_NOTHING] The filter for this Pick to use, constructed using filter flags combined using bitwise OR.
149 * @property {number} [maxDistance=0.0] The max distance at which this Pick will intersect. 0.0 = no max. < 0.0 is invalid.149 * @property {number} [maxDistance=0.0] The max distance at which this Pick will intersect. 0.0 = no max. < 0.0 is invalid.
150 * @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or an overlay.150 * @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, an overlay, or a pick.
151 * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint)151 * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint)
152 * @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar.152 * @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar.
153 * @property {Vec3} [posOffset=Vec3.ZERO] Only for Joint Parabola Picks. A local joint position offset, in meters. x = upward, y = forward, z = lateral153 * @property {Vec3} [posOffset=Vec3.ZERO] Only for Joint Parabola Picks. A local joint position offset, in meters. x = upward, y = forward, z = lateral
@@ -250,7 +250,7 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti · 96 unmodified lines
250* The depth is measured in world space, but will scale with the parent if defined.250* The depth is measured in world space, but will scale with the parent if defined.
251* @property {CollisionMask} [collisionGroup=8] - The type of object this collision pick collides as. Objects whose collision masks overlap with the pick's collision group251* @property {CollisionMask} [collisionGroup=8] - The type of object this collision pick collides as. Objects whose collision masks overlap with the pick's collision group
252* will be considered colliding with the pick.252* will be considered colliding with the pick.
253* @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or an overlay.253* @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, an overlay, or a pick.
254* @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint)254* @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint)
255* @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar.255* @property {string} joint - If "Mouse," parents the pick to the mouse. If "Avatar," parents the pick to MyAvatar's head. Otherwise, parents to the joint of the given name on MyAvatar.
256* @property {boolean} [scaleWithParent=true] If true, the collision pick's dimensions and threshold will adjust according to the scale of the parent.256* @property {boolean} [scaleWithParent=true] If true, the collision pick's dimensions and threshold will adjust according to the scale of the parent.