History

Update jsdocs to reflect new collision pick scaling behavior

sabrina-shanman committed 8 years ago

Commit 23a6abb1 parent 836f8102 files · +6 −6Browse files

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

Unified · Split

interface/src/raypick/PickScriptingInterface.cpp+3−3
@@ -265,11 +265,11 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti · 264 unmodified lines
265* @typedef {object} Picks.CollisionPickProperties265* @typedef {object} Picks.CollisionPickProperties
266* @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results.266* @property {boolean} [enabled=false] If this Pick should start enabled or not. Disabled Picks do not updated their pick results.
267* @property {number} [filter=Picks.PICK_NOTHING] The filter for this Pick to use, constructed using filter flags combined using bitwise OR.267* @property {number} [filter=Picks.PICK_NOTHING] The filter for this Pick to use, constructed using filter flags combined using bitwise OR.
268* @property {Shape} shape - The information about the collision region's size and shape. Dimensions are relative to a parent if defined.268* @property {Shape} shape - The information about the collision region's size and shape. Dimensions are in world space, but will scale with the parent if defined.
269* @property {Vec3} position - The position of the collision region, relative to a parent if defined.269* @property {Vec3} position - The position of the collision region, relative to a parent if defined.
270* @property {Quat} orientation - The orientation of the collision region, relative to a parent if defined.270* @property {Quat} orientation - The orientation of the collision region, relative to a parent if defined.
271* @property {float} threshold - The approximate minimum penetration depth for a test object to be considered in contact with the collision region, relative to a parent if defined.271* @property {float} threshold - The approximate minimum penetration depth for a test object to be considered in contact with the collision region.
272* For overlay and entity parents, this is relative to the parent's largest dimension.272* The depth is measured in world space, but will scale with the parent if defined.
273* @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or an overlay.273* @property {Uuid} parentID - The ID of the parent, either an avatar, an entity, or an overlay.
274* @property {number} parentJointIndex - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint)274* @property {number} parentJointIndex - The joint of the parent to parent to, for example, the joints on the model of an avatar. (default = 0, no joint)
275* @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.275* @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.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t