Showing the changes to interface/src/raypick/PickScriptingInterface.cpp (1 of 4 files). Show all
Unified · Split
| @@ -78,7 +78,7 @@ PickFilter getPickFilter(unsigned int filter) { · 77 unmodified lines | |||
| 78 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should | 78 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should |
| 79 | * start disabled. Disabled picks do not update their pick results. | 79 | * start disabled. Disabled picks do not update their pick results. |
| 80 | * @property {FilterFlags} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property | 80 | * @property {FilterFlags} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property |
| 81 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTTITIES</code>) combined with <code>|</code> (bitwise OR) operators. | 81 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTITIES</code>) combined with <code>|</code> (bitwise OR) operators. |
| 82 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> | 82 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> |
| 83 | * means no maximum. | 83 | * means no maximum. |
| 84 | * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. | 84 | * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. |
| @@ -164,7 +164,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildRayPick(const QVariantMa · 79 unmodified lines | |||
| 164 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should | 164 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should |
| 165 | * start disabled. Disabled picks do not update their pick results. | 165 | * start disabled. Disabled picks do not update their pick results. |
| 166 | * @property {number} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property | 166 | * @property {number} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property |
| 167 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTTITIES</code>) combined with <code>|</code> (bitwise OR) operators. | 167 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTITIES</code>) combined with <code>|</code> (bitwise OR) operators. |
| 168 | * <p><strong>Note:</strong> Stylus picks do not intersect avatars or the HUD.</p> | 168 | * <p><strong>Note:</strong> Stylus picks do not intersect avatars or the HUD.</p> |
| 169 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> | 169 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> |
| 170 | * means no maximum. | 170 | * means no maximum. |
| @@ -212,7 +212,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVarian · 41 unmodified lines | |||
| 212 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should | 212 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should |
| 213 | * start disabled. Disabled picks do not update their pick results. | 213 | * start disabled. Disabled picks do not update their pick results. |
| 214 | * @property {number} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property | 214 | * @property {number} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property |
| 215 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTTITIES</code>) combined with <code>|</code> (bitwise OR) operators. | 215 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTITIES</code>) combined with <code>|</code> (bitwise OR) operators. |
| 216 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> | 216 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> |
| 217 | * means no maximum. | 217 | * means no maximum. |
| 218 | * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. | 218 | * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. |
| @@ -321,7 +321,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildParabolaPick(const QVari · 102 unmodified lines | |||
| 321 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should | 321 | * @property {boolean} [enabled=false] - <code>true</code> if this pick should start enabled, <code>false</code> if it should |
| 322 | * start disabled. Disabled picks do not update their pick results. | 322 | * start disabled. Disabled picks do not update their pick results. |
| 323 | * @property {FilterFlags} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property | 323 | * @property {FilterFlags} [filter=0] - The filter for this pick to use. Construct using {@link Picks} FilterFlags property |
| 324 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTTITIES</code>) combined with <code>|</code> (bitwise OR) operators. | 324 | * values (e.g., <code>Picks.PICK_DOMAIN_ENTITIES</code>) combined with <code>|</code> (bitwise OR) operators. |
| 325 | * <p><strong>Note:</strong> Collision picks do not intersect the HUD.</p> | 325 | * <p><strong>Note:</strong> Collision picks do not intersect the HUD.</p> |
| 326 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> | 326 | * @property {number} [maxDistance=0.0] - The maximum distance at which this pick will intersect. A value of <code>0.0</code> |
| 327 | * means no maximum. | 327 | * means no maximum. |
| @@ -344,9 +344,11 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildParabolaPick(const QVari · 16 unmodified lines | |||
| 344 | * the collision region. The depth is in world coordinates but scales with the parent if defined. | 344 | * the collision region. The depth is in world coordinates but scales with the parent if defined. |
| 345 | * @property {CollisionMask} [collisionGroup=8] - The type of objects the collision region collides as. Objects whose collision | 345 | * @property {CollisionMask} [collisionGroup=8] - The type of objects the collision region collides as. Objects whose collision |
| 346 | * masks overlap with the region's collision group are considered to be colliding with the region. | 346 | * masks overlap with the region's collision group are considered to be colliding with the region. |
| 347 | * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A collision pick's type is {@link PickType.Collision}. | 347 | * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or |
| 348 | * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity). | 348 | * {@link Picks.getPickScriptParameters}. A collision pick's type is {@link PickType.Collision}. |
| 349 | * Its value is the original scale of the parent at the moment the pick was created, and is used to rescale the pick, and/or the pointer which owns this pick, if any. | 349 | * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale |
| 350 | * (usually an avatar or an entity). Its value is the original scale of the parent at the moment the pick was created, and | ||
| 351 | * is used to rescale the pick, and/or the pointer which owns this pick, if any. | ||
| 350 | */ | 352 | */ |
| 351 | std::shared_ptr<PickQuery> PickScriptingInterface::buildCollisionPick(const QVariantMap& propMap) { | 353 | std::shared_ptr<PickQuery> PickScriptingInterface::buildCollisionPick(const QVariantMap& propMap) { |
| 352 | bool enabled = false; | 354 | bool enabled = false; |