History

Be explicit about pickType/pointerType being returned when getting script parameters

sabrina-shanman committed 7 years ago

Commit 66dbb081 parent 39852612 files · +7 −7Browse files

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

Unified · Split

interface/src/raypick/PickScriptingInterface.cpp+4−4
@@ -99,7 +99,7 @@ PickFilter getPickFilter(unsigned int filter) { · 98 unmodified lines
9999 * @property {Vec3} [dirOffset] - Synonym for <code>direction</code>.
100100 * @property {Quat} [orientation] - Alternative property for specifying <code>direction</code>. The value is applied to the
101101 * default <code>direction</code> value.
102− * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties}. A ray pick's type is {@link PickType.Ray}.
102+ * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A ray pick's type is {@link PickType.Ray}.
103103 * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity).
104104 * Its value is the original scale of the parent at the moment the pick was created, and is used to scale the pointer which owns this pick, if any.
105105 */
@@ -170,7 +170,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildRayPick(const QVariantMa · 64 unmodified lines
170170 * means no maximum.
171171 * @property {Vec3} [tipOffset=0,0.095,0] - The position of the stylus tip relative to the hand position at default avatar
172172 * scale.
173− * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties}. A stylus pick's type is {@link PickType.Stylus}.
173+ * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A stylus pick's type is {@link PickType.Stylus}.
174174 */
175175 std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVariantMap& propMap) {
176176 bilateral::Side side = bilateral::Side::Invalid;
@@ -245,7 +245,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildStylusPick(const QVarian · 68 unmodified lines
245245 * with the avatar or other parent.
246246 * @property {boolean} [scaleWithAvatar=true] - Synonym for <code>scalewithParent</code>.
247247 * <p class="important">Deprecated: This property is deprecated and will be removed.</p>
248− * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties}. A parabola pick's type is {@link PickType.Parabola}.
248+ * @property {PickType} pickType - The type of pick when getting these properties from {@link Picks.getPickProperties} or {@link Picks.getPickScriptParameters}. A parabola pick's type is {@link PickType.Parabola}.
249249 * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity).
250250 * 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.
251251 */
@@ -344,7 +344,7 @@ std::shared_ptr<PickQuery> PickScriptingInterface::buildParabolaPick(const QVari · 92 unmodified lines
344344 * the collision region. The depth is in world coordinates but scales with the parent if defined.
345345 * @property {CollisionMask} [collisionGroup=8] - The type of objects the collision region collides as. Objects whose collision
346346 * 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}. 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 {@link Picks.getPickScriptParameters}. A collision pick's type is {@link PickType.Collision}.
348348 * @property {Vec3} baseScale - Returned from {@link Picks.getPickProperties} when the pick has a parent with varying scale (usually an avatar or an entity).
349349 * 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.
350350 */