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
89 * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties.89 * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties.
90 * @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events, 90 * @property {boolean} [hover=false] - <code>true</code> if the pointer generates {@link Entities} hover events,
91 * <code>false</code> if it doesn't.91 * <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}.
93 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.93 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
94 * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.94 * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick.
95 */95 */
@@ -208,7 +208,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildStylus(const QVariant& · 112 unmodified lines
208 * <code>false</code> if it doesn't.208 * <code>false</code> if it doesn't.
209 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger 209 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
210 * events on the entity or overlay currently intersected.210 * 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}.
212 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.212 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
213 * @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.213 * @see {@link Picks.RayPickProperties} for additional properties from the underlying ray pick.
214 */214 */
@@ -401,7 +401,7 @@ std::shared_ptr<Pointer> PointerScriptingInterface::buildLaserPointer(const QVar · 186 unmodified lines
401 * <code>false</code> if it doesn't.401 * <code>false</code> if it doesn't.
402 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger402 * @property {Pointers.Trigger[]} [triggers=[]] - A list of ways that a {@link Controller} action or function should trigger
403 * events on the entity or overlay currently intersected.403 * 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}.
405 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.405 * @property {number} [pickID] - Returned from {@link Pointers.getPointerProperties}. The ID of the pick created alongside this pointer.
406 * @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.406 * @see {@link Picks.ParabolaPickProperties} for additional properties from the underlying parabola pick.
407 */407 */