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/PointerScriptingInterface.cpp (1 of 2 files). Show all

Unified · Split

interface/src/raypick/PointerScriptingInterface.cpp+3−3
@@ -89,7 +89,7 @@ QVariantMap PointerScriptingInterface::getPointerScriptParameters(unsigned int u · 88 unmodified lines
8989 * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties.
9090 * @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events,
9191 * <code>false</code> if it doesn't.
92− * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties}. A stylus pointer's type is {@link PickType.Stylus}.
92+ * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A stylus pointer's type is {@link PickType.Stylus}.
9393 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
9494 * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.
9595 */
@@ -208,7 +208,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant& · 112 unmodified lines
208208 * <code>false</code> if it doesn't.
209209 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
210210 * events on the entity or overlay currently intersected.
211− * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties}. A laser pointer's type is {@link PickType.Ray}.
211+ * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A laser pointer's type is {@link PickType.Ray}.
212212 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
213213 * @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.
214214 */
@@ -401,7 +401,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar · 186 unmodified lines
401401 * <code>false</code> if it doesn't.
402402 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
403403 * events on the entity or overlay currently intersected.
404− * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties}. A parabola pointer's type is {@link PickType.Parabola}.
404+ * @property {PickType} pointerType - The type of pointer when getting these properties from {@link Pointers.getPointerProperties} or {@link Pointers.getPointerScriptParameters}. A parabola pointer's type is {@link PickType.Parabola}.
405405 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
406406 * @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.
407407 */