Showing the changes to interface/src/raypick/PickScriptingInterface.cpp (1 of 2 files). Show all
Unified · Split
| @@ -263,9 +263,16 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti · 262 unmodified lines | ||
| 263 | 263 | * A set of properties that can be passed to {@link Picks.createPick} to create a new Collision Pick. |
| 264 | 264 | |
| 265 | 265 | * @typedef {object} Picks.CollisionPickProperties |
| 266 | −* @property {Shape} shape - The information about the collision region's size and shape. | |
| 267 | −* @property {Vec3} position - The position of the collision region. | |
| 268 | −* @property {Quat} orientation - The orientation of the collision region. | |
| 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. | |
| 268 | +* @property {Shape} shape - The information about the collision region's size and shape. Dimensions are 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. | |
| 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. | |
| 272 | +* For overlay and entity parents, this is relative to the parent's largest dimension. | |
| 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) | |
| 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. | |
| 269 | 276 | */ |
| 270 | 277 | unsigned int PickScriptingInterface::createCollisionPick(const QVariant& properties) { |
| 271 | 278 | QVariantMap propMap = properties.toMap(); |